Skip to main content

CLI for interacting with the Restream.io API

Project description

restream.io CLI

Python command-line tool to interact with the Restream.io API.

Bootstrapping

Requires uv installed.

uv sync

Basic commands

  • restream.io login - perform OAuth2 login flow (opens browser, listens locally).
  • restream.io profile - show user profile.
  • restream.io channel list - list channels.
  • restream.io channel get <id> - fetch specific channel.
  • restream.io event list - list events.
  • restream.io version - show dynamic version derived from git tags.

Configuration

Storage Location

Tokens and configuration are stored securely in the user's platform-appropriate config directory:

  • Linux/macOS: ~/.config/restream.io/
  • Windows: %APPDATA%\restream.io\

The configuration directory location can be overridden using the RESTREAM_CONFIG_PATH environment variable.

Environment Variables

The following environment variables are required for OAuth2 authentication:

  • RESTREAM_CLIENT_ID: OAuth2 client ID (required)
  • RESTREAM_CLIENT_SECRET: OAuth2 client secret (required)

Additional optional configuration:

  • RESTREAM_CONFIG_PATH: Override the default configuration directory path

Before using the login command, ensure both authentication variables are set:

export RESTREAM_CLIENT_ID="your_client_id_here"
export RESTREAM_CLIENT_SECRET="your_client_secret_here"
restream.io login

Security

  • Configuration directory is created with 0o700 permissions (owner read/write/execute only)
  • Token files are created with 0o600 permissions (owner read/write only)
  • Tokens are stored in JSON format in tokens.json within the config directory

Development

Run tests:

uv run pytest

Roadmap

See AGENTS.md for AI agent instructions and extension points.

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

restream_io-0.2.0.tar.gz (26.9 kB view details)

Uploaded Source

Built Distribution

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

restream_io-0.2.0-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file restream_io-0.2.0.tar.gz.

File metadata

  • Download URL: restream_io-0.2.0.tar.gz
  • Upload date:
  • Size: 26.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.12

File hashes

Hashes for restream_io-0.2.0.tar.gz
Algorithm Hash digest
SHA256 50533dd81740ff4b8b86e9d5b043cd529b405cab486d7fbebad22fd7b871dbdb
MD5 f5a5a9900ecfdea21a8c995f0843ff26
BLAKE2b-256 09f78d771d0155a961e7379a2a49d6759496e63a42a8ee8f647fc70497080971

See more details on using hashes here.

File details

Details for the file restream_io-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for restream_io-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 759680bbf5f49f4fc582b86e55d35358482704597cf31778de576e2061d19b9f
MD5 bf9611d8ab78b537b7db653fe9cb0fb3
BLAKE2b-256 090ea40140a18914045067de68d74ac45b87bb72c0c44060d4dc8db3ede89576

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