Easily pick a place to store data for your python package.
Project description
PyStow
👜 Easily pick a place to store data for your python package.
💪 Usage
Get a directory for your application.
import pystow
# Get a directory (as a pathlib.Path) for ~/.data/pykeen
pykeen_directory = pystow.get('pykeen')
# Get a subdirectory (as a pathlib.Path) for ~/.data/pykeen/experiments
pykeen_experiments_directory = pystow.get('pykeen', 'experiments')
# You can go as deep as you want
pykeen_deep_directory = pystow.get('pykeen', 'experiments', 'a', 'b', 'c')
Ensure a file from the internet is available in your application's directory:
import pystow
url = 'https://raw.githubusercontent.com/pykeen/pykeen/master/src/pykeen/datasets/nations/test.txt'
path = pystow.ensure('pykeen', 'datasets', 'nations', url=url)
Ensure a file from the internet and load it for usage:
import pystow
url = 'https://raw.githubusercontent.com/pykeen/pykeen/master/src/pykeen/datasets/nations/test.txt'
df = pystow.ensure_csv('pykeen', 'datasets', 'nations', url=url)
Also see pystow.ensure_excel(), pystow.ensure_rdf(), pystow.ensure_zip_df(), and pystow.ensure_tar_df().
⚠️ Configuration
Data gets stored in ~/.data by default. If you want to change the name of the directory, set the environment
variable PYSTOW_NAME. If you want to change the default parent directory to be other than the home directory,
set PYSTOW_HOME
🚀 Installation
The most recent release can be installed from PyPI with:
$ pip install pystow
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/cthoyt/pystow.git
To install in development mode, use the following:
$ git clone git+https://github.com/cthoyt/pystow.git
$ cd pystow
$ pip install -e .
⚖️ License
The code in this package is licensed under the MIT License.
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 pystow-0.0.13.tar.gz.
File metadata
- Download URL: pystow-0.0.13.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3022e53dd5ac45f7f11b4ad1d7839713e7d65986845397f9663f9595812d8717 |
|
| MD5 | 1d8da76712bb188d3267e2c628ff20af |
|
| BLAKE2b-256 | cdf39e1f3cb5982e1f2fdf7b7d0c74fdcf5041f24a4ccf2fb360c9bb174d31f0 |
Provenance
File details
Details for the file pystow-0.0.13-py3-none-any.whl.
File metadata
- Download URL: pystow-0.0.13-py3-none-any.whl
- Upload date:
- Size: 12.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5b9fb44ebd4864e2488c5184c6577370b689b3a43f9f1c7b31d6ae2b416b7a4c |
|
| MD5 | 337deda0bdd76e00169484f035de7050 |
|
| BLAKE2b-256 | 79689876d0d1e42540feccebeacbb2daeba545e525d1721ca49c6104015f4c7b |
