Skip to content

pypi wheels and other potential improvements #6

@leocov-dev

Description

@leocov-dev

@smroid The maintainers over at the main tetra3 project don't seem to be particularly active.
how would you feel about bringing this PR adding PyPi wheel publishing over to your branch?
This would need a few minor changes to publish under a different package name but I'd be happy to put in the work.
My personal opinion is that tetra3 is severely diminished by: not being able to configure the path for generate_database() and not being available on PyPi. Its very hard to use it as a library in a typical python workflow without these 2 changes.

As a bolder step I would propose rebuilding this repo as tetra4 since there are significant improvements here. You'd free yourself from API compatibility without impacting the original project in any way. If ESA ever wanted to pull it under their umbrella you could always donate/transfer the repo to them.


Incremental Plan:

  • Migrate project from setup.py to pyproject.toml: PR
    - this makes it much easier for automated processes to work with the project
    - sets up a starting point for additional tooling
  • Setup pytest framework and migrate existing tests
    - the changes being proposed need to be validated (so we can be sure the project is not broken). automated tests will make this easy.
    - initially this will be configured to run locally only
  • Configure continuous integration GithHub actions
    - CI jobs to run on PR's and merges
    - Run tests
    - Run wheel build (without publishing)
    - Run docs build
  • Configure release process and wheel publishing
    - Setup to create a draft GitHub release when pushing a version tag
    - Setup to publish wheels from a GitHub release when marking it as "published"

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions