Metadata-Version: 2.1
Name: ecmblib
Version: 0.0.8
Summary: This is the python-library you can use for your project to build *.ecmb - files without caring about the internals of the file-format.
Author: Clemens K.
Project-URL: Homepage, https://github.com/comic-manga-ebook/ecmblib_python
Project-URL: Issues, https://github.com/comic-manga-ebook/ecmblib_python/issues
Keywords: ecmb,ebook,comic,manga,file-format
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml
Requires-Dist: lxml
Requires-Dist: pillow
Requires-Dist: path

> [!WARNING]
> This project is still under developement, so please don't use it atm

 
### Homepage: [https://github.com/comic-manga-ebook/](https://github.com/comic-manga-ebook/)

### Table of contents
- [About this repository](#about-this-repository)
- [Installation](#installation)
- [Trying out examples](#trying-out-examples)
- [Documentation](#documentation)

## About this repository

This is the python-library you can use for your project to build `*`.ecmb - files without caring about the internals of the file-format.
You can't do anything wrong with this, coz if you do a mistake (e.g. passing a boolean to set_summary()) an ecmbException will be raised. After the creation, the file will be automatically validated. 

Published under [MIT License](https://choosealicense.com/licenses/mit/)

**Copyright:**

Copyright (c) 2023 Clemens K. (https://github.com/metacreature)

**If you like it, I would be happy if you  [donate on checkya](https://checkya.com/1hhp2cpit9eha/payme)**<br /><br />


## Installation
- download and install Python3 (>=3.11) [https://www.python.org/downloads/](https://www.python.org/downloads/)
- open the console and then
    - run `pip install ecmblib`<br /><br />
 
## Trying out examples
- download and install Python3 (>=3.11) [https://www.python.org/downloads/](https://www.python.org/downloads/)
- clone or download this repository
- open the console and then
    - go to the project-folder `cd ecmblib_python/`
    - run `pip install -r requirements.txt`
    - go to the example-folder `cd examples/advanced_book/`
    - run `python advanced_book.py`
      
The examples are working even if you didn't install the library via pip.<br /><br />

## Documentation
[https://comic-manga-ebook.github.io/ecmblib](https://comic-manga-ebook.github.io/ecmblib)<br /><br />
