Python Packaging

Overview

Create python packages that can be distributed with pip from GitHub (and not PyPi).

Configuration

A setup config file, setup.py, in the repo root directory should contain a single call to setuptools.setup(), like so:

from setuptools import setup

setup(name='my_package',
      version='0.1',
      description='My package description',
      url='http://github.com/dbarchowsky/my-package',
      author='Damien Barchowsky',
      author_email='dbarchowsky@gmail.com',
      license='MIT',
      packages=['my_package'],
      zip_safe=False)

After which the package can be installed locally with

$ pip install .

And once installed the package can be used like this:

>>> import my_package
>>> my_package.some_routine()

Installation from GitHub

Links

• Is is possible to use pip to install a package from a private GitHub repository - StackOverflow

Prerequisites

Create and store a local SSH key. (One each for all computers where development is happening.) See Generating a new SSH key and adding it to the ssh-agent - GitHub Help

Register the key on the GitHub account. See 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:

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

The packages dependencies will be installed along with it as long as they are listed in the package's requirements.txt.

Updating a package

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

$ 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