Getting started

Explain here, what you need to do in order to get the module up and running

Let’s refer to the introduction.

System requirements

Use Linux and Mac if you have to, but never Windows.

Required packages

Install the following packages on a debian-based distribution:

sudo apt-get install some-package

Start also the following system service

sudo service some-service start

Developers

Set up your environment (you might have these directories already):

cd
mkdir python3
mkdir python3_packages

Include python3 into your PYTHONPATH (include this one into your .bashrc)

export PYTHONPATH=$HOME/python3

Install this package with:

cd ~/python3_packages
git clone https://[your-personal-git-repository]/your_package_name
cd your_package_name
ln -s $PWD/your_package_name $HOME/python3

Or substitute the last line with

pip3 install --user -e .

The effect is the same - creating a link that allows python to find your package (in the latter case that link is the $HOME/.local/lib/python3.x/site-packages/skeleton.egg-link file)

List of additional required [packages]:

docutils>=0.3

Production

Install the package with:

pip3 install --upgrade git+git://[your-personal-git-repository]/your_package_name@version_tag

Test the package

Once you’ve installed this package (either for development or for production), test the installation with (use either ipython or ipython3)

ipython3
from your_package_name.greeters import FancyHelloWorld
gr=FancyHelloWorld(person="Sampsa",age=40)
print(gr)