From cd13a1642143bd4354e033b92f0a0e94814362a6 Mon Sep 17 00:00:00 2001 From: Osma Suominen Date: Wed, 21 Nov 2018 14:05:34 +0200 Subject: [PATCH] Update README to reflect PyPI availability. Part of #195 --- README.md | 43 ++++++++++++++++++++++++++++++++++--------- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b57ebf557..0f17ddc15 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,37 @@ a statistical automated indexing tool that used metadata from the [Finna.fi](https://finna.fi) discovery interface as a training corpus. This repo contains a rewritten production version of Annif based on the -[prototype](https://github.com/osma/annif). It is a work in progress. +[prototype](https://github.com/osma/annif). It is a work in progress, but +already functional for many common tasks. -## Dependencies +# Basic install -Python 3.5+. [Pipenv](https://docs.pipenv.org/) is used for managing -dependencies. +You will need Python 3.5+ to install Annif. + +The recommended way is to install Annif from +[PyPI](https://pypi.org/project/annif/) into a virtual environment. + + python3 -m venv annif-venv + source annif-venv/bin/activate + pip install annif + +You will also need NLTK data files: + + python -m nltk.downloader punkt + +Start up the application: + + annif + +See [Getting Started](https://github.com/NatLibFi/Annif/wiki/Getting-started) +in the wiki for more details. + +# Development install + +A development version of Annif can be installed by cloning the [GitHub +repository](https://github.com/NatLibFi/Annif). +[Pipenv](https://docs.pipenv.org/) is used for managing dependencies for the +development version. ## Installation and setup @@ -33,26 +58,26 @@ Install pipenv if you don't have it: Install dependencies and download NLTK data: pipenv install # use --dev if you want to run tests etc. - python -m nltk.downloader punkt Enter the virtual environment: pipenv shell +You will also need NLTK data files: + + python -m nltk.downloader punkt + Start up the application: annif -See [Getting Started](https://github.com/NatLibFi/Annif/wiki/Getting-started) -in the wiki for more details. - ## Unit tests Run `pipenv shell` to enter the virtual environment and then run `pytest`. To have the test suite watch for changes in code and run automatically, use pytest-watch by running `ptw`. -## License +# License The code in this repository is licensed under Apache License 2.0, except for the dependencies included under `annif/static/css` and `annif/static/js`,