blob: 3af722f5a2aa0376b7f70126fe99652be4686161 [file] [log] [blame]
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -05001Installation
2------------
3pyOpenSSL uses distutils. Use setup.py to install it in the usual way:
Jean-Paul Calderone897bc252008-02-18 20:50:23 -05004
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -05005 $ python setup.py install --user
Jean-Paul Calderone897bc252008-02-18 20:50:23 -05006
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -05007Or use pip:
Jean-Paul Calderone897bc252008-02-18 20:50:23 -05008
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -05009 $ pip install --user .
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050010
11You can, of course, do
12
Jean-Paul Calderonebaba5692009-07-21 12:08:47 -040013 $ python setup.py --help
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050014
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -050015or
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050016
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -050017 $ pip install --help
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050018
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -050019to find out more about how to use these tools.
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050020
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -050021Documentation
22-------------
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050023
Jean-Paul Calderone92bc1cb2014-01-01 09:22:06 -050024The documentation is written in reStructuredText and build using Sphinx.
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050025
26To build the text, html, postscript or dvi forms of the documentation, this is
27what you do:
28
29 cd doc
30 # To make the text-only documentation:
31 make text
32 # To make the dvi form:
33 make dvi