Skip to main content

license CircleCI GitHub issues Codecov

RAMP

Redis Automatic Module Packaging

Similar to npm init, this packer bundles Redis Modules for later distribution.

It gathers information from modules e.g. module's name, command list, version and additional metadata.

Prerequisites

Make sure redis-server is on your PATH

export PATH=$PATH:<PATH_TO_REDIS>

Install

You can either use pip install or the setup.py script

pip install ramp-packer
python setup.py install

Usage

Manifest mode

ramp pack <PATH_TO_RedisModule.so> -m <PATH_TO_Manifest.yml>

manifest.yml should specify your module's attributes, the ones you would specify manualy if you were to use the Command line mode, see Full usage options and manifest.yml for a reference.

Command line mode

ramp pack <PATH_TO_RedisModule.so> -a <author> -e <email> -A <architecture> -d <description> -h <homepage> -l <license> -c <cmdargs> -r <redis-min-version>

Full usage options

Usage: ramp [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  pack
  unpack
  validate
  version

Packing

Usage: ramp pack [OPTIONS] MODULE

Options:
  -o, --output TEXT               output file name
  -v, --verbose                   verbose mode: print the resulting metadata
  -m, --manifest FILENAME         generate package from manifest
  -d, --display-name TEXT         name for display purposes
  -a, --author TEXT               module author
  -e, --email TEXT                authors email
  -A, --architecture TEXT         module compiled on i386/x86_64 arch
  -D, --description TEXT          short description
  -h, --homepage TEXT             module homepage
  -l, --license TEXT              license
  -c, --cmdargs TEXT              module command line arguments
  -r, --redis-min-version TEXT    redis minimum version
  -R, --redis-pack-min-version TEXT
                                  redis pack minimum version
  -cc, --config-command TEXT      command to configure module at run time

  -O, --os TEXT                   build target OS (Darwin/Linux)
  -C, --capabilities TEXT         comma seperated list of module capabilities
  --help                          Show this message and exit.

Module Capabilities

Following is a list of capabilities which can be specified for a module

capability description
types module has its own types and not only operate on existing redis types
no_multi_key module has no methods that operate on multiple keys
replica_of module can work with replicaof capability when it is loaded into a source or a destination database
backup_restore module can work with import/export capability
eviction_expiry module is able to handle eviction and expiry without an issue
reshard_rebalance module is able to operate in a database that is resharded and rebalanced
failover_migrate module is able to operate in a database that is failing over and migrating
persistence_aof module is able to operate in a database when database chooses AOF persistence option
persistence_rdb module is able to operate in a database when database chooses SNAPSHOT persistence option
hash_policy module is able to operate in a database with a user defined HASH POLICY
flash module is able to operate in a database with Flash memory is enabled or changed over time
crdb module is able to operate in a database with crdt for the default redis data types
clustering module is able to operate in a database that is sharded and shards can be migrated
intershard_tls module supports two-way encrypted communication between shards

Output

ramp pack generates module.zip

Which contains:

1. RedisModule.so - original module
2. Module.json - module's metadata

Test

Make sure redis-server is on your PATH

export PATH=$PATH:<PATH_TO_REDIS>

Install RAMP

python setup.py install

Compile RedisGraph for your OS v1.0.12 (https://github.com/RedisLabsModules/RedisGraph/tree/v1.0.12)

Copy redisgraph.so in test_module directory in the root of this project.

Run tests

python test.py

Metadata

Release files for ramp-packer 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ramp-packer 2.2.0
File Size Uploaded Provenance Actions
ramp-packer-2.2.0.tar.gz 12.3 kB Without provenance Details for ramp-packer-2.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ramp-packer 2.2.0
File Interpreter ABI Platform Actions
ramp_packer-2.2.0-py2.py3-none-any.whl Python 3, Python 2 none any Details for ramp_packer-2.2.0-py2.py3-none-any.whl

Total release size: 26.7 kB

Release files / ramp-packer-2.2.0.tar.gz

Download URL ramp-packer-2.2.0.tar.gz
Size 12.3 kB
Tags Source
SHA-256 checksum
How to use checksums
a1b150414457d53f42c5aea593180397a2e4f3ea552d8b2015b5be092ec2cebf
BLAKE2b-256 checksum
How to use checksums
38d9d73d59bb0f780beff1a9b69cc8416d4f37d6e16e8bd80a2b81a976561ef0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.8 CPython/3.7.11 Linux/5.8.0-1039-azure

Release files / ramp_packer-2.2.0-py2.py3-none-any.whl

Download URL ramp_packer-2.2.0-py2.py3-none-any.whl
Size 14.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
7eb859a63de048033caea2119945f156a85ee8cb15411b02fc878a07e764aac9
BLAKE2b-256 checksum
How to use checksums
4b27c5cf3d401eeb60c63f35dee70e78bc4982748e91d2388834a1c1c45e4037
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.8 CPython/3.7.11 Linux/5.8.0-1039-azure

Security for ramp-packer 2.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page