sparecores-data 0.5.1

Spare Cores Navigator Data

The Spare Cores Navigator Data is a Python package to make it easy to access the latest version of the Spare Cores Navigator data via a SQLite database file. This database file is compiled from an automatically downloaded, compressed SQLite database dump, periodically updated by a background thread.

Installation

Stable version from PyPI:

pip install sparecores-data

Most recent version from GitHub:

pip install "sparecores-data @ git+https://git@github.com/SpareCores/sc-data.git"

Usage

For easy access to the most recent version of the SQLite database file, import the db object of the sc_data Python package, which runs an updater thread in the background to keep the SQLite file up-to-date:

from sc_data import db

print(db.path)

The database is cached locally in a persistent directory and automatically updated when needed. On import, the package:

1. Checks the local cache for a valid (non-stale) database
2. If cached and fresh, uses it immediately
3. Otherwise, downloads the latest version from our CDN

The cache is stored in a platform-specific location:

• Linux: $XDG_CACHE_HOME/sparecores-data/ or ~/.cache/sparecores-data/
• macOS: ~/Library/Caches/sparecores-data/
• Windows: %LOCALAPPDATA%/sparecores-data/

To enforce waiting for the update to complete, you can use the updated event:

db.updated.wait()

Command-line interface

To get the most recent version of the SQLite database file without writing any Python code, e.g. for use in other tools, run:

sc-data download /path/to/sc-data.db

This downloads and imports the data into the cache as described above, then copies the resulting SQLite file to the given path -- overwriting an already existing file, and creating missing parent directories.

Run sc-data download --help for the available options, e.g. --db-url, --timeout, or --no-update to use the cached file without checking for a newer version.

Configuration

The package comes with the following set of default parameters, which can be overridden by builtins or environment variables:

Note: Setting SC_DATA_DB_PATH disables caching and uses the specified file directly.

Licensing

The source code of the sparecores-data package is released under the MPL 2.0 license.

The default SQLite database dump file downloaded at runtime is published under the Business Source License 1.1 (BSL 1.1) license.

Details -- including the publisher, timestamped release date, license type, additional usage terms, and a link to the full license text -- is available in the _metadata table of the database, and printed to the stderr by default on every Data instantialization.

References

• Data source
• sparecores.com