BUILDING.txt

Builds Pagegen Python package for pip install

1. Increment version in files in setup.py

2. Build python package and add to pypi.python.org
   $ python3 setup.py clean --all
   $ rm -Rf dist
   $ python3 setup.py bdist_wheel # Build package

   Useful commands
   $ pip uninstall dist/pagegen-X.X.X-py3-none-any.whl # uninstall package
   $ pip install dist/pagegen-X.X.X-py3-none-any.whl # install package
   $ virtualenv <directory> && cd <directory> && . bin/activate # Create virual env for testing install/uninstall

3. Test new package
   $ mkdir test
   $ cd test
   $ virtualenv .
   $ . bin/activate
   $ pip install <path to pagegen-X.X.X-py3-none-any.whl>
   <test>

4. Update site documentation with new pagegen version

5. Upload to pypi
   $ twine upload dist/pagegen-X.X.X-py3-none-any.whl 

6. Create github release

Profileing:
$ python3 -m cProfile -o pagegen.prof ../profileling_venv/bin/pagegen -g test
$ snakeviz pagegen.prof