Skip to content
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.

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

Official release and versions on PyPI? #1

Open
vandalt opened this issue Aug 3, 2022 · 2 comments
Open

Official release and versions on PyPI? #1

vandalt opened this issue Aug 3, 2022 · 2 comments

Comments

@vandalt
Copy link

vandalt commented Aug 3, 2022

Hi @fmartinache,

I was discussing with @kammerje about making the JWST kernel phase pipeline separate from his xara fork and use the main xara instead as a depency. One things that came up in discussion if that if the pipeline depends on xara, using the main branch directly could be a problem if there are breaking changes.

I was wondering if you had plans to tag versions and release an official xara package on PyPI? I would be happy to help with this if needed.

Thanks!

@fmartinache
Copy link
Owner

Hi @vandalt,

thanks for the question. I'd be happy to release an official package on PyPI... this is something that I've never done. Where would you recommend me to look online to learn how to this the right way?

@vandalt
Copy link
Author

vandalt commented Aug 4, 2022

I like this guide: https://packaging-guide.openastronomy.org/en/latest/index.html.

The main section about packaging is this one: https://packaging-guide.openastronomy.org/en/latest/releasing.html. It uses git tags to control versions (instead of manually specifying versions in the setup and init files), but most things (building and releasing with twine) should still apply if you prefer to manually specify versions.

If you go the route of scm (git) versioning, there are a few things to modify in setup.py, pyproject.toml and xara/__init__.py, but once the setup is done I find this approach really nice. A ctrl+f for "scm" in the package layout section should help you find all the bits that need to be modified. I could send a PR with the updated setup files if you want.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants