Skip to content

Commit

Permalink
Update README to reflect PyPI availability. Part of #195
Browse files Browse the repository at this point in the history
  • Loading branch information
osma committed Nov 21, 2018
1 parent c43b259 commit cd13a16
Showing 1 changed file with 34 additions and 9 deletions.
43 changes: 34 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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`,
Expand Down

0 comments on commit cd13a16

Please sign in to comment.