installation.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .. highlight:: shell
  2. ============
  3. Installation
  4. ============
  5. Stable release
  6. --------------
  7. To install py_thesis_toolbox, run this command in your terminal:
  8. .. code-block:: console
  9. $ pip install py_thesis_toolbox
  10. This is the preferred method to install py_thesis_toolbox, as it will always install the most recent stable release.
  11. If you don't have `pip`_ installed, this `Python installation guide`_ can guide
  12. you through the process.
  13. .. _pip: https://pip.pypa.io
  14. .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
  15. From sources
  16. ------------
  17. The sources for py_thesis_toolbox can be downloaded from the `Github repo`_.
  18. You can either clone the public repository:
  19. .. code-block:: console
  20. $ git clone git://github.com/audreyr/py_thesis_toolbox
  21. Or download the `tarball`_:
  22. .. code-block:: console
  23. $ curl -OJL https://github.com/audreyr/py_thesis_toolbox/tarball/master
  24. Once you have a copy of the source, you can install it with:
  25. .. code-block:: console
  26. $ python setup.py install
  27. .. _Github repo: https://github.com/audreyr/py_thesis_toolbox
  28. .. _tarball: https://github.com/audreyr/py_thesis_toolbox/tarball/master