Metadata-Version: 2.1
Name: ebook-utils
Version: 0.1.2
Summary: Simple ebook utility program
Home-page: https://gitlab.com/mikelplhts/ebook-utils
Author: Michele Lapolla
Author-email: Michele Lapolla <mikee.lapo@gmail.com>
Project-URL: Homepage, https://gitlab.com/mikelplhts/ebook-utils
Project-URL: Bug Tracker, https://gitlab.com/mikelplhts/ebook-utils/issues
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ebooklib (>=0.17.1)
Requires-Dist: beautifulsoup4 (>=4.11.1)

# ebook-utils

A simple ebook utility program made in Python.

```
usage: ebook-utils [-h] [-v] [-i INPUT] [-w | -W | -t | -m METADATA] [-f FILTER] [--metadata-list] [-o OUTPUT]
```

## Installation

To install and use the package, you can use `pip`. First clone the package into your system and then install it

```sh
cd ebook-utils/
pip install .
```

Then you can use `ebook-utils` in your terminal.

## Contributing

If you want to contribute, fork the repository and then clone it into your system. After that, create a virtual
environment and activate it

```sh
cd ebook-utils/
python -m venv venv
source env/bin/activate
```

Install all the package requirements by running

```sh
make init
```

Finally, you install the package with

```sh
pip install -e .
```

Then make your edits, commit, and create a merge request!

## Example

```sh
ebook-utils -wf .myclass -i myebook.epub
```

## Authors

Michele Lapolla

## License

This project is licensed under the GNU GPLv3 License — see `LICENSE` for details.
