pypa / pypa/packaging.python.org

How to deprecate a python package?

Open
#883 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: question
Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

I don't know the exact procedure to do "deprecate a python package" and I couldn't find any in the docs.
I am from Manim's team, we previously published under the name of manimce and later changed to manim, because we didn't have access to manim name on PyPi initially (https://github.com/pypa/pypi-support/issues/450).

Now, we have done many releases on manim but left manimce just as is. I am wondering whether I should delete it(can it create problems?) or publish a new version that explicitly fails on install and point to the new package. Or simply leave it as it is now. I would also like to know what other packages do in this case?

I don't know the exact guidelines on how to, and I would like it to be in part of https://packaging.python.org.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing packaging.python.org guidance and the linked PyPI projects and support issue. Compare the documented options for an abandoned or renamed package, then add guidance covering the recommended procedure and risks; the work is done when a maintainer can follow the new documentation without relying on this issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.