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

Deprecate PyPI/CADET #40

Closed
hannahlanzrath opened this issue Dec 4, 2024 · 9 comments
Closed

Deprecate PyPI/CADET #40

hannahlanzrath opened this issue Dec 4, 2024 · 9 comments
Assignees
Milestone

Comments

@hannahlanzrath
Copy link
Collaborator

hannahlanzrath commented Dec 4, 2024

Since CADET (https://pypi.org/project/CADET/) is currently an alias fo CADET-Python, the release needs to be done there separately with the cadet_pypi_release branch to push the correct README.

@hannahlanzrath hannahlanzrath self-assigned this Dec 4, 2024
@schmoelder
Copy link
Contributor

Please consider adding another CI Pipeline to automate this.

@schmoelder
Copy link
Contributor

schmoelder commented Dec 5, 2024

  • Hijacking to remind ourselves that we also need to create a release on conda-forge.

@schmoelder schmoelder added this to the v1.0.3 milestone Dec 12, 2024
@schmoelder
Copy link
Contributor

schmoelder commented Dec 12, 2024

Important Note: After talking to @lieres, we decided to stop publising code in PyPI/cadet. Instead, we should simply add are README containing: "Wer das installiert ist doof" (or similar) and refer to the proper package. This way, we don't "lose" the name in the package index s.t. we can later still use it for meta packages.

@schmoelder schmoelder changed the title Release 1.0.2 for pypi/cadet as well Deprecate PyPI/CADET Dec 12, 2024
@schmoelder schmoelder modified the milestones: v1.0.3, v1.1.0 Dec 12, 2024
@lieres
Copy link
Member

lieres commented Dec 13, 2024

The readme should contain a short explanation (CADET is now used for the organization on GitHub and might be used for a meta package on PyPI) and links to the following pages for further information:

https://github.com/cadet/
https://cadet.github.io/

@schmoelder
Copy link
Contributor

FYI, there is a broken link in the README.

@schmoelder
Copy link
Contributor

Also, if I may nitpick, If I remember correctly, we had consider to raise an error on import which tells the users from where to get the "correct" packages.
Alternatively, it would be great to include this in the meta data s.t. it shows this when running pip show cadet

@hannahlanzrath
Copy link
Collaborator Author

I did what you and Eric stated here

Important Note: After talking to @lieres, we decided to stop publising code in PyPI/cadet. Instead, we should simply add are README containing: "Wer das installiert ist doof" (or similar) and refer to the proper package. This way, we don't "lose" the name in the package index s.t. we can later still use it for meta packages.

The readme should contain a short explanation (CADET is now used for the organization on GitHub and might be used for a meta package on PyPI) and links to the following pages for further information:
https://github.com/cadet/
https://cadet.github.io/

If you feel that is not enough, I can reopen the issue?

@lieres
Copy link
Member

lieres commented Jan 17, 2025

I hope you used a polite alternative for "doof" ;)

@hannahlanzrath
Copy link
Collaborator Author

Also, if I may nitpick, If I remember correctly, we had consider to raise an error on import which tells the users from where to get the "correct" packages. Alternatively, it would be great to include this in the meta data s.t. it shows this when running pip show cadet

Added error on import and changed link in meta data.

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

3 participants