storborg / python-packaging

Tutorial on how to structure Python packages
http://www.scotttorborg.com/python-packaging/
438 stars 133 forks source link

updated uploading to pypi documentation #28

Open GanadiniAkshay opened 7 years ago

GanadiniAkshay commented 7 years ago

the current instructions are deprecated/not recommended so updated to latest documentation as mentioned in https://packaging.python.org/distributing/#uploading-your-project-to-pypi

benjaoming commented 7 years ago

@storborg I would recommend merging this, but the subsequently to just entirely remove the (not recommended) steps for clarity - they're disabled after the Warehouse backend was enabled anyways.

storborg commented 7 years ago

Firstly, thanks for the contributions @GanadiniAkshay , I appreciate the help.

I've been reluctant to merge this change because I feel it's important that the packaging tutorial be a simple and narrowly-scoped set of instructions, and requiring the usage of a tool outside of the stdlib (twine) to upload packages seems contradictory to this goal.

However, it looks like I have lost that battle, as even the Python docs specify the usage of twine with no sign of turning back. So, once I have a chance to double-check all the invocations (probably in the next week or two) I'll add some instructions similar to this, although likely with only the simplest 'method' suggested instead of multiple options, like @benjaoming suggested.

Finally, there is another thing to consider: since I initially wrote this tutorial, the official documentation for Python packaging has improved dramatically, and I'm not convinced it still makes sense for the tutorial to exist as a separate entity. I'd be curious to hear feedback on this, particularly from people who have gone through the packaging learning experience recently, or who have helped others get up to speed.

GanadiniAkshay commented 7 years ago

@storborg I agree that there is no need for this tutorial to exist as a separate entity. I ended up referring to the official documentation anyways.

benjaoming commented 7 years ago

I'm not convinced it still makes sense for the tutorial to exist as a separate entity

@storborg I thank you for the work - I have used your tutorial before, but it's some years back. I think that even if the official documentation is inferior, then it might be a better idea for everyone if the official tutorial is the one where we put our collaborate efforts.

A good example would be the Django Project where the documentation is polished and contributed to by lots of people, meaning that very few alternative sources have to exist (as I see it).

brainwane commented 6 years ago

I'm someone who went through the packaging learning experience recently, as I got up to speed on Warehouse, and I was able to do so with the official Python Packaging User Guide and did not need to use any other tutorials (such as yours). I'm grateful for your past work but I do agree with you that it probably does not make sense to keep maintaining a separate guide, going forward.

Here's my suggestion:

I hope this is helpful!

theacodes commented 6 years ago

For context I very much want to re-write our distributing packages tutorial. I'm more than happy to work together on that. :)

I'm also happy to just chat in general about consolidating packaging documentation. This area is confusing enough without 100 different guides floating around.

ACPK commented 6 years ago

You can no longer register a package using the instructions in the tutorial.