Download, open, and query ChEMBL through SQLite
Project description
chembl_downloader
Don't worry about downloading/extracting ChEMBL or versioning - just use chembl_downloader
to write code that knows
how to download it and use it automatically.
Installation
$ pip install chembl-downloader
Usage
Download A Specific Version
import chembl_downloader
path = chembl_downloader.download(version='28')
After it's been downloaded and extracted once, it's smart and doesn't need to download again. It gets stored
using pystow
automatically in the ~/.data/chembl
directory.
We'd like to implement something such that it could load directly into SQLite from the archive, but it appears this is a paid feature.
Download the Latest Version
First, you'll have to install bioversions
with pip install bioversions
, whose job it is to look up the latest version of many databases. Then, you can modify
the previous code slightly by omitting the version
keyword argument:
import chembl_downloader
path = chembl_downloader.download()
The version
keyword argument is available for all functions in this package, but like the username and password will
be omitted for brevity.
Automate Connection
Inside the archive is a single SQLite database file. Normally, people manually untar this folder then do something with the resulting file. Don't do this, it's not reproducible! Instead, the file can be downloaded and a connection can be opened automatically with:
import chembl_downloader
with chembl_downloader.cursor(version='28') as cursor:
cursor.execute(...) # run your query string
rows = cursor.fetchall() # get your results
You now know everything I can teach you. Please use these tools to do re-usable, reproducible science!
Store in a Different Place
If you want to store the data elsewhere using pystow
(e.g., in pyobo
I also keep a copy of this file), you can use the prefix
argument.
import chembl_downloader
# It gets downloaded/extracted to
# ~/.data/pyobo/raw/chembl/29/chembl_29/chembl_29_sqlite/chembl_29.db
path = chembl_downloader.download(prefix=['pyobo', 'raw', 'chembl'])
See the pystow
documentation on configuring the storage
location further.
Download via CLI
After installing, run the following CLI command to ensure it and send the path to stdout
$ chembl_downloader
Contributing
If you'd like to contribute, there's a submodule called chembl_downloader.queries
where you can add a SQL query along with a description of what it does for easy
importing.
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
File details
Details for the file chembl_downloader-0.0.2.tar.gz
.
File metadata
- Download URL: chembl_downloader-0.0.2.tar.gz
- Upload date:
- Size: 9.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7af582a4046f22ec213790e3a37e1bd794b3531a841a366388738a009d857b53 |
|
MD5 | 77da82a2ff4a28e4b15105e20a9f3ced |
|
BLAKE2b-256 | 5abcce0874a704bd3e952fb0497d460b43379a23a504262dc130a9edd5718de2 |
Provenance
File details
Details for the file chembl_downloader-0.0.2-py3-none-any.whl
.
File metadata
- Download URL: chembl_downloader-0.0.2-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 852e60529951f2b95ddc12d586ea971ed8ac5f27856cb80d9b7b3c703ca0d0b1 |
|
MD5 | de7293d2a20b7314dfaed2ad3d468f82 |
|
BLAKE2b-256 | a26a16075993fd1d0b58ef2ff5f3784169decaeaba4e87dec1b4c881aca359e8 |