esa / tetra3

A fast lost-in-space plate solver for star trackers.
https://tetra3.readthedocs.io/en/latest/
Apache License 2.0
102 stars 24 forks source link

Changes to prepare for package release #18

Closed cgobat closed 12 months ago

cgobat commented 1 year ago

This is a draft PR to track the status of updates in preparation for packaging and release, as discussed in #15.

Current status on this branch (cgobat/tetra3@package_prep) is as follows:

I will update this list as more progress is made.

gustavmpettersson commented 1 year ago

I've made it so the git repo can be used as the tetra3 module directly by adding an __init__.py file (that was the current installation method not to break), and moved the package data and test data to respective subdirectory

gustavmpettersson commented 12 months ago

I think readthedocs.yaml should work, we'll find out when the PR is merged so I can set up a build on that branch. PyPI we can do after the release is up on github.

I think this is ready, can you test on your end?

cgobat commented 12 months ago

Yes, things seem to be working on my end. I just ran a remote pip install git+https://github.com/cgobat/tetra3@package_prep on a completely fresh system and everything installs as expected.

gustavmpettersson commented 12 months ago

I've gotten the docs to build now. I'd just like a new installation section (basically, I want to get rid of all the conda stuff. It was copy pasted from a different package I wrote that has difficult dependencies), then it should be able to go to master.

gustavmpettersson commented 11 months ago

I've pushed to master and no_big_files. Seems to work well, and I've improved the documentation. It appears we have to migrate from setup.py to pyproject.toml to build a PyPI version, so I'll deal with that later