https://github.com/spraakbanken/sparv-pipeline

Språkbanken's text analysis tool
https://github.com/spraakbanken/sparv-pipeline

annotation-tool sparv

Last synced: 7 days ago
JSON representation

Språkbanken's text analysis tool

• Host: GitHub
• URL: https://github.com/spraakbanken/sparv-pipeline
• Owner: spraakbanken
• License: mit
• Created: 2017-09-22T11:54:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T09:20:50.000Z (3 months ago)
• Last Synced: 2024-10-25T06:47:05.193Z (3 months ago)
• Topics: annotation-tool, sparv
• Language: Python
• Homepage: https://spraakbanken.gu.se/sparv
• Size: 5.78 MB
• Stars: 25
• Watchers: 7
• Forks: 6
• Open Issues: 74
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - spraakbanken/sparv-pipeline - Språkbanken's text analysis tool (others)

README

        
# 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 .

## 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.8](https://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.

```

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.

Install the dependencies, including the dev dependencies. We recommend that you first set up a virtual environment:

```

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).