Gitiles
Code Review Sign In
korap.ids-mannheim.de / KorAP / PythonKorAPClient / 629269077a2644e6635564e126001cfdd819caa7
commit629269077a2644e6635564e126001cfdd819caa7[log] [tgz]
authorMarc Kupietz <kupietz@ids-mannheim.de>Sat Jun 01 13:38:28 2024 +0200
committerMarc Kupietz <kupietz@ids-mannheim.de>Sat Jun 01 13:38:39 2024 +0200
treea324efaf55d9714088fe0eb6d5088566a1e28554
parentb3908d025043198f431c16e124589216df1c9e3e [diff]
GitLab-CI: reduce dependencies

Change-Id: I9f4d349d265d3ebdb793b1c033c54415b65690dc
1 file changed
tree: a324efaf55d9714088fe0eb6d5088566a1e28554
  1. .github/
  2. bin/
  3. ci/
  4. examples/
  5. figures/
  6. KorAPClient/
  7. .gitignore
  8. .gitlab-ci.yml
  9. CHANGELOG.md
  10. LICENSE.txt
  11. MANIFEST.in
  12. pyproject.toml
  13. Readme.md
  14. setup.cfg
Readme.md

KorAP web service client package for Python

Project Status: Active – The project has reached a stable, usable state and is being actively developed. CI check Last commit GitHub closed issues GitHub issues GitHub license PyPI - Python Version PyPI - Downloads

Description

Python client wrapper package to access the web service API of the KorAP Corpus Analysis Platform developed at IDS Mannheim. Currently, this is no native Python package. Internally, it uses KorAP's client package for R via rpy2. The latter also automatically translates between R data frames (or tibbles) and pandas DataFrames.

Installation

1. Install latest R version for your OS, following the instructions from CRAN

Linux only: Install system dependencies

#### Debian / Ubuntu
sudo apt install r-base-dev r-cran-rcpp r-cran-cpp11 libcurl4-gnutls-dev libxml2-dev libsodium-dev libsecret-1-dev libfontconfig1-dev libssl-dev libv8-dev python3-dev python3-pip python3-rpy2 python3-pandas python3-pytest libdeflate-dev r-cran-rcpparmadillo

#### Fedora / CentOS / RHEL
sudo yum install -y R R-devel libcurl-devel openssl-devel libxml2-devel libsodium-devel python3-pandas

2. Install the RKorAPClient package

Start R and run:

install.packages('RKorAPClient', repos='https://cloud.r-project.org/')

or install RKorAPClient from the package installation menu entry.

3. Install the Python package

On Linux and MacOs:

# py -m pip install KorAPClient -U
python3 -m pip install KorAPClient -U # --break-system-packages

On Windows:

# py -m pip install pip -U
py -m pip install KorAPClient -U

Documentation

The core classes and methods to access the KorAP API are documented in the KorAPClient API documentation. For additional, mostly static helper functions, please refer to the Reference Manual of RKorAPClient for now. For translating R syntax to Python and vice versa, refer to the rpy2 Documentation.

Please note that some arguments in the original RKorAPClient functions use characters that are not allowed in Python keyword argument names. For these cases, you can however use Python's **kwargs syntax. For example, to let frequencyQuery interpret queries as queries for alternative variants and make it return their proportions instead of relative frequencies, you can write:

from KorAPClient import KorAPConnection
KorAPConnection(verbose=True) \
    .frequencyQuery(['"Wissenschaftler.*"', '"Wissenschafter.*"'],\
                    **{"as.alternatives": True})
querytotalResultsvcwebUIRequestUrltotalfconf.lowconf.high
1"Wissenschaftler.*"942053https://korap.ids-mannheim.de/?q=%22Wissenschaftler.%2a%22&ql=poliqarp10802680.8720550.8714230.872684
2"Wissenschafter.*"138215https://korap.ids-mannheim.de/?q=%22Wissenschafter.%2a%22&ql=poliqarp10802680.1279450.1273160.128577

Examples

Frequencies of "Hello World" over years and countries

from KorAPClient import KorAPClient, KorAPConnection
import altair as alt
import pandas as pd

QUERY = "Hello World"
df = pd.DataFrame(range(2010, 2019), columns=["Year"], dtype=str) \
    .merge(pd.DataFrame(["DE", "CH"], columns=["Country"]), how="cross")
df["vc"] = "textType=/Zeit.*/ & pubPlaceKey = " + df.Country + " & pubDate in " + df.Year
df = KorAPClient.ipm(KorAPConnection().frequencyQuery(QUERY, df.vc)).merge(df)

alt.Chart(df).mark_line(point=True).encode(y="ipm", x="Year:T", color="Country", href="webUIRequestUrl") \
    .properties(title=QUERY).show()

Frequency per million words of “Hello World“ in DE vs. CH from 2010 to 2018 in newspapers and magazines

Identify in … setzen light verb constructions by the collocationAnalysis method

Lifecycle:experimental

from KorAPClient import KorAPConnection

kcon = KorAPConnection(verbose=True)
results = kcon.collocationAnalysis("focus(in [tt/p=NN] {[tt/l=setzen]})",
                                   leftContextSize=1,
                                   rightContextSize=0,
                                   exactFrequencies=False,
                                   searchHitsSampleLimit=1000,
                                   topCollocatesLimit=20)
results['collocate'] = "[" + results['collocate'] +"](" + results['webUIRequestUrl'] +")"
print(results[['collocate', 'logDice', 'pmi', 'll']].head(10).round(2).to_markdown(floatfmt=".2f"))
collocatelogDicepmill
1Szene10.3711.54824928.58
2Gang9.6510.99366993.93
3Verbindung9.2010.34347644.75
4Kenntnis9.1510.67206902.89
5Bewegung8.809.91264577.07
6Brand8.769.97210654.43
7Anführungszeichen8.0612.5254148.31
8Kraft7.948.91189399.70
9Beziehung6.928.2937723.54
10Relation6.6410.2417105.84

Command Line Invocation

The Python KorAP client can also be called from the command line and shell scripts:

$ korapclient -h
usage: python -m KorAPClient [-h] [-v] [-l QUERY_LANGUAGE] [-u API_URL] [-c VC [VC ...]] [-q QUERY [QUERY ...]]

Send a query to the KorAP API and print results as tsv.

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose
  -l QUERY_LANGUAGE, --query-language QUERY_LANGUAGE
  -u API_URL, --api-url API_URL
                        Specify this to access a corpus other that DeReKo.
  -c VC [VC ...], --vc VC [VC ...]
                        virtual corpus definition[s]
  -q QUERY [QUERY ...], --query QUERY [QUERY ...]
                        If not specified only the size of the virtual corpus will be queried.

example:
  python -m KorAPClient -v --query "Hello World" "Hallo Welt" --vc "pubDate in 2017" "pubDate in 2018" "pubDate in 2019"

Accessed API Services

By using the KorAPClient you agree to the respective terms of use of the accessed KorAP API services which will be printed upon opening a connection.

Development and License

Author: Marc Kupietz

Copyright (c) 2024, Leibniz Institute for the German Language, Mannheim, Germany

This package is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for the German Language (IDS).

It is published under the BSD-2 License.

Contributors: Ines Pisetta, Nils Diewald, Tim Feldmüller

To cite this work, please refer to: Kupietz et al. (2020, 2022), below.

Contributions

Contributions are very welcome!

Your contributions should ideally be committed via our Gerrit server to facilitate reviewing (see Gerrit Code Review - A Quick Introduction if you are not familiar with Gerrit). However, we are also happy to accept comments and pull requests via GitHub.

Please note that unless you explicitly state otherwise any contribution intentionally submitted for inclusion into this software shall – as this software itself – be under the BSD-2 License.

References