Metadata-Version: 2.1
Name: annif
Version: 0.46.0
Summary: Automated subject indexing and classification tool
Home-page: https://github.com/NatLibFi/Annif
Author: Osma Suominen
Author-email: osma.suominen@helsinki.fi
License: UNKNOWN
Description: # Annif
        
        [![DOI](https://zenodo.org/badge/100936800.svg)](https://zenodo.org/badge/latestdoi/100936800)
        [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
        [![Build Status](https://travis-ci.org/NatLibFi/Annif.svg?branch=master)](https://travis-ci.org/NatLibFi/Annif?branch=master)
        [![codecov](https://codecov.io/gh/NatLibFi/Annif/branch/master/graph/badge.svg)](https://codecov.io/gh/NatLibFi/Annif)
        [![Code Climate](https://codeclimate.com/github/NatLibFi/Annif/badges/gpa.svg)](https://codeclimate.com/github/NatLibFi/Annif)
        [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/NatLibFi/Annif/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/NatLibFi/Annif/?branch=master)
        [![codebeat badge](https://codebeat.co/badges/e496f151-93db-4f0e-9e30-bc3339e58ca4)](https://codebeat.co/projects/github-com-natlibfi-annif-master)
        [![BCH compliance](https://bettercodehub.com/edge/badge/NatLibFi/Annif?branch=master)](https://bettercodehub.com/)
        [![LGTM: Python](https://img.shields.io/lgtm/grade/python/g/NatLibFi/Annif.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/NatLibFi/Annif/context:python)
        [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=NatLibFi_Annif&metric=alert_status)](https://sonarcloud.io/dashboard?id=NatLibFi_Annif)
        
        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.
        
        # Basic install
        
        You will need Python 3.5+ 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.
        
        # 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).
        [Pipenv](https://docs.pipenv.org/) 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`.
        
        # 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://readthedocs.org/projects/annif/) on ReadTheDocs
         * [annif.org](http://annif.org) project web site
        
        # Publications / How to cite
        
        An article about Annif has been published in the peer-reviewed Open Access
        journal LIBER Quarterly. The software itself is also archived on Zenodo and
        has a citable DOI.
        
        ## Annif article
        
        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](https://doi.org/10.18352/lq.10285)
        
            @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}
            }
        
        ## Citing the software itself
        
        Zenodo DOI:
        [https://doi.org/10.5281/zenodo.2578948](https://doi.org/10.5281/zenodo.2578948)
        
            @misc{https://doi.org/10.5281/zenodo.2578948,
              doi = {10.5281/ZENODO.2578948},
              url = {https://doi.org/10.5281/zenodo.2578948},
              title = {NatLibFi/Annif},
              year = {2019}
            }
        
        # 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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: nn
Provides-Extra: vw
Provides-Extra: fasttext
Provides-Extra: omikuji
Provides-Extra: voikko
