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.42.0.tar.gz (344.0 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.42.0-py3-none-any.whl (369.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: annif-0.42.0.tar.gz
  • Upload date:
  • Size: 344.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

File hashes

Hashes for annif-0.42.0.tar.gz
Algorithm Hash digest
SHA256 b904062cd304b1f53f6f7d21bb1ba7a6a3068c2e9d2afcb26419919e79a2026b
MD5 2b7b2e5dad4836cfe0d110d391486570
BLAKE2b-256 ddbda293050bfdf7013c8e20ec1bdad4fcfe1e9a6c579a00009a0a6697ae9827

See more details on using hashes here.

File details

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

File metadata

  • Download URL: annif-0.42.0-py3-none-any.whl
  • Upload date:
  • Size: 369.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

File hashes

Hashes for annif-0.42.0-py3-none-any.whl
Algorithm Hash digest
SHA256 12b7931d659aa23f2e77f8929cd6419562a6286d434cb13293c7c3973e43c59d
MD5 7e6b26cad88f5f9f8897738528c7c595
BLAKE2b-256 1b595469bfa8630adf823ee2d628ba0176f0366d179598418ad7353c53e4105f

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