Skip to content

Refresh EbookLib for the 1.0 release #318

@aerkalov

Description

@aerkalov

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions