Simple utils to work with KEGG data on NetworkX
Project description
# KEGGutils: Working with KEGG in Python and NetworkX # <img src=”/img/logo_cut.png” alt=”Drawing” width = “630”></img>
KEGGutils is a toolkit designed for working with the Kyoto Encyclopedia of Genes and Genome database in Python with a quick and easy to use interface: and in a single line you can download data from KEGG’s REST API, organize in a graph-like format provided by NetworkX and immediately start exploring.
KEGGutils is much more than just an API interface: other than a series of tools to better interface yourself with the service, it provides expanded NetworkX classes and methods ( totally nx-compatible ) to handle different types of data and help you better exploit underlying structures. KEGGutils is easily expandable and can be immediately integrated anywhere you use NetworkX to process data.
## Current build status:
master branch : [![CircleCI](https://circleci.com/gh/filippocastelli/KEGGutils.svg?style=svg)](https://circleci.com/gh/filippocastelli/KEGGutils)
dev branch : [![CircleCI](https://circleci.com/gh/filippocastelli/KEGGutils/tree/dev.svg?style=svg)](https://circleci.com/gh/filippocastelli/KEGGutils/tree/dev)
## Installing KEGGutils # <a href=”https://pypi.org/”><img alt = PyPi src=”https://pypi.org/static/images/logo-large.72ad8bf1.svg” height=”100”></img></a>
You can just clone this repo and use it’s content as any other python package, but if you just need a super easy drop-in solution KEGGutils is available as a PyPi package:
to install it you just need to run
pip install KEGGutils
and that should be it!
## Dependencies To make sure KEGGutils works as it should, a few dependencies must be satisfied: - networkx - matplotlib - awesome-slugify - requests - Pillow - scipy
note: if you use pip to install KEGGutils, it should automatically get the needed dependencies for you!
## Getting started
In this repo can find four dense yet easy to follow tutorials covering most of KEGGutils’s functionalities and more are coming in the next future. To start just follow the links below: - [Tutorial 0 - Basics and KEGG API](https://github.com/filippocastelli/KEGGutils/blob/dev/tutorials/Tutorial%200%20-%20Basics%20and%20KEGG%20API.ipynb) - [Tutorial 1 - Enzymatic Graphs](https://github.com/filippocastelli/KEGGutils/blob/dev/tutorials/Tutorial%201%20-%20EnzymeGraphs.ipynb) - [Tutorial 2 - KEGGgraphs, KGGlinkgraphs and KEGGchains](https://github.com/filippocastelli/KEGGutils/blob/dev/tutorials/Tutorial%202%20-%20KEGGgraphs%2C%20KGGlinkgraphs%20and%20KEGGchains.ipynb) - [Tutorial 3 - KEGGpathways](https://github.com/filippocastelli/KEGGutils/blob/dev/tutorials/Tutorial%203%20-%20KEGGpathways.ipynb)
## Contributing
The project is open to contributions and suggestions: the easiest way is just opening an issue on the repo, if that’s too much work just drop me a mail at filippocastelli42@gmail.com
## External links
Here are a few useful links - [KEGG: Kyoto Encyclopedia of Genes and Genomes](https://www.kegg.jp/) - [KEGG REST API reference page](https://www.kegg.jp/kegg/rest/keggapi.html) - [KEGG KGML (KEGG Markup Language) reference page](https://www.kegg.jp/kegg/xml/) - [Networkx Github IO](https://networkx.github.io/)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for KEGGutils-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 166734efaaa2885d38cc6c515e8b66dc8142813f4c43106e26aaeeb0efbc9f5b |
|
MD5 | c22a1c089acdf12f6c609883bb01adc1 |
|
BLAKE2b-256 | cb5120ded067809dae13d5ad10d6659f89ff616419896a865c91034a1bed84d0 |