8000 Refresh EbookLib for the 1.0 release · Issue #318 · aerkalov/ebooklib · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Refresh EbookLib for the 1.0 release #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
aerkalov opened this issue Jul 28, 2024 · 8 comments
Open

Refresh EbookLib for the 1.0 release #318

aerkalov opened this issue Jul 28, 2024 · 8 comments
Labels
enhancement

Comments

@aerkalov
Copy link
Owner

There is a bunch of things we need to do.

Project related:

  • Clean up all the PR requests. Accept the relevant ones and cancel others.
  • Clean up all the Issues. Close the very old ones, the ones which have answers and etc. Leave the relevant ones which might require some action.
  • Introduce verification GitHub workflows when people create PR (black/ruff/isort/black/flake8)

Library related:

  • Reformat entire code using black/ruff and validate it later on each PR (when most of PR are closed)
  • Write different kind of tests for the existing code so we can be sure that we don't fail in further refactoring of the existing code
  • Remove support for Python 2.x. This means removing six dependency and focusing on Python 3.x
  • Introduce typing support (and mypy after that)

Documentation related:

  • Describe what is the philosophy behind this library to help people better understands what is library capable of doing and what is not
  • Write how to create Covers
  • Write how to prepare PR (beware to document things, beware of breaking current functionality or APi and etc)
  • Write more useful examples how to use the library
@jgarte
Copy link
jgarte commented Aug 10, 2024 •
edited
Loading

Hi, does this project currently have a test suite?

If not, would contributing a test suite using Pytest be accepted in a PR?

From a quick glance it looks like not.

@cary-rowen
Copy link

Do we have some automated remediation misses for bad metadata?
<package version="2.0" unique-identifier="PrimaryID" mlns="http://www.idpf.org/2007/opf">
For the above, I don't know why this namespace is wrong, it could be a typo. But this will completely prevent ebooklib from parsing further.

@ashrobertsdragon
Copy link

I would be willing to contribute type annotations

@ddaws ddaws mentioned this issue Sep 13, 2024
Open
@ddaws
Copy link
ddaws commented Sep 13, 2024

Hey @aerkalov are you open to accepting more maintainers? I just put up my first PR into the repo but I'd be up for helping to review and merge MRs, and add some tests and workflows steps to ensure stability

@Jeffxz
Copy link
Jeffxz commented Nov 29, 2024

It would be nice to have better support on fixed layout epub.

  • add prepagination and spread in manifest meta
  • be able to add viewport in each xhtml

@cary-rowen
Copy link

cc @aerkalov Are you still following this? I see there are contributors willing to contribute to this, do you have any ideas?

@aerkalov aerkalov mentioned this issue May 6, 2025
Merged
@aerkalov
Copy link
Owner Author
aerkalov commented May 6, 2025

@jgarte

If not, would contributing a test suite using Pytest be accepted in a PR?

It would be! There was something but never commited to the repository. Working on a pytest based one now, will commit at some point. But yes, in general it is required for the next step of modernizing code and ditching six and Python 2.

@aerkalov
Copy link
Owner Author
aerkalov commented May 6, 2025

@cary-rowen

cc @aerkalov Are you still following this? I see there are contributors willing to contribute to this, do you have any ideas?

Yeah. With a bit of delay I cleaned up things in my life and now ready to polish and finish some things. Will clean up existing things, finish some minor releases, set up some new steps with tickets and organise for people who could help. Looking at all the questions I would say documentation needs a lot of improving, more complex sample files, tests and etc.

@aerkalov aerkalov mentioned this issue May 10, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@Jeffxz @aerkalov @ddaws @cary-rowen @jgarte @ashrobertsdragon
0