| Name | mds-exporter JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A CLI tool for bulk downloading from museum data service API with rich progress tracking. |
| upload_time | 2025-07-30 03:54:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT |
| keywords |
api
bulk-download
cli
data
museum
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MDS Exporter
A simple CLI tool, written in Python, to manage MDS resume tokens and download data from the MDS API.
## Installation
The recommended way to install the tool is to use the `pipx` package manager. This will make the `mds-exporter` command available system-wide.
```bash
pipx install mds-exporter
```
It can also be installed to a specific environment:
```bash
pip install mds-exporter
```
## Usage
### Token Versions
Each stored token keeps track of three versions to help you pick up where you left off:
`base`: Your original starting token (never changes) - lets you restart the whole download from scratch if needed <br/>
`last`: Whatever token was used most recently - keeps track of where you are in any current download <br/>
`latest`: The token from your most complete download (the one that got the farthest) <br/>
This setup gives you options when things go wrong. You can always use `base` to start over completely. If a download gets interrupted, `last` lets you resume right where you stopped. And `latest` stays safe and untouched, so you can always go back to refreshing your best/most complete dataset without messing up your current download progress.
### Token Management
Store and manage MDS API tokens:
```bash
# Add a token with auto-generated name (e.g., "ancient-river")
mds token add YOUR_MDS_TOKEN
# Add a token with custom name
mds token add --name my-token YOUR_MDS_TOKEN
# List all stored tokens
mds token list
# Remove a token
mds token remove my-token
```
### Downloading Data
Download MDS data using stored tokens or direct tokens:
```bash
# Download using stored token (uses 'last' version by default)
mds download --name my-token
# Download using specific token version
mds download --name my-token:latest
mds download --name my-token:base
# Download using direct token
mds download --token YOUR_MDS_TOKEN
# Specify output file
mds download --name my-token --output my-data.jsonl
# Compress output using zstd (recommended for large datasets)
mds download --name my-token --compress --output my-data
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mds-exporter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "api, bulk-download, cli, data, museum",
"author": null,
"author_email": "William Thorne <wthorne1@sheffield.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/9f/54/df8f91a191ff059c27548e81815048b5e6eef64c205bdd11453cbb638b79/mds_exporter-0.1.0.tar.gz",
"platform": null,
"description": "# MDS Exporter\n\nA simple CLI tool, written in Python, to manage MDS resume tokens and download data from the MDS API.\n\n## Installation\n\nThe recommended way to install the tool is to use the `pipx` package manager. This will make the `mds-exporter` command available system-wide.\n\n```bash\npipx install mds-exporter\n```\n\nIt can also be installed to a specific environment:\n\n```bash\npip install mds-exporter\n```\n\n## Usage\n\n### Token Versions\n\nEach stored token keeps track of three versions to help you pick up where you left off:\n\n`base`: Your original starting token (never changes) - lets you restart the whole download from scratch if needed <br/>\n`last`: Whatever token was used most recently - keeps track of where you are in any current download <br/>\n`latest`: The token from your most complete download (the one that got the farthest) <br/>\n\nThis setup gives you options when things go wrong. You can always use `base` to start over completely. If a download gets interrupted, `last` lets you resume right where you stopped. And `latest` stays safe and untouched, so you can always go back to refreshing your best/most complete dataset without messing up your current download progress.\n\n\n### Token Management\n\nStore and manage MDS API tokens:\n\n```bash\n# Add a token with auto-generated name (e.g., \"ancient-river\")\nmds token add YOUR_MDS_TOKEN\n\n# Add a token with custom name\nmds token add --name my-token YOUR_MDS_TOKEN\n\n# List all stored tokens\nmds token list\n\n# Remove a token\nmds token remove my-token\n```\n\n### Downloading Data\n\nDownload MDS data using stored tokens or direct tokens:\n\n```bash\n# Download using stored token (uses 'last' version by default)\nmds download --name my-token\n\n# Download using specific token version\nmds download --name my-token:latest\nmds download --name my-token:base\n\n# Download using direct token\nmds download --token YOUR_MDS_TOKEN\n\n# Specify output file\nmds download --name my-token --output my-data.jsonl\n\n# Compress output using zstd (recommended for large datasets)\nmds download --name my-token --compress --output my-data\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI tool for bulk downloading from museum data service API with rich progress tracking.",
"version": "0.1.0",
"project_urls": {
"Bug Reports": "https://github.com/wrmthorne/mds-exporter/issues",
"Homepage": "https://github.com/wrmthorne/mds-exporter",
"Source": "https://github.com/wrmthorne/mds-exporter"
},
"split_keywords": [
"api",
" bulk-download",
" cli",
" data",
" museum"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f0b7b5b84ba116a3c551afcac5e52000ec1a7e3896e284c58bd357d9741d9731",
"md5": "c4dc355bb22bdca9fed417bd82542a8b",
"sha256": "f31d12b92c5163ec50133c42dfb6dd97e2dbb36c23817a99619724884c68cf85"
},
"downloads": -1,
"filename": "mds_exporter-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4dc355bb22bdca9fed417bd82542a8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 9824,
"upload_time": "2025-07-30T03:54:02",
"upload_time_iso_8601": "2025-07-30T03:54:02.105142Z",
"url": "https://files.pythonhosted.org/packages/f0/b7/b5b84ba116a3c551afcac5e52000ec1a7e3896e284c58bd357d9741d9731/mds_exporter-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9f54df8f91a191ff059c27548e81815048b5e6eef64c205bdd11453cbb638b79",
"md5": "d7a7b6abb25ae813a5f722dbf77bb884",
"sha256": "fedbb7c406af4ab1e6dc5d97170d95bc2aa584b5466059719a6a9cdb754f7f45"
},
"downloads": -1,
"filename": "mds_exporter-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d7a7b6abb25ae813a5f722dbf77bb884",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 24754,
"upload_time": "2025-07-30T03:54:03",
"upload_time_iso_8601": "2025-07-30T03:54:03.143363Z",
"url": "https://files.pythonhosted.org/packages/9f/54/df8f91a191ff059c27548e81815048b5e6eef64c205bdd11453cbb638b79/mds_exporter-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 03:54:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wrmthorne",
"github_project": "mds-exporter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "mds-exporter"
}
