python-package-guide icon indicating copy to clipboard operation
python-package-guide copied to clipboard

Feature: Add reference guide / cheat sheet to the existing packaging guide docs

Open calekochenour opened this issue 3 months ago • 2 comments

I have completed a couple cycles of the packaging guide locally (tested through the test PyPI step and reviewed the remaining steps). As part of this process, I created a reference guide for myself that contains the necessary steps to complete the full process (through the upload to and install from conda-forge steps), in a condensed format. Wanted to see if this is something that would be useful for the larger community.

My idea is to turn this reference guide into a nicely formatted doc, comparable to the conda cheat sheet, though not in PDF form, but to match the structure of the existing pyOpenSci docs. I have a repo with this information (full repo, reference guide contained in the README). The formatting is VERY rough at this time, but the content is all there.

My thought is that this could be useful for anyone who is new to the pyOpenSci packaging process and/or to Python packaging in general, as well as folks who would return to the document periodically for a quick reference on a specific part of the process.

I am happy to work on the issue myself. I can fork/clone/build-local as necessary and work with anyone from the team to refine the content and structure so that it would add value to the existing docs.

Thank you for your consideration of my suggestion.

calekochenour avatar Mar 18 '24 00:03 calekochenour