Installation¶
Installing PyNLPIR is simple. PyNLPIR is designed to run on Python 2.7 or 3. Because of the included NLPIR library files, it only runs on Windows, GNU/Linux, or macOS.
Pip¶
Install PyNLPIR using pip:
$ pip install pynlpir
$ pynlpir update
This will download PyNLPIR from
the Python Package Index and install it in your
Python’s site-packages
directory. pynlpir update
will download the latest license from the NLPIR project.
Install from Source¶
If you’d rather install PyNLPIR manually:
- Download the most recent release from PyNLPIR’s PyPi page.
- Unpack the archive file.
- From inside the directory
PyNLPIR-XX
, runpython setup.py install
- Run
pynlpir update
to download the latest license file.
This will install PyNLPIR in your Python’s site-packages
directory.
Install the Development Version¶
PyNLPIR’s code is hosted at GitHub. To install the development version first make sure Git is installed. Then run:
$ git clone git://github.com/tsroten/pynlpir.git
$ pip install -e pynlpir
$ pynlpir update
This will link the PyNLPIR
directory into your site-packages
directory. pynlpir update
will download the latest license from the NLPIR project.
Running the Tests¶
Running the tests is easy. After downloading and unpacking PyNLPIR’s source, run the following code from inside PyNLPIR’s source directory:
$ python setup.py test
If you want to run the tests using different versions of Python, install and run tox:
$ pip install tox
$ tox