Skip to main content

Description

The kegg_pull package provides a number of useful CLI and API features for interacting with the KEGG REST API. This includes wrapper methods/commands for all the REST API operations, pulling lists of KEGG entry IDs, and pulling an arbitrary number of KEGG entries, in a single call, that are automatically separated and saved in individual files.

Documentation

The complete documentation for our API and CLI including tutorials can be found here.

Installation

Requires python 3.10 and above.

Using conda

conda install -c bioconda kegg_pull

Using pip

For Linux, Mac OS X:

python3 -m pip install kegg-pull

For Windows:

py -3 -m pip install kegg-pull

Note: Many KEGG entry IDs contain colons and kegg_pull saves KEGG entry files with their ID in the file name. When running on Windows, all file names with colons will have their colons replaced with underscores.

Note: If py is not installed on Windows (e.g. Python was installed via the Windows store rather than from the official Python website), the installation command is the same as Linux and Mac OS X.

Note: If the kegg_pull console script is not found on Windows, the CLI can be used via python3 -m kegg_pull or py -3 -m kegg_pull or path\to\console\script\kegg_pull.exe. Alternatively, the directory where the console script is located can be added to the Path environment variable. For example, the console script may be installed at:

c:\users\<username>\appdata\local\programs\python\python310\Scripts\

PyPi

See our PyPi page here.

BioConda

See our BioConda page here.

Questions, Feature Requests, and Bug Reports

Please submit any questions or feature requests you may have and report any potential bugs/errors you observe on our GitHub issues page.

Dependencies

Note, the pip and conda commands will install dependencies automatically.

docopt
requests
tqdm
jsonschema

Get the source code

Code is available on GitHub: https://github.com/MoseleyBioinformaticsLab/kegg_pull.

You can clone the repository via:

git clone https://github.com/MoseleyBioinformaticsLab/kegg_pull.git

Once you have a copy of the source, you can embed it in your own Python package, or install it into your system site-packages easily:

Linux, Mac OS X

python3 setup.py install

Windows

py -3 setup.py install

Metadata

Release files for kegg-pull 3.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kegg-pull 3.2.4
File Size Uploaded
kegg_pull-3.2.4.tar.gz 492.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kegg-pull 3.2.4
File Interpreter ABI Platform
kegg_pull-3.2.4-py3-none-any.whl Python 3 none any Details

Total release size: 534.3 kB

Release files / kegg_pull-3.2.4.tar.gz

Download URL kegg_pull-3.2.4.tar.gz
Size 492.9 kB
Tags Source
SHA-256 checksum
How to use checksums
52e474da0ffc4c35da902549242ef45de0403d77e7444b730f971e773627e758
BLAKE2b-256 checksum
How to use checksums
6453c86ee56834ac81c0513bd215503e44ec00bdff0dbd20335e602dc19355a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / kegg_pull-3.2.4-py3-none-any.whl

Download URL kegg_pull-3.2.4-py3-none-any.whl
Size 41.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b8a479102601cffad2a2c55a6a7c561c9d26d12893fae2ef79267f338c91f59e
BLAKE2b-256 checksum
How to use checksums
b212b57d0f8c78248f48e20e8de85f7651ff20547bda74177c4912b0ec4533a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

3.2.4 This release

2 release files

3.2.3

2 release files

3.2.2

2 release files

3.1.0

1 release file

3.0.0

1 release file

2.1.0

1 release file

2.0.0

1 release file

1.4.1

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.0

1 release file

1.1.0

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page