Skip to main content

Easily pick a place to store data for your python package.

Project description

PyStow

Build status PyPI - Python Version License Documentation Status DOI

👜 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.

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

pystow-0.0.12.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

pystow-0.0.12-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file pystow-0.0.12.tar.gz.

File metadata

  • Download URL: pystow-0.0.12.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for pystow-0.0.12.tar.gz
Algorithm Hash digest
SHA256 d81b61a30c0b8a996ac58bc51d632f1bcd51716ea32b93966565da3dbf68e5f2
MD5 27cd31b74ec67c35fe72aebc3efb6823
BLAKE2b-256 adfaa908d90684936fd731b44c4de95465fa72f73507326f8a473e31fc2f0621

See more details on using hashes here.

Provenance

File details

Details for the file pystow-0.0.12-py3-none-any.whl.

File metadata

  • Download URL: pystow-0.0.12-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for pystow-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 c10ef8b6bb31b4472780d183c0e8e4e8f7600f0cc5e75e8d659dd6dfc226ec08
MD5 34d7cf82bc3a1154a4520afdb1a89d6f
BLAKE2b-256 b6fcf3de2480813e90b58b67afc9ba8c4c7ca2e66e2df94024f6ba3a7014e2bd

See more details on using hashes here.

Provenance

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