Skip to main content

Annif

License Build Status codecov Code Climate Scrutinizer Code Quality codebeat badge BCH compliance LGTM: Python

Annif is an automated subject indexing toolkit. It was originally created as a statistical automated indexing tool that used metadata from the Finna.fi discovery interface as a training corpus.

This repo contains a rewritten production version of Annif based on the prototype. It is a work in progress, but already functional for many common tasks.

Basic install

You will need Python 3.5+ to install Annif.

The recommended way is to install Annif from PyPI 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 in the wiki for more details.

Development install

A development version of Annif can be installed by cloning the GitHub repository. Pipenv is used for managing dependencies for the development version.

Installation and setup

Clone the repository.

Switch into the repository directory. Install pipenv if you don't have it:

pip install pipenv  # or pip3 install pipenv

Install dependencies and download NLTK data:

pipenv install  # use --dev if you want to run tests etc.

Enter the virtual environment:

pipenv shell

You will also need NLTK data files:

python -m nltk.downloader punkt

Start up the application:

annif

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

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, which have their own licenses. See the file headers for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

annif-0.37.2.tar.gz (284.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

annif-0.37.2-py3-none-any.whl (303.2 kB view details)

Uploaded Python 3

File details

Details for the file annif-0.37.2.tar.gz.

File metadata

  • Download URL: annif-0.37.2.tar.gz
  • Upload date:
  • Size: 284.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6

File hashes

Hashes for annif-0.37.2.tar.gz
Algorithm Hash digest
SHA256 f936ed67ecaa88244e59edfc1041d402aaefa6041130712aff39ca0a41d684e4
MD5 cef26323b2973b5bf20e7ef9d35c30be
BLAKE2b-256 9c22876218b40af6fd223511c23040f88db1194a5f3682715c1f5f484b86e02a

See more details on using hashes here.

File details

Details for the file annif-0.37.2-py3-none-any.whl.

File metadata

  • Download URL: annif-0.37.2-py3-none-any.whl
  • Upload date:
  • Size: 303.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6

File hashes

Hashes for annif-0.37.2-py3-none-any.whl
Algorithm Hash digest
SHA256 73711c25b225dfe0c2464cbce7030ba4a73b297ee347b0c377b528094acfdf19
MD5 a084f4181ce9c20e1f22e6316beab86f
BLAKE2b-256 2071b2d6bc5fdf3d0e348cf0fdc9fd91d909016ec371bedf82d1788b90eb48ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page