Skip to main content
Docs:

https://cagey.readthedocs.io

Cagey

First and foremost cagey is a command line tool for creating and managing a cage database. With cagey you will extract a a range of experimental and computational data in a variety of formats and place it into a single file. You can then use this file as input for your scripts which perform data analysis. You can install cagey with:

pip install cagey

Once installed you can use the command line tool to create a new database:

cagey new path/to/data path/to/cagey.db

This will create a new database at path/to/cagey.db and populate it with data from path/to/data. There are in fact a lot more things you can do with cagey, and the best way to learn about them is to use it interactively, starting with:

cagey --help
 Usage: cagey [OPTIONS] COMMAND [ARGS]...

 A cage database tool.
 Run cagey help intro for an introduction.

╭─ Options ───────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.             │
│ --show-completion             Show completion for the current shell, to copy it or  │
│                               customize the installation.                           │
│ --help                        Show this message and exit.                           │
╰─────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────╮
│ help         Get help on how to use cagey.                                          │
│ insert       Insert new data into the cagey database.                               │
│ ms           Mass spectrum analysis.                                                │
│ new          Create a new database.                                                 │
│ nmr          Extract NMR peaks.                                                     │
╰─────────────────────────────────────────────────────────────────────────────────────╯

Working with the database

Once you’ve used cagey to create a database, you can use the cagey.queries module to extract data from it in your Python scripts. This step is best understood by reading our documentation, which you can find at https://cagey.readthedocs.io.

Metadata

Release files for cagey 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cagey 1.0.4
File Size Uploaded
cagey-1.0.4.tar.gz 443.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cagey 1.0.4
File Interpreter ABI Platform
cagey-1.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 486.8 kB

Release files / cagey-1.0.4.tar.gz

Download URL cagey-1.0.4.tar.gz
Size 443.0 kB
Tags Source
SHA-256 checksum
How to use checksums
99ceadd3500bf58b0607f792f1019fb6e9b2c3c57f9805e2c9f76ba926bfc8f7
BLAKE2b-256 checksum
How to use checksums
66af8f5c2aca6e3071e4b999a9e77e057b3ef96f036520e5a6945748aa7f5b1f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.8

Release files / cagey-1.0.4-py3-none-any.whl

Download URL cagey-1.0.4-py3-none-any.whl
Size 43.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4714c630e797981283090df7914b0b2b9735ffffc52d12d15b9fe4d90e5b5e9e
BLAKE2b-256 checksum
How to use checksums
64c39b44638d5aee2eeda2a7155344a5b8c13f43f68765af95a88d7950c81183
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.8

Release history Release notifications | RSS feed

This release

1.0.4 This release

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page