Example Python Package

An example python package built from watching this talk.

Edit the info in setup.py for the metadata of the package. E.g. the package name, description, version etc.

Installation

You can install using this repository as a URL you pass to pip with (this is assuming you have set up an SSH key with GitHub):

python3 -m pip install \
  git+ssh://git@github.com:22/programster/example-python-pakage.git

If you publish to PyPi, then you would be able to install with:

python3 -m pip install helloworld

Usage

from helloworld import sayHello

# Generate "Hello world!"
sayHello()

# Generate "Hello, Bob!"
sayHello("Bob")

Development

Build the package with:

python3 setup.py bdist_wheel

After building, install the package by linking to this file with deve dependencies:

pip install -e .[dev]