You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

56 lines
838 B

4 years ago
  1. Installation
  2. -------------
  3. If you are lazy, just perform
  4. ::
  5. $ pip install plac
  6. which will install the module on your system (and possibly argparse
  7. too, if it is not already installed).
  8. If you prefer to install the full distribution from source, including
  9. the documentation, download the tarball_, unpack it and run
  10. ::
  11. $ python setup.py install
  12. in the main directory, possibly as superuser.
  13. .. _tarball: http://pypi.python.org/pypi/plac
  14. Testing
  15. --------
  16. Run
  17. ::
  18. $ python doc/test_plac.py
  19. or
  20. ::
  21. $ nosetests doc
  22. or
  23. ::
  24. $ py.test doc
  25. Some tests will fail if sqlsoup is not installed.
  26. Run a ``pip install sqlsoup`` or just ignore them.
  27. Documentation
  28. --------------
  29. The source code and the documentation are hosted on GitHub.
  30. Here is the full documentation:
  31. https://github.com/micheles/plac/blob/0.9.6/doc/plac.pdf