Skip to main content

kegg-ingest

Project description

# kegg-ingest CLI

`kegg-ingest` is a command line interface for interacting with the KEGG database. This tool allows you to fetch, process, and manage data from KEGG.

## Installation

To install `kegg-ingest`, use pip:

```sh
pip install kegg-ingest

Commands

get

Fetch and process data from KEGG.

Usage:

kegg-ingest get --db <database> [--batch-size <size>] [--use-kegg/--no-use-kegg] [--output <file>]

Options:

  • --db: Database to use (required).
  • --batch-size, -b: Batch size for processing (default: 10, max: 10).
  • --use-kegg/--no-use-kegg: Use KEGG API to fetch data (default: True). Alternatively uses bioservices
  • --output, -o: Output file to write to (tsv format).

Example:

kegg-ingest get --db pathway --batch-size 5 --use-kegg --output output.tsv

clear-db

Clear the entire database.

Usage:

kegg-ingest clear-db

drop

Drop a specific table from the database.

Usage:

kegg-ingest drop <table_name>

Arguments:

  • table_name: Name of the table to drop.

Example:

kegg-ingest drop pathway_table

preview

Show the contents of a table.

Usage:

kegg-ingest preview <table_name> [--limit <number>]

Arguments:

  • table_name: Name of the table to preview.

Options:

  • --limit: Number of rows to preview (default: 5).

Example:

kegg-ingest preview pathway_table --limit 10

overview

Print an overview of the database.

Usage:

kegg-ingest overview

query

Run a query on the database.

Usage:

kegg-ingest query <query_text>

Arguments:

  • query_text: SQL query to run.

Example:

kegg-ingest query "SELECT * FROM pathway_table WHERE description LIKE '%metabolism%'"

License

This project is licensed under the MIT License. See the LICENSE file for details.


Acknowledgements

This cookiecutter project was developed from the monarch-project-template template and will be kept up-to-date using cruft.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kegg_ingest-0.0.1.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

kegg_ingest-0.0.1-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file kegg_ingest-0.0.1.tar.gz.

File metadata

  • Download URL: kegg_ingest-0.0.1.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for kegg_ingest-0.0.1.tar.gz
Algorithm Hash digest
SHA256 8b8d8c3f4a01b7a9f632dda19bac9834a39063ac20d32965c797376b6d53583c
MD5 40eb5cdef8aa8cf3bef9872b0dee58de
BLAKE2b-256 805aed5e0083b42f54536b7a05dcb5f8ec567b27f17cae3f736aa529eb5155e1

See more details on using hashes here.

File details

Details for the file kegg_ingest-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: kegg_ingest-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for kegg_ingest-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 951b71031fb67e157fe55eb77a0baf653020441edc9cafc179a49273ca678e5f
MD5 4dc5a3d8c436a30a8426fab0938a14f0
BLAKE2b-256 b32e832dfdc411a0404f4ff0616504cb1a82c2f5c27d763f9daa70cc109ed667

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page