Metadata-Version: 2.1
Name: sparv-pipeline
Version: 4.1.0
Summary: Språkbanken's text analysis tool
Home-page: https://github.com/spraakbanken/sparv-pipeline/
Author: Språkbanken
Author-email: sb-info@svenska.gu.se
License: MIT
Description: # Språkbanken's Sparv Pipeline
        
        The Sparv Pipeline is a text analysis tool run from the command line. The documentation can be found here:
        https://spraakbanken.gu.se/sparv.
        
        Check the [changelog](CHANGELOG.md) to see what's new!
        
        Sparv is developed by [Språkbanken](https://spraakbanken.gu.se/). The source code is available under the [MIT
        license](https://opensource.org/licenses/MIT).
        
        If you have any questions, problems or suggestions please contact <sb-sparv@svenska.gu.se>.
        
        ## Prerequisites
        
        * A Unix-like environment (e.g. Linux, OS X or [Windows Subsystem for
          Linux](https://docs.microsoft.com/en-us/windows/wsl/about)) *Note:* Most of Sparv's features should work in a Windows
          environment as well, but since we don't do any testing on Windows we cannot guarantee anything.
        * [Python 3.6.1](http://python.org/) or newer
        
        ## Installation
        
        Sparv is available on [PyPI](https://pypi.org/project/sparv-pipeline/) and can be installed using
        [pip](https://pip.pypa.io/en/stable/installing) or [pipx](https://pipxproject.github.io/pipx/).
        We recommend using pipx, which will install Sparv in an isolated environment while still making it available to be run
        from anywhere.
        
        ```bash
        python3 -m pip install --user pipx
        python3 -m pipx ensurepath
        pipx install sparv-pipeline
        ```
        
        Now you should be ready to run the Sparv command! Try it by typing `sparv --help`.
        
        The Sparv Pipeline can be used together with several plugins and third-party software. Please check the [Sparv user
        manual](https://spraakbanken.gu.se/sparv/#/user-manual/installation-and-setup) for more details!
        
        ## Running tests
        
        If you want to run the tests you will need to clone this project from
        [GitHub](https://github.com/spraakbanken/sparv-pipeline) since the test data is not distributed with pip.
        
        Before cloning the repository with [git](https://git-scm.com/downloads) make sure you have [Git Large File
        Storage](https://git-lfs.github.com/) installed (`apt install git-lfs`). Some files will not be downloaded correctly
        otherwise.
        
        We recommend that you set up a virtual environment and install the dependencies (including the dev dependencies) listed
        in `setup.py`:
        
        ```bash
        python3 -m venv venv
        source venv/bin/activate
        pip install -e .[dev]
        ```
        
        Now with the virtual environment activated you can run `pytest` from the sparv-pipeline directory. You can run
        particular tests using the provided markers (e.g. `pytest -m swe` to run the Swedish tests only) or via substring
        matching (e.g. `pytest -k "not slow"` to skip the slow tests).
        
Platform: UNKNOWN
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
Provides-Extra: dev
