Skip to main content

Annif

DOI 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.40.0.tar.gz (340.1 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.40.0-py3-none-any.whl (362.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: annif-0.40.0.tar.gz
  • Upload date:
  • Size: 340.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for annif-0.40.0.tar.gz
Algorithm Hash digest
SHA256 8dfd1cfc991f3e0df99efe46e025c84df797e1686dfa9b15ac66e16b82eb3ab7
MD5 6bcfec4d0dda2a66bcc610522cfd49ca
BLAKE2b-256 af505ac30381e4b424165340b52a58e3354aa82fff597c9eaa5e4d7fd5935cfd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: annif-0.40.0-py3-none-any.whl
  • Upload date:
  • Size: 362.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for annif-0.40.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e03d0e84c214123d48e8577b8766dfbc67fa1613cfb3e511e4ddbfb0f708e433
MD5 1848534ec8ab3e836aa990a80574ae6e
BLAKE2b-256 62b991107d17f8bcda7f2766cc303a3e93b96b6ae013f47144eb01e156b293bf

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