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.

Dependencies

Python 3.5+. Pipenv is used for managing dependencies.

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.
python -m nltk.downloader punkt

Enter the virtual environment:

pipenv shell

Start up the application:

annif

See Getting Started in the wiki for more details.

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.36.4.tar.gz (33.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.36.4-py3-none-any.whl (47.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: annif-0.36.4.tar.gz
  • Upload date:
  • Size: 33.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.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2

File hashes

Hashes for annif-0.36.4.tar.gz
Algorithm Hash digest
SHA256 d1a5f67639c905050a05f2187cbff0379a07807b7de34c6eccffe8c897ee9727
MD5 14054dc5d87974f3844bf118d3b7a1a0
BLAKE2b-256 2e88ea2bfe53486b143dbdad1f609444aa33f93f311fd524299a6d3a36149654

See more details on using hashes here.

File details

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

File metadata

  • Download URL: annif-0.36.4-py3-none-any.whl
  • Upload date:
  • Size: 47.0 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.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2

File hashes

Hashes for annif-0.36.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f6c75f06455c472cb20b9aee3b2831f3d704bee5e498ae7afae4a54428163c6b
MD5 968d30f7379f1294cec7ed41a4237321
BLAKE2b-256 fd59b9cdf6cc074bad1541d908459ef006a6e33bd1ad683ada8d232cd403c9dd

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