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.2.tar.gz (14.8 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.2-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: revo_module_installer-0.3.2.tar.gz
  • Upload date:
  • Size: 14.8 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.2.tar.gz
Algorithm Hash digest
SHA256 966ba530c972786b2a5c2bd5abc6c93c7f4bed9ac94b65a7c0c9ae19b83151e0
MD5 9824d67a515b6837b1d170ba612c16f8
BLAKE2b-256 cd18ecaee1f0f80c323c96a38bb9a5c07a2715566147468a0bc28903dbd401bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for revo_module_installer-0.3.2.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.2-py3-none-any.whl.

File metadata

File hashes

Hashes for revo_module_installer-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4014dede46abc8cfe1d7feddca16c5d1d375f3a22f4a492562e48bf579c58146
MD5 20bc2d3e03bc2a149099caf794394e51
BLAKE2b-256 8ce3e1a654686db80bd322c4a3fb699457adc1c092b20c0e6f3b9368e453ea70

See more details on using hashes here.

Provenance

The following attestation bundles were made for revo_module_installer-0.3.2-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