Metadata-Version: 2.1
Name: ebookrack
Version: 0.3.0
Summary: library for managing a personal e-book library
Author-email: JA Viljoen <ebookrack@javiljoen.net>
Requires-Python: ~=3.8
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Operating System :: POSIX
Classifier: Topic :: Text Processing :: Markup :: XML
Classifier: Topic :: Utilities
Requires-Dist: attrs ~=22.2.0
Requires-Dist: pytest ~=7.2.1 ; extra == "test"
Project-URL: Repository, https://git.sr.ht/~javiljoen/ebookrack-python
Provides-Extra: test

# EBookRack

Python library for managing a personal e-book library

The `ebookrack.calibre` subpackage allows querying an e-book library managed by Calibre.


## Development

In a Python ≥ 3.8 virtual environment, run:

    pip install -e .[test]

These linters should be installed with the system package manager or `pipx`:

- black
- flake8
- isort (might be packaged as: python3-isort)
- reuse

To run all the tests and linters, run:

    make check


### Cutting a new release

1.  Assign a new version number,
    creating a version bump commit with an annotated tag:

    ```
    contrib/new-release 0.1.2
    ```

2.  Push the new version upstream:

    ```
    git push --follow-tags
    ```

3.  Compile the package into a wheel and upload it to the forge:

    ```
    make upload
    ```

---

Licensed under the [EUPL](LICENSES/EUPL-1.2.txt).

