pkdb-analysis 0.2.1

pkdb-analysis are utilities to work with PKDB.

pkdb_analysis: PK-DB python interface

pkdb_analysis is a collection of python utilities to interact with PK-DB via the available REST endpoints (https://pk-db.com/api/v1/swagger/).

How to cite

License

• Source Code: LGPLv3

• Documentation: CC BY-SA 4.0

The pkdb_analysis source is released under both the GPL and LGPL licenses version 2 or later. You may choose which license you choose to use the software under.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License or the GNU Lesser General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Funding

Matthias König and Jan Grzegorzewski are supported by the Federal Ministry of Education and Research (BMBF, Germany) within the research network Systems Medicine of the Liver (LiSyM, grant number 031L0054).

Installation

pkdb_analysis is available from pypi and can be installed via:

pip install pkdb-analysis

Develop version

The latest develop version can be installed via:

pip install git+https://github.com/matthiaskoenig/pkdb_analysis.git@develop

Or via cloning the repository and installing via:

git clone https://github.com/matthiaskoenig/pkdb_analysis.git
cd pkdb_analysis
pip install -e .

To install for development use:

pip install -e .[development]

PK-DB endpoint

pkdb_analysis requires an existing PK-DB endpoint, which can be set by setting the respective environment variables.:

set -a && source .env.local

The public instances of PK-DB are available from:

API_BASE=https://alpha.pk-db.com
API_BASE=https://pk-db.com

By default the alpha server is used.

© 2018-2021 Jan Grzegorzewski & Matthias König.