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.38.2.tar.gz (286.4 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.38.2-py3-none-any.whl (304.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: annif-0.38.2.tar.gz
  • Upload date:
  • Size: 286.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.1

File hashes

Hashes for annif-0.38.2.tar.gz
Algorithm Hash digest
SHA256 1fe193ed3cfb8abdaaf36b41d0dc6d15d6ce9590680014050a36b0c10be00ca4
MD5 dae794068c9411f8989c2fd4b16f7494
BLAKE2b-256 a9568e3e1c9242ddb4b1a092dec8b311c37fe5e855885194029c2c13a6ba0fb9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: annif-0.38.2-py3-none-any.whl
  • Upload date:
  • Size: 304.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.1

File hashes

Hashes for annif-0.38.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a8936a7b6a22d321a767580d98f717b15b3e40ecfd1864eb6bd1eab2a7a2ce82
MD5 acb3d22b0621f66d872e6aca2fc3e607
BLAKE2b-256 e18d39abd5c26b070c4d78ec9198107870a74127cbd8249debfac039494d84d1

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