Dependency Modernization and Metadata Writing Features#24
Open
ballaballaballa wants to merge 11 commits intojo1gi:masterfrom
Open
Dependency Modernization and Metadata Writing Features#24ballaballaballa wants to merge 11 commits intojo1gi:masterfrom
ballaballaballa wants to merge 11 commits intojo1gi:masterfrom
Conversation
jo1gi
reviewed
Dec 27, 2025
Owner
jo1gi
left a comment
jo1gi
left a comment
There was a problem hiding this comment.
Thank you for your contribution and sorry for answering this late.
| @@ -0,0 +1,303 @@ | |||
| """ | |||
Owner
There was a problem hiding this comment.
I think it makes sense for this file to be in the output directory
grawlix/epub_metadata_writers.py
Outdated
Owner
There was a problem hiding this comment.
This file should be in the output directory
grawlix/epub_metadata.py
Outdated
Owner
There was a problem hiding this comment.
I think it makes more sense for the metadata to be in the book.Metadata format and then be converted to this format when writing to the epub. That way, all sources are automatically supported.
| @@ -0,0 +1,68 @@ | |||
| """ | |||
Owner
There was a problem hiding this comment.
This file should be in the output directory
| action="store_true", | ||
| ) | ||
| # Metadata | ||
| parser.add_argument( |
Owner
There was a problem hiding this comment.
Is there a reason to not always add metadata to the epub?
Author
There was a problem hiding this comment.
Personally, I always want it, but I don't know with other people. I guess some want to keep it as retail. I took the safe option and followed what was implemented for audiobook-dl.
Author
No worries! I agree with your comments. I'm away for a couple of weeks, so can take care of it when I'm back if you don't want to fix it before that. |
ballaballaballa
force-pushed
the
master
branch
from
374eca4 to
210522b
Compare
…now. Can be triggered with parameter or set in config. Added option to add output path to config file.
- Fix Nextory SSL certificate error (api.nextory.se -> api.nextory.com) - Add missing X-OS-INFO header for Nextory API compatibility - Implement full metadata writing for Nextory (title, authors, translators, series, publisher, ISBN, language, description, release date) - Remove debug JSON output from Nextory authentication - Fix exit() call in epub.py that prevented metadata writing for EpubInParts Refactoring improvements: - Reorganize functions in nextory.py and storytel.py by execution flow - Add section comments for better code organization (Authentication, Main download, Book path, Series path) - Remove duplicate imports (OnlineFile in nextory.py, datetime in storytel.py) - Remove duplicate header update in storytel.py - Improve pagination logic in storytel.py with clearer variable names - Optimize API calls in nextory.py (eliminate redundant call) - Use list comprehensions for cleaner code Documentation: - Update README with Nextory metadata support - Add supported sources comparison table for metadata fields - Include Nextory configuration example
…aints
- Migrate from blackboxprotobuf to bbpb (new PyPI package name)
- Update pyproject.toml and shell.nix dependencies
- Import name remains 'blackboxprotobuf' (no code changes)
- Migrate from appdirs to platformdirs
- Replace deprecated appdirs with actively maintained platformdirs
- Update grawlix/config.py to use platformdirs.user_config_dir
- Update dependency declarations in pyproject.toml and shell.nix
- Add minimum version constraints for all dependencies
- Set requires-python = ">=3.9" (required by httpx and importlib.resources.files())
- Add Python version classifiers (3.9-3.13)
- Specify minimum versions: beautifulsoup4>=4.9.0, bbpb>=1.0.0,
EbookLib>=0.17, httpx>=0.23.0, importlib-resources>=5.0,
lxml>=4.6.0, platformdirs>=3.0.0, pycryptodome>=3.10.0, rich>=10.0.0
- Make tomli conditional: only required for Python < 3.11
- Update shell.nix with correct SHA256 hash for bbpb 1.4.2
These changes ensure all dependencies meet minimum version requirements
for Python 3.9+ compatibility and replace deprecated packages with
actively maintained alternatives.
- Fix _extract_series_name to handle null series values - Add PDF book support for Nextory (served via epub endpoint) - Convert PDF-in-epub to merged PDF after download - Add pypdf dependency for PDF merging - Add Pdf output format (unused but available) - Update metadata transformer to handle both epub and pdf formats
- Move pdf_converter.py to output/ - Move epub_metadata.py and epub_metadata_writers.py to output/metadata/ - Update imports in __main__.py
- Remove source_data/transformer pattern in favor of direct Metadata population - Extend Metadata with new fields: original_title, translators, category, tags - Rename identifier field to isbn for clarity - Delete epub_metadata_writers.py (transformers no longer needed) - Update epub_metadata.py to accept Metadata object instead of dict - Update Storytel and Nextory sources to populate extended metadata
- Fix f-string quote syntax in ereolen.py for Python < 3.12 - Fix Storytel login signature to match new url parameter - Fix Nextory API field names (identifier vs isbn confusion)
ballaballaballa
force-pushed
the
master
branch
from
210522b to
ed8fe9e
Compare
Author
|
I've made the changes now, so please review again when possible. |
- Add rendition properties to Metadata (layout, spread, orientation) - Extract and preserve rendition properties when merging EPUB parts - Fix viewport meta tags for fixed-layout pages - Use EpubItem instead of EpubHtml to preserve original content Fix EPUB validation errors in merged output: - Skip directory entries, mimetype, and META-INF from manifest - Exclude nav/toc from spine for fixed-layout books Improve CSS merging across parts: - Keep longer version of duplicate selectors (more complete rules) - Return None from _get_css_rule_key for invalid font-faces Add cover detection fallback: - Detect cover from largest image on first page when OPF lacks cover info - Optimize lookup with dict instead of nested loops Clean up redundant imports in epub_metadata.py
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces several improvements including dependency updates, EPUB metadata writing capabilities, and source file refactoring.
Summary
Dependency Modernization:
blackboxprotobuftobbpb(new PyPI package name, import name unchanged)appdirswith actively maintainedplatformdirsrequires-python = ">=3.9"for Python 3.9-3.13 compatibilitytomliconditional (only required for Python < 3.11)New Features:
Refactoring:
Documentation:
Changes by File
pyproject.toml,shell.nix): Updated package names and added version constraintsgrawlix/config.py): Migrated to platformdirs, added output path configurationgrawlix/epub_metadata.py,grawlix/epub_metadata_writers.pygrawlix/__main__.py,grawlix/arguments.py): Added metadata writing optionsgrawlix/sources/storytel.py,grawlix/sources/nextory.py): Refactored and added metadata supportgrawlix/output/__init__.py): Enhanced with metadata writing capabilitiesREADME.md): Updated with new features and correct pathsTesting
All changes maintain backward compatibility while adding new optional features. The migration to
bbpbandplatformdirsuses packages that are drop-in replacements with the same APIs.