Coder Social home page Coder Social logo

graphannis-python's Introduction

Automated tests

graphANNIS Python Bindings

GraphANNIS is a library for corpus linguistic queries and these are the Python bindings to graphANNIS core library version 2.4.8.

How to use in your own scripts

GraphANNIS is available as Python3-compatible library from the central PyPI repository: https://pypi.org/project/graphannis/ You can install it locally with pip (https://pip.pypa.io/en/stable/).

pip install graphannis

On Ubuntu Linux systems the command might be pip3for Python 3.

You can view the API documentation online.

How to compile/install from source

Install you the python packages locally (use Python3) for your current user (remove the --user to install it system-wide)

python3 setup.py install --user

This will automatically download the the graphANNIS binaries to the graphannis/<platform> folder, where platform is one of the following:

Operating system <platform>
Linux (64 bit) linux-x86-64
MacOS X (64 bit) darwin-x86-64
Windows (64 bit) win32-x86-64

You can change the CORE_VERSION field in the setup.py to use a different released version of graphANNIS.

To compile graphANNIS on your own (e.g. for using a non-released version)

  • Clone the graphANNIS library from https://github.com/korpling/graphANNIS/
  • Follow the graphANNIS compile instructions
  • Copy the resulting shared library file <graphANNIS-repo>/target/release/libgraphannis_capi.so (libgraphannis_capi.dylib under MacOS X and graphannis_capi.dll under Windows) into the graphannis/<platform> folder (but without the _capi suffix).

Release process

  1. Make sure your local working directory is a checkout of the main branch and up-to-date.
  2. Update version information, by
    • changing the VERSION field in the setup.py file
    • specifying the corresponding graphANNIS release tag in the CORE_VERSION field in the setup.py file
    • committing the changed files
  3. Prepare the release (including executing tests) by executing ./release_prepare.sh.
  4. Check if there where no test errors and Commit the changes created by release preparation script.
  5. Tag and push the latest commit with the prefix v, e.g. v1.4.0

CI will automatically deploy all tagged commits on the main branch.

3rd party dependencies

Author(s)

graphannis-python's People

Contributors

thomaskrause avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.