<img src="https://annif.org/static/img/annif-RGB.svg" width="150">
[](https://zenodo.org/badge/latestdoi/100936800)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/NatLibFi/Annif/actions/workflows/cicd.yml)
[](https://codecov.io/gh/NatLibFi/Annif)
[](https://codeclimate.com/github/NatLibFi/Annif)
[](https://scrutinizer-ci.com/g/NatLibFi/Annif/?branch=main)
[](https://codebeat.co/projects/github-com-natlibfi-annif-main)
[](https://github.com/NatLibFi/Annif/actions/workflows/codeql.yml)
[](https://sonarcloud.io/dashboard?id=NatLibFi_Annif)
[](https://annif.readthedocs.io/en/latest/index.html)
[](https://github.com/psf/black)
Annif is an automated subject indexing toolkit. It was originally created as
a statistical automated indexing tool that used metadata from the
[Finna.fi](https://finna.fi) discovery interface as a training corpus.
This repo contains a rewritten production version of Annif based on the
[prototype](https://github.com/osma/annif). It is a work in progress, but
already functional for many common tasks.
[Finto AI](https://ai.finto.fi/) is a service based on Annif; see the [source code for Finto AI](https://github.com/NatLibFi/FintoAI).
# Basic install
Annif is developed and tested on Linux. If you want to run Annif on Windows or Mac OS, the recommended way is to use Docker (see below) or a Linux virtual machine.
You will need Python 3.8+ to install Annif.
The recommended way is to install Annif from
[PyPI](https://pypi.org/project/annif/) 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](https://github.com/NatLibFi/Annif/wiki/Getting-started)
in the wiki for more details.
## Shell compeletions
Annif supports tab-key completion in bash, zsh and fish shells for commands and options
and project id, vocabulary id and path parameters.
To enable the completion support in your current terminal session use `annif completion`
command with the option according to your shell to produce the completion script and
source it. For example, run
source <(annif completion --bash)
To enable the completion support in all new sessions first add the completion script in
your home directory:
annif completion --bash > ~/.annif-complete.bash
Then make the script to be automatically sourced for new terminal sessions by adding the
following to your `~/.bashrc` file (or in some [alternative startup
file](https://www.gnu.org/software/bash/manual/html_node/Bash-Startup-Files.html)):
source ~/.annif-complete.bash
For details and usage for other shells see
[Click documentation](https://click.palletsprojects.com/en/8.1.x/shell-completion/).
# Docker install
You can use Annif as a pre-built Docker container. Please see the
[wiki documentation](https://github.com/NatLibFi/Annif/wiki/Usage-with-Docker)
for details.
# Development install
A development version of Annif can be installed by cloning the [GitHub
repository](https://github.com/NatLibFi/Annif).
[Poetry](https://python-poetry.org/) is used for managing dependencies and virtual environment for the development version.
See [CONTRIBUTING.md](CONTRIBUTING.md) for information on [unit tests](CONTRIBUTING.md#unit-tests), [code style](CONTRIBUTING.md#code-style), [development flow](CONTRIBUTING.md#development-flow) etc. details that are useful when participating in Annif development.
## Installation and setup
Clone the repository.
Switch into the repository directory.
Install [pipx](https://pypa.github.io/pipx/) and Poetry if you don't have them. First pipx:
python3 -m pip install --user pipx
python3 -m pipx ensurepath
Open a new shell, and then install Poetry:
pipx install poetry
Poetry can be installed also without pipx: check the [Poetry documentation](https://python-poetry.org/docs/master/#installation).
Create a virtual environment and install dependencies:
poetry install
By default development dependencies are included. Use option `-E` to install dependencies for selected optional features (`-E "extra1 extra2"` for multiple extras), or install all of them with `--all-extras`. By default the virtual environment directory is not under the project directory, but there is a [setting for selecting this](https://python-poetry.org/docs/configuration/#virtualenvsin-project).
Enter the virtual environment:
poetry shell
You will also need NLTK data files:
python -m nltk.downloader punkt
Start up the application:
annif
# Getting help
Many resources are available:
* [Usage documentation in the wiki](https://github.com/NatLibFi/Annif/wiki)
* [Annif tutorial](https://github.com/NatLibFi/Annif-tutorial) for learning to use Annif
* [annif-users](https://groups.google.com/forum/#!forum/annif-users) discussion forum
* [Internal API documentation](https://annif.readthedocs.io) on ReadTheDocs
* [annif.org](https://annif.org) project web site
# Publications / How to cite
Two articles about Annif have been published in peer-reviewed Open Access
journals. The software itself is also archived on Zenodo and
has a [citable DOI](https://doi.org/10.5281/zenodo.5654173).
## Citing the software itself
See "Cite this repository" in the details of the repository.
## Annif articles
<ul>
<li>
Suominen, O.; Inkinen, J.; Lehtinen, M., 2022.
Annif and Finto AI: Developing and Implementing Automated Subject Indexing.
JLIS.It, 13(1), pp. 265–282. URL:
https://www.jlis.it/index.php/jlis/article/view/437
<details>
<summary>See BibTex</summary>
@article{suominen2022annif,
title={Annif and Finto AI: Developing and Implementing Automated Subject Indexing},
author={Suominen, Osma and Inkinen, Juho and Lehtinen, Mona},
journal={JLIS.it},
volume={13},
number={1},
pages={265--282},
year={2022},
doi = {10.4403/jlis.it-12740},
url={https://www.jlis.it/index.php/jlis/article/view/437},
}
</details>
</li>
<li>
Suominen, O.; Koskenniemi, I, 2022.
Annif Analyzer Shootout: Comparing text lemmatization methods for automated subject indexing.
Code4Lib Journal, (54). URL:
https://journal.code4lib.org/articles/16719
<details>
<summary>See BibTex</summary>
@article{suominen2022analyzer,
title={Annif Analyzer Shootout: Comparing text lemmatization methods for automated subject indexing},
author={Suominen, Osma and Koskenniemi, Ilkka},
journal={Code4Lib J.},
number={54},
year={2022},
url={https://journal.code4lib.org/articles/16719},
}
</details>
</li>
<li>
Suominen, O., 2019. Annif: DIY automated subject indexing using multiple
algorithms. LIBER Quarterly, 29(1), pp.1–25. DOI:
https://doi.org/10.18352/lq.10285
<details>
<summary>See BibTex</summary>
@article{suominen2019annif,
title={Annif: DIY automated subject indexing using multiple algorithms},
author={Suominen, Osma},
journal={{LIBER} Quarterly},
volume={29},
number={1},
pages={1--25},
year={2019},
doi = {10.18352/lq.10285},
url = {https://doi.org/10.18352/lq.10285}
}
</details>
</li>
</ul>
# 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.
Please note that the [YAKE](https://github.com/LIAAD/yake) library is licended
under [GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt), while Annif is
licensed under the Apache License 2.0. The licenses are compatible, but
depending on legal interpretation, the terms of the GPLv3 (for example the
requirement to publish corresponding source code when publishing an executable
application) may be considered to apply to the whole of Annif+Yake if you
decide to install the optional Yake dependency.
Raw data
{
"_id": null,
"home_page": "https://annif.org",
"name": "annif",
"maintainer": "Osma Suominen",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "osma.suominen@helsinki.fi",
"keywords": "machine-learning,text-classification,rest-api,code4lib,subject-indexing",
"author": "National Library of Finland",
"author_email": "finto-posti@helsinki.fi",
"download_url": "https://files.pythonhosted.org/packages/d1/0b/798a2d9ec46906e45360c57c3803d479fbfc257a0dc504ffeab9364343e4/annif-1.0.2.tar.gz",
"platform": null,
"description": "<img src=\"https://annif.org/static/img/annif-RGB.svg\" width=\"150\">\n\n[](https://zenodo.org/badge/latestdoi/100936800)\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://github.com/NatLibFi/Annif/actions/workflows/cicd.yml)\n[](https://codecov.io/gh/NatLibFi/Annif)\n[](https://codeclimate.com/github/NatLibFi/Annif)\n[](https://scrutinizer-ci.com/g/NatLibFi/Annif/?branch=main)\n[](https://codebeat.co/projects/github-com-natlibfi-annif-main)\n[](https://github.com/NatLibFi/Annif/actions/workflows/codeql.yml)\n[](https://sonarcloud.io/dashboard?id=NatLibFi_Annif)\n[](https://annif.readthedocs.io/en/latest/index.html)\n[](https://github.com/psf/black)\n\nAnnif is an automated subject indexing toolkit. It was originally created as\na statistical automated indexing tool that used metadata from the\n[Finna.fi](https://finna.fi) discovery interface as a training corpus.\n\nThis repo contains a rewritten production version of Annif based on the\n[prototype](https://github.com/osma/annif). It is a work in progress, but\nalready functional for many common tasks.\n\n[Finto AI](https://ai.finto.fi/) is a service based on Annif; see the [source code for Finto AI](https://github.com/NatLibFi/FintoAI).\n\n# Basic install\n\nAnnif is developed and tested on Linux. If you want to run Annif on Windows or Mac OS, the recommended way is to use Docker (see below) or a Linux virtual machine.\n\nYou will need Python 3.8+ to install Annif.\n\nThe recommended way is to install Annif from\n[PyPI](https://pypi.org/project/annif/) into a virtual environment.\n\n python3 -m venv annif-venv\n source annif-venv/bin/activate\n pip install annif\n\nYou will also need NLTK data files:\n\n python -m nltk.downloader punkt\n\nStart up the application:\n\n annif\n\nSee [Getting Started](https://github.com/NatLibFi/Annif/wiki/Getting-started)\nin the wiki for more details.\n\n## Shell compeletions\nAnnif supports tab-key completion in bash, zsh and fish shells for commands and options\nand project id, vocabulary id and path parameters.\n\nTo enable the completion support in your current terminal session use `annif completion`\ncommand with the option according to your shell to produce the completion script and\nsource it. For example, run\n\n source <(annif completion --bash)\n\nTo enable the completion support in all new sessions first add the completion script in\nyour home directory:\n\n annif completion --bash > ~/.annif-complete.bash\n\nThen make the script to be automatically sourced for new terminal sessions by adding the\nfollowing to your `~/.bashrc` file (or in some [alternative startup\nfile](https://www.gnu.org/software/bash/manual/html_node/Bash-Startup-Files.html)):\n\n source ~/.annif-complete.bash\n\nFor details and usage for other shells see\n[Click documentation](https://click.palletsprojects.com/en/8.1.x/shell-completion/).\n# Docker install\n\nYou can use Annif as a pre-built Docker container. Please see the\n[wiki documentation](https://github.com/NatLibFi/Annif/wiki/Usage-with-Docker)\nfor details.\n\n# Development install\n\nA development version of Annif can be installed by cloning the [GitHub\nrepository](https://github.com/NatLibFi/Annif).\n[Poetry](https://python-poetry.org/) is used for managing dependencies and virtual environment for the development version.\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for information on [unit tests](CONTRIBUTING.md#unit-tests), [code style](CONTRIBUTING.md#code-style), [development flow](CONTRIBUTING.md#development-flow) etc. details that are useful when participating in Annif development.\n\n## Installation and setup\n\nClone the repository.\n\nSwitch into the repository directory.\n\nInstall [pipx](https://pypa.github.io/pipx/) and Poetry if you don't have them. First pipx:\n\n python3 -m pip install --user pipx\n python3 -m pipx ensurepath\n\nOpen a new shell, and then install Poetry:\n\n pipx install poetry\n\nPoetry can be installed also without pipx: check the [Poetry documentation](https://python-poetry.org/docs/master/#installation).\n\nCreate a virtual environment and install dependencies:\n\n poetry install\n\nBy default development dependencies are included. Use option `-E` to install dependencies for selected optional features (`-E \"extra1 extra2\"` for multiple extras), or install all of them with `--all-extras`. By default the virtual environment directory is not under the project directory, but there is a [setting for selecting this](https://python-poetry.org/docs/configuration/#virtualenvsin-project).\n\nEnter the virtual environment:\n\n poetry shell\n\nYou will also need NLTK data files:\n\n python -m nltk.downloader punkt\n\nStart up the application:\n\n annif\n\n# Getting help\n\nMany resources are available:\n\n * [Usage documentation in the wiki](https://github.com/NatLibFi/Annif/wiki)\n * [Annif tutorial](https://github.com/NatLibFi/Annif-tutorial) for learning to use Annif\n * [annif-users](https://groups.google.com/forum/#!forum/annif-users) discussion forum\n * [Internal API documentation](https://annif.readthedocs.io) on ReadTheDocs\n * [annif.org](https://annif.org) project web site\n\n# Publications / How to cite\n\nTwo articles about Annif have been published in peer-reviewed Open Access\njournals. The software itself is also archived on Zenodo and\nhas a [citable DOI](https://doi.org/10.5281/zenodo.5654173).\n\n## Citing the software itself\n\nSee \"Cite this repository\" in the details of the repository.\n\n## Annif articles\n<ul>\n<li>\nSuominen, O.; Inkinen, J.; Lehtinen, M., 2022.\nAnnif and Finto AI: Developing and Implementing Automated Subject Indexing.\nJLIS.It, 13(1), pp. 265\u2013282. URL:\nhttps://www.jlis.it/index.php/jlis/article/view/437\n<details>\n<summary>See BibTex</summary>\n\n @article{suominen2022annif,\n title={Annif and Finto AI: Developing and Implementing Automated Subject Indexing},\n author={Suominen, Osma and Inkinen, Juho and Lehtinen, Mona},\n journal={JLIS.it},\n volume={13},\n number={1},\n pages={265--282},\n year={2022},\n doi = {10.4403/jlis.it-12740},\n url={https://www.jlis.it/index.php/jlis/article/view/437},\n }\n</details>\n</li>\n<li>\nSuominen, O.; Koskenniemi, I, 2022.\nAnnif Analyzer Shootout: Comparing text lemmatization methods for automated subject indexing.\nCode4Lib Journal, (54). URL:\nhttps://journal.code4lib.org/articles/16719\n<details>\n<summary>See BibTex</summary>\n\n @article{suominen2022analyzer,\n title={Annif Analyzer Shootout: Comparing text lemmatization methods for automated subject indexing},\n author={Suominen, Osma and Koskenniemi, Ilkka},\n journal={Code4Lib J.},\n number={54},\n year={2022},\n url={https://journal.code4lib.org/articles/16719},\n }\n</details>\n</li>\n<li>\nSuominen, O., 2019. Annif: DIY automated subject indexing using multiple\nalgorithms. LIBER Quarterly, 29(1), pp.1\u201325. DOI:\nhttps://doi.org/10.18352/lq.10285\n<details>\n<summary>See BibTex</summary>\n\n @article{suominen2019annif,\n title={Annif: DIY automated subject indexing using multiple algorithms},\n author={Suominen, Osma},\n journal={{LIBER} Quarterly},\n volume={29},\n number={1},\n pages={1--25},\n year={2019},\n doi = {10.18352/lq.10285},\n url = {https://doi.org/10.18352/lq.10285}\n }\n</details>\n</li>\n</ul>\n\n# License\n\nThe code in this repository is licensed under Apache License 2.0, except for the\ndependencies included under `annif/static/css` and `annif/static/js`,\nwhich have their own licenses, see the file headers for details.\nPlease note that the [YAKE](https://github.com/LIAAD/yake) library is licended\nunder [GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt), while Annif is\nlicensed under the Apache License 2.0. The licenses are compatible, but\ndepending on legal interpretation, the terms of the GPLv3 (for example the\nrequirement to publish corresponding source code when publishing an executable\napplication) may be considered to apply to the whole of Annif+Yake if you\ndecide to install the optional Yake dependency.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Automated subject indexing and classification tool",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://github.com/NatLibFi/Annif/wiki",
"Homepage": "https://annif.org",
"Repository": "https://github.com/NatLibFi/Annif"
},
"split_keywords": [
"machine-learning",
"text-classification",
"rest-api",
"code4lib",
"subject-indexing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6e5642a9cbd1a7f3e38cc68addb7bd349509e4ea8c76a5c1a5883aec5eccff67",
"md5": "bbccda5f9002c07cfed903eadd8a30ed",
"sha256": "ce6b5fc75e8f45116273701405c31d0f79e2da0a80a6ad71f2423d4ed826218e"
},
"downloads": -1,
"filename": "annif-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bbccda5f9002c07cfed903eadd8a30ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 497679,
"upload_time": "2024-02-02T09:34:50",
"upload_time_iso_8601": "2024-02-02T09:34:50.663961Z",
"url": "https://files.pythonhosted.org/packages/6e/56/42a9cbd1a7f3e38cc68addb7bd349509e4ea8c76a5c1a5883aec5eccff67/annif-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d10b798a2d9ec46906e45360c57c3803d479fbfc257a0dc504ffeab9364343e4",
"md5": "8681fef58156642e43b38cb871210a26",
"sha256": "74413fa4193fcd5affbdcae7763e47a410e88b8ebaf5429e2055c91f3c973db3"
},
"downloads": -1,
"filename": "annif-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "8681fef58156642e43b38cb871210a26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 467603,
"upload_time": "2024-02-02T09:34:52",
"upload_time_iso_8601": "2024-02-02T09:34:52.929411Z",
"url": "https://files.pythonhosted.org/packages/d1/0b/798a2d9ec46906e45360c57c3803d479fbfc257a0dc504ffeab9364343e4/annif-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 09:34:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NatLibFi",
"github_project": "Annif",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "annif"
}
JSON
