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.41.0.tar.gz (342.7 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.41.0-py3-none-any.whl (367.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: annif-0.41.0.tar.gz
  • Upload date:
  • Size: 342.7 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.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.7

File hashes

Hashes for annif-0.41.0.tar.gz
Algorithm Hash digest
SHA256 90b7a12f9db1a7792f9785ae8ca13b7c79cc82afd20398e1bcfae413ab568a1c
MD5 5d7754ed686a60b80fe4deec0d545423
BLAKE2b-256 d1e281f0382ba58152317370f81851728fb242ecf542ba6503636ad3853db8d0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: annif-0.41.0-py3-none-any.whl
  • Upload date:
  • Size: 367.3 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.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.7

File hashes

Hashes for annif-0.41.0-py3-none-any.whl
Algorithm Hash digest
SHA256 60a851e3e74e1a951f9949d2c5d8d1ec80b4f9472c25ca280e80a1d7e53c6c3f
MD5 74fb609363d8c73f4c13ebdaac821a8c
BLAKE2b-256 6710964909c970249213d11515b9a07f2339663a910543506dfc6c29e3f21a3e

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