Skip to main content

Command-line tool for interacting with ResourceSpace

Project description

ResourceSpace CLI

PyPI version Python 3.11+ License: MIT

A command-line tool for interacting with ResourceSpace digital asset management systems.

Quick Start

# Install
pip install resourcespace-cli

# Configure
rs config set url https://your-resourcespace.com/api
rs config set key your-api-key
rs config set user your-username

# Start using
rs search "landscape photos"
rs download 12345
rs upload photo.jpg

Features

  • Search & Discovery - Search resources with filters, view details, list collections and types
  • Download - Download single resources or batch download by search query
  • Upload - Upload files with metadata, supports glob patterns and batch operations
  • Configuration - Secure credential storage with .env file support
  • Flexible Output - Human-readable tables or JSON for scripting
  • Progress Tracking - Visual progress bars for batch operations

Commands

Command Description Example
rs search Search for resources rs search "photo" --type 1
rs info Display resource details rs info 12345
rs download Download resources rs download 12345 -o ./
rs upload Upload files rs upload *.jpg --type 2
rs collections list List collections rs collections list
rs types list List resource types rs types list
rs config set Set configuration rs config set url https://...
rs config get View configuration rs config get
rs config clear Clear configuration rs config clear --all

Global Options

  • --json - Output results as JSON
  • --no-color - Disable colored output
  • --version - Show version information
  • --help - Show help for any command

Installation

Using pip:

pip install resourcespace-cli

Using pipx (recommended for CLI tools):

pipx install resourcespace-cli

Development installation:

git clone https://github.com/TidalStudio/ResourceSpace-CLI.git
cd ResourceSpace-CLI
pip install -e ".[dev]"

Configuration

The CLI uses environment variables or a .env file for configuration:

Variable Description
RESOURCESPACE_API_URL Your ResourceSpace API endpoint
RESOURCESPACE_API_KEY Your API key
RESOURCESPACE_USER Your username

Use rs config set commands for easy setup, or create a .env file manually.

Documentation

License

MIT License - see LICENSE for details.

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

resourcespace_cli-0.1.2.tar.gz (57.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

resourcespace_cli-0.1.2-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

Details for the file resourcespace_cli-0.1.2.tar.gz.

File metadata

  • Download URL: resourcespace_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 57.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for resourcespace_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c4c702f457f653eeb19f838c38b12b812fa0d599a422f4ff452b8d78bd5bbc4d
MD5 a75b6230816737045fbd4b9406d69900
BLAKE2b-256 63e55b2ba332a7a8ae8079900137fcfab1109363ca94431398673ef4af138641

See more details on using hashes here.

File details

Details for the file resourcespace_cli-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for resourcespace_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d1320a867ec890ad99ce62e8dde24a732e751d81a683090b0c767bba1b4bb399
MD5 f4f641fe8e7c6137c58677d07df39781
BLAKE2b-256 0b89ed6fa26b9cfe8c1c99eb9dba3c66e4dd255abe2e8c1a4c1d7aff03964929

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page