Skip to content

Update PyPI Listing to Increase Visibility of Deprecation/Replacement #664

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

Closed
darkroastcreative opened this issue Jan 27, 2024 · 2 comments
Labels

Comments

@darkroastcreative
Copy link

  1. What is the link to the documentation section that needs improving?

https://pypi.org/project/cx-Oracle/ (PyPI Package Listing)

  1. Describe the confusion

Currently, the PyPI listing for cx_Oracle does not mention that the package was renamed/replaced by python-oracledb. Given the popularity of the package (and the presence of third-party guides on how to use the package that may not reference python-oracledb), it's possible that developers may choose to use cx_Oracle in their projects without gaining an awareness that they should likely be using python-oracledb, or that python-oracledb exists (resulting in refactoring work that could've been avoided and potential security risks).

  1. Suggest changes that would help

Update cx_Oracle PyPI package listing to add messaging to call out that the package was replaced/renamed with a link to python-oracledb. In addition, if cx_Oracle is no longer being maintained (including security updates), make this more apparent (perhaps by using the Development Status :: 7 - Inactive classifier).

@darkroastcreative
Copy link
Author

The content of the "News" section in this version of README.md seems like it would be a good fit for the messaging on the package's PyPI listing, particularly if you could format the text in a way that stands out.

@anthony-tuininga
Copy link
Member

Unfortunately PyPI does not allow for the package listing to be modified without making a new release. This is deliberate and a source of grief to many. Making a new release is not planned at this point so we're kind of stuck with what we have. The documentation and GitHub have been modified to point to the new driver which is the best that can be done at this point.

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

No branches or pull requests

2 participants