Warning this tutorial is a draft, and until this warning is removed pages/posts may move! In other-words. please avoid bookmarking individual posts until this warning is removed. To correct any inaccuracies Pull Requests are very welcomed.
This tutorial is intended for those that wish to publish a library or libraries to Python Pip repository. Before following this guide, readers should have Python installed, as well as some knowledge of reading and writing Python code. The official getting started documentation from Python, is an excellent resource if statring out or if refreshing one’s knowledge feels needed.
Python Language source may be downloaded from python.org
for most Operating Systems, alternatively most Linux distributions have python available via package manager…
## Arch inspired distributions
sudo packman -S python3 python3-pip
## Debian derived distributions
sudo apt-get install python3 python3-pip
Most, if not all, of the command-line examples will be for a Bash (Born Again SHell) environment, eg…
-
cd ~/somewhere
–c
hanged
irectory tosomewhere
under the current user’s home (~
) directory -
mkdir ~/somewhere/another-thing
–m
ak
edir
ectory under the current user’s home (~
) directory with the path ofsomewhere/another-thing
-
touch ~/somewhere/another-thing/file.ext
– update last modified time, or create an empty file, namedfile.ext
under the current user’s home (~
) directory with a directory path ofsomewhere/another-thing
-
Long command-line examples are split using a backslash (
\
) to escape new-lines, and lines that follow are indented by two spaces (
executable-name --param-one "first modifier"\
--param-two "second modifier"\
--flag-one\
--flag-two
As much as possible, commands specific to Bash will be limited to above examples. Commands for Git and Python code examples should otherwise be environment agnostic so long as your device has applications and dependencies installed.
Steps
Register PyPi Accounts
Links to testing and publishing repositories, and example `.pypirc` config. fileSetup Environment
List of dependencies installed via Pip and links to relevant documentationInitialize Project
Instructions for setting up file and directory structure for new libraryMake ReadMe
A project's ReadMe file is often the first documents users will reviewPackage Setup
Example `setup.py` script and related configuration filesWrite Library
Example `First_Library` classWrite Command Line Interface
Command Line Interface that shows how to utilize and test libraryTag, Release, and Publish
Steps that will repeat for publishing and updating the library
subscribe via RSS