Skip to main content

CLI for installing RevoData modules

Project description

Revo Modules

Revo Modules is a CLI for discovering and installing module bundles from a registry.

Setup

Install the CLI with uv (recommended) or pip.

uv tool install revo-module-installer
pip install revo-module-installer

Usage

revo --help

Search and install a module interactively (the default command lists module names and descriptions, then installs the selected entry).

revo

List modules from the default registry repository.

revo modules list --show-description

Install a specific module ID into your current workspace.

revo modules install example-module

Preview the actions without writing files.

revo modules install example-module --dry-run

Registry sources

The default registry URL is https://github.com/revodatanl/revo-module-registry. You can override it with the REVO_MODULES_REGISTRY_URL environment variable or a user config file.

Create a config file at ~/.config/revo-modules/config.toml (Linux/macOS) or %APPDATA%\\revo-modules\\config.toml (Windows) with:

[registry]
url = "https://github.com/revodatanl/revo-module-registry"

Registry URLs can point to:

  • GitHub repositories, which are resolved to raw registry files.
  • Direct HTTP(S) URLs to registry YAML files.
  • Local files via file:// URLs or file paths.
  • Bundled package examples via package://example_registry.yml.

Manifest URLs support the same URL forms. GitHub blob URLs are automatically converted to raw content URLs.

Local registry fallback for tests

For testing purposes, set the environment variable below to use the bundled example registry:

export REVO_MODULES_ENV=test

When REVO_MODULES_ENV is set to test, the CLI uses the bundled registry regardless of whether the remote registry is reachable.

The bundled registry entry points to package://example_manifest.yml, so the example manifest stays self-contained for offline testing.

Platform support

All code changes must continue to work on Linux, macOS, and Windows. Ensure tests and tooling remain green across all three platforms.

Contributing

For contributor-focused guidelines, setup and development workflows, see CONTRIBUTING.md.

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

revo_module_installer-0.3.4.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

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

revo_module_installer-0.3.4-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file revo_module_installer-0.3.4.tar.gz.

File metadata

  • Download URL: revo_module_installer-0.3.4.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for revo_module_installer-0.3.4.tar.gz
Algorithm Hash digest
SHA256 10099a03d9dcb177f2ab4637d70c4202e8b982c7b159613b56a9bd13f6700bc8
MD5 f8aa14a28293076fae78285f38e8ec9e
BLAKE2b-256 1fa445921b9660a7780326f55fe8f2e36dcc0d4d4f5885baa7a5348c8891bc31

See more details on using hashes here.

Provenance

The following attestation bundles were made for revo_module_installer-0.3.4.tar.gz:

Publisher: release-publish.yml on revodatanl/revo-module-installer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file revo_module_installer-0.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for revo_module_installer-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c2787f04e3e115fa2f7b489c39dc708264791fe88420bcee7ea5886cc73037e5
MD5 ec698b417615e0fb7516933c9960e08d
BLAKE2b-256 2ca3ed8676c8f386952a655233a9c73b9f22e7cb28a5fcb00fbc5f9171b78207

See more details on using hashes here.

Provenance

The following attestation bundles were made for revo_module_installer-0.3.4-py3-none-any.whl:

Publisher: release-publish.yml on revodatanl/revo-module-installer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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