Editing Python Packaging (section)

== Installation from GitHub ==

<p class="alert alert-warning">Legacy information below. See [[Installing Private Python Packages Hosted on GitHub]]</p>

=== Prerequisites ===

Create and store a local SSH key. (One each for all computers where development is happening.) See [https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/ Generating a new SSH key and adding it to the ssh-agent] (GitHub Help)

Register the key on the GitHub account. See [https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/ Adding a new SSH key to your GitHub account] (GitHub Help)

One key pair will suffice for all ssh requests, i.e. for a computer with the key installed, the key can be used for all repositories in the GitHub account. 

=== Installing a package ===

To install a package from a private GitHub repository: <ref>[https://stackoverflow.com/questions/4830856/is-it-possible-to-use-pip-to-install-a-package-from-a-private-github-repository Is is possible to use pip to install a package from a private GitHub repository] - StackOverflow</ref>

<syntaxhighlight lang="bash">
$ pip install git+ssh://git@github.com/username/my-repo.git
</syntaxhighlight>

The packages dependencies are listed under `install_requires=[]` in the package's `setup.py`.

=== Updating a package ===

After changes have been committed to a repository, they can be retrieved with:

<syntaxhighlight lang="bash">
$ pip install git+ssh://git@github.com/username/my-repo.git --upgrade

(or) 

$ pip install git+ssh://git@github.com/username/my-repo.git -U
</syntaxhighlight>