picnic 0.0.0.3

Creating a Python package

To start a new project, you type

picnic.py new PackageName

To install the package (you will be able to modify the code afterwards) type

python setup.py develop

or equivalently

picnic.py --dev

Now we can start to code: we go in directory PackageName/packagename and in the file packagename.py we write

def say_hello():
    print "Hello world !"

To check that this worked, open a python console (in any folder) and type

>>> import packagename
>>> packagename.say_hello()
 Hello World !

Creating a Sphinx documentation

To initialize the Sphinx documentation you type

picnic.py [new PackageName] --author="Your Name" --sphinx

The documentation source will be in the docs directory and the built (html) doc will be in the folder built_docs/html/. To preview the docs after you have made some changes you can go into the docs repository and type

make html
firefox ../../built_docs/html/index.html

For convenience these two lines are already written in the docs/make_html.sh file, therefore you only need to type

./make_html.sh

Creating a git repository

To create a git repository the classic way, you generally add a .gitignore file to your folder (to specify what kind of files not to include in the repo) and type these lines

git init
git add .
git commit -m "Initial commit"

The --git option does exactly all this: it adds a .gitignore file to the folder and runs all these commands. Be sure to run it in the directory where your setup.py is.

Linking to a repository on Github

To put this git repository on a Github, first create a repo on Github (say no when they ask you whether to include a README file). Github should give you the url of the repo, something like https://github.com/Zulko/MyPackage.git. Then in a console type

git add remote origin https://github.com/Zulko/MyPackage.git

or equivalently

picnic.py --remote=https://github.com/Zulko/MyPackage.git

To commit the changes to the git repo I generally do

git commit -a -m "my description of the commit"

And after this, to push the changes on the online Github repo:

git push origin master

Creating Github-pages

Here we suppose that you have already linked your project to Github with

git add remote origin https://link/to/your/repo.git

or equivalently

picnic.py --remote=https://link/to/your/repo.git

Now all you have to do is

picnic.py --gh-pages

This creates a special git repository for the Github Pages in the directory built_docs/html, which is the output directory of the documentation.

When you are happy with the way your documentation looks you go into folder built_docs/html and type

git commit -a -m "my description of the commit"
git push origin gh-pages

That’s all there is to know !