-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ffca323
commit 1f1433a
Showing
26 changed files
with
545 additions
and
598 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres | ||
| to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [3.1.0] - 2023-06-04 | ||
|
|
||
| ### Added | ||
|
|
||
| - Installation with pip. | ||
| - Support for non-existent location. | ||
| - Support for web loading errors of pages. | ||
|
|
||
| ### Fixed | ||
|
|
||
| - Fixed page support. | ||
|
|
||
| ### Changed | ||
|
|
||
| - New name of some variables. | ||
| - Automatic cleanup of temporary files. | ||
| - New location for temporary files. | ||
| - File path now uses `pathlib`. | ||
|
|
||
| ## [3.0.1] - 2023-02-06 | ||
|
|
||
| ### Added | ||
|
|
||
| - Initial release. | ||
|
|
||
| [3.1.0]: https://github.com/hyugogirubato/pycbzhelper/releases/tag/v3.1.0 | ||
| [3.0.1]: https://github.com/hyugogirubato/pycbzhelper/releases/tag/v3.0.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,64 @@ | ||
| # pycbzhelper | ||
| [](https://www.gnu.org/licenses/gpl-3.0) | ||
| [](https://github.com/hyugogirubato/pycbzhelper/releases) | ||
|  | ||
|
|
||
| Python library to create a cbz file with metadata. | ||
|
|
||
| # Usage | ||
|
|
||
| ### Basic Usage | ||
|
|
||
| ```python | ||
| >>> import os | ||
| >>> from pycbzhelper import Helper | ||
| >>> metadata = { | ||
| >>> "Title": "T1 - Arrête de me chauffer, Nagatoro", | ||
| >>> "Series": "Arrête de me chauffer, Nagatoro", | ||
| >>> "Number": "1", | ||
| >>> "Count": 8, | ||
| >>> "Volume": 1 | ||
| >>> ... | ||
| >>> } | ||
| >>> ... | ||
| >>> helper = Helper(metadata) | ||
| >>> helper.save_cbz( | ||
| ... path=os.path.join("eBooks", "Arrête de me chauffer, Nagatoro"), | ||
| ... file="T1 - Arrête de me chauffer, Nagatoro", | ||
| ... clear=False, | ||
| ... replace=True | ||
| ... ) | ||
| ``` | ||
|
|
||
| # Installation | ||
|
|
||
| To install, you can either clone the repository and run `python setup.py install` | ||
|
|
||
| ## About | ||
| - Graphical metadata editing software [here](https://github.com/comictagger/comictagger) | ||
| - Standard ComicInfo file structure information [here](https://github.com/Kussie/ComicInfoStandard) | ||
| - New version of ComicInfo file structure [here](https://github.com/anansi-project/comicinfo) | ||
| # PyCBZHelper | ||
|
|
||
| [](https://github.com/hyugogirubato/pycbzhelper/blob/master/LICENSE) | ||
| [](https://github.com/hyugogirubato/pycbzhelper/releases) | ||
| [](https://pypi.org/project/pycbzhelper/) | ||
|
|
||
| PyCBZHelper is a Python library for creating CBZ (Comic Book Zip) files with metadata. It provides functionality to | ||
| generate a CBZ file from a list of image pages and associated comic book metadata. | ||
|
|
||
| ## Features | ||
|
|
||
| - Create CBZ files from images. | ||
| - Generate ComicInfo.xml metadata. | ||
| - Support for various metadata fields. | ||
| - Handle page files from local disk or web URLs. | ||
| - Automatic cleanup of temporary files. | ||
|
|
||
| ## Installation | ||
|
|
||
| You can install PyCBZHelper using pip: | ||
|
|
||
| ````shell | ||
| pip install pycbzhelper | ||
| ```` | ||
|
|
||
| ## Usage | ||
|
|
||
| Here's a basic example of how to use PyCBZHelper: | ||
|
|
||
| ````python | ||
| from pycbzhelper import Helper | ||
| from pathlib import Path | ||
|
|
||
| PARENT = Path(__name__).resolve().parent | ||
|
|
||
| if __name__ == "__main__": | ||
| # Define metadata for the comic | ||
| metadata = { | ||
| "Title": "My Comic", | ||
| "Series": "Comic Series", | ||
| "Number": "1", | ||
| "Pages": [ | ||
| {"File": PARENT / "image1.jpg"}, | ||
| {"File": PARENT / "image2.jpg"}, | ||
| ] | ||
| # Add more metadata fields here | ||
| } | ||
|
|
||
| # Define the path to the output CBZ file | ||
| output_path = PARENT / "output.cbz" | ||
|
|
||
| # Create an instance of the Helper class | ||
| helper = Helper(metadata) | ||
|
|
||
| # Create the CBZ file | ||
| helper.create_cbz(output_path) | ||
| ```` | ||
|
|
||
| For more information on how to use PyCBZHelper, please refer to | ||
| the [documentation](https://github.com/hyugogirubato/pycbzhelper/blob/master/docs/schema). | ||
|
|
||
| ### License | ||
|
|
||
| This project is licensed under the [GPL v3 License](https://github.com/hyugogirubato/pycbzhelper/blob/master/LICENSE). |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
104 changes: 52 additions & 52 deletions
104
schema/v1.0/ComicInfo.xsd → docs/schema/v1.0/ComicInfo.xsd
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.