Skip to content

Commit b1c6b75

Browse files
committed
refactor: editing project name to be more inclusive
1 parent fd5eaa5 commit b1c6b75

14 files changed

Lines changed: 14 additions & 14 deletions

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Aztec decoder - changelog
1+
# Aztec took - changelog
22

33
# 0.1.0 (2025-05-03)
4-
- Initial release of the Aztec decoder.
4+
- Initial release of the Aztec tool.
55
- Basic functionality to decode Aztec codes implemented.

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Aztec decoder 🛸
1+
# Aztec tool 🛸
22
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
33

44
*A fast, pure‑Python Aztec Code reader with auto‑orientation and Reed–Solomon correction.*
@@ -16,10 +16,10 @@
1616

1717
This library is compatible with **Python 3.9** and above.
1818

19-
To install the latest version of Aztec decoder, you can use pip. Open your terminal and run the following command (in a virtual environment if you want to keep your system clean):
19+
To install the latest version of Aztec tool, you can use pip. Open your terminal and run the following command (in a virtual environment if you want to keep your system clean):
2020

2121
```bash
22-
pip install --upgrade aztec_decoder
22+
pip install --upgrade aztec_tool
2323
```
2424

2525
If you cloned the repository, you can install it using pip as well, in the root directory of the project:
@@ -40,9 +40,9 @@ The library allows you to decode Aztec barcodes from images. First, you need to
4040
The most common way to use the library is to use the `AztecDecoder` class. You can create an instance of the class and call the `decode` method with the path to the image file as an argument:
4141

4242
```python
43-
>>> from aztec_decoder import decode
43+
>>> from aztec_tool import decode
4444
>>> decode("welcome_lib.jpg")
45-
'Welcome to Aztec decoder lib !'
45+
'Welcome to Aztec tool lib !'
4646
>>>
4747
```
4848

@@ -56,7 +56,7 @@ If you need to access more specific data, you can use the `AztecDecoder` class d
5656
>>> decoder.mode_info
5757
{'layers': 3, 'data_words': 21, 'ecc_bits': [0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1, 0, 0, 0]}
5858
>>> decoder.decode()
59-
'Welcome to Aztec decoder lib !'
59+
'Welcome to Aztec tool lib !'
6060
```
6161

6262
When you're using the `decode` function or the `AztecDecoder` class, you can also pass three optional parameters:
@@ -77,7 +77,7 @@ The full changelog is available in the [CHANGELOG.md](CHANGELOG.md) file.
7777
The plan for the next releases is available in the [TODO.md](TODO.md) file.
7878

7979
## License
80-
The Aztec decoder is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
80+
The Aztec tool is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
8181

8282
## Resources
8383
These resources were very useful to understand the Aztec code and build this library:

TODO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Aztec decoder - TODO
1+
# Aztec tool - TODO
22
- Allow to decode Aztec barcodes from other sources than images
33
- Auto cropping Aztec barcodes from images
44
- Add tests
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# exceptions.py - centralised error hierarchy for the Aztec decoder
2-
"""Hierarchy of exceptions used throughout the Aztec-decoder project.
1+
# exceptions.py - centralised error hierarchy for the Aztec tool
2+
"""Hierarchy of exceptions used throughout the Aztec-tool project.
33
44
All project-specific errors inherit from :class:`AztecDecoderError`. Each
55
sub-class is tailored to a distinct stage of the pipeline so that the caller

0 commit comments

Comments
 (0)