| Name | redisenv JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | |
| Summary | A tool for building redis test environments |
| upload_time | 2023-03-15 11:35:35 |
| maintainer | |
| docs_url | None |
| author | Redis OSS |
| requires_python | >=3.7,<4.0 |
| license | MIT |
| keywords |
redis
utility
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# redisenv
[](./LICENSE)
[](https://pypi.org/project/redisenv/)
redisenv is library that makes generating redis test environments easier. This tool generates [docker-compose](https://docs.docker.com/compose/) files, and runs all instances within docker. Generated docker instances select a random port, based on the available free ports, and when running ```redisenv ports```, a JSON parse-able string of the build connections is outputted.
Currently redisenv supports:
* Redis standalone
* Redis Sentinel
* Redis Clusters
* Redis masters with replicas
* Redis Enterprise Clusters
Note: These require ports 8443, 9443, and can pick a random port per database. As a result, these two ports must be free in order to start a cluster. This is a temporary limitation, for now.
Note: Today Redis Standalone supports redis-stack, but nothing else does
----
## Installation
### Requirements
* Python >= 3.7
* docker-compose
* docker
```bash
pip install redisenv
```
## Usage
List options. Note, each sub command accepts its own ```--help```
```bash
redisenv --help
```
Start an environment named foo, with one container:
```bash
redisenv --name foo standalone create --nodes 1
```
Start an environment with the redisbloom module, downloaded into a folder named modules. Note - you need the full *local* path to the directory.
```bash
redisenv --name foo standalone create -n 1 -M `pwd`/modules /modules -o "--loadmodule /modules/redisbloom.so"
```
Destroy the environment named foo:
```bash
redisenv --name foo destroy
```
Raw data
{
"_id": null,
"home_page": "",
"name": "redisenv",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "Redis utility",
"author": "Redis OSS",
"author_email": "oss@redis.io",
"download_url": "https://files.pythonhosted.org/packages/0c/21/915197f059bff93bf2415b8d45a081d331480501c3c17d6f3d169637cbe5/redisenv-0.3.1.tar.gz",
"platform": null,
"description": "# redisenv\n\n[](./LICENSE)\n[](https://pypi.org/project/redisenv/)\n\nredisenv is library that makes generating redis test environments easier. This tool generates [docker-compose](https://docs.docker.com/compose/) files, and runs all instances within docker. Generated docker instances select a random port, based on the available free ports, and when running ```redisenv ports```, a JSON parse-able string of the build connections is outputted.\n\nCurrently redisenv supports:\n\n* Redis standalone\n\n* Redis Sentinel\n\n* Redis Clusters\n\n* Redis masters with replicas\n\n* Redis Enterprise Clusters\n\n Note: These require ports 8443, 9443, and can pick a random port per database. As a result, these two ports must be free in order to start a cluster. This is a temporary limitation, for now.\n\nNote: Today Redis Standalone supports redis-stack, but nothing else does\n\n----\n\n## Installation\n\n### Requirements\n\n* Python >= 3.7\n\n* docker-compose\n\n* docker\n\n```bash\npip install redisenv\n```\n\n## Usage\n\nList options. Note, each sub command accepts its own ```--help```\n\n```bash\nredisenv --help\n```\n\nStart an environment named foo, with one container:\n\n```bash\nredisenv --name foo standalone create --nodes 1\n```\n\nStart an environment with the redisbloom module, downloaded into a folder named modules. Note - you need the full *local* path to the directory.\n\n```bash\nredisenv --name foo standalone create -n 1 -M `pwd`/modules /modules -o \"--loadmodule /modules/redisbloom.so\"\n```\n\nDestroy the environment named foo:\n\n```bash\nredisenv --name foo destroy\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool for building redis test environments",
"version": "0.3.1",
"split_keywords": [
"redis",
"utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "22b293766d6c2194522856ce47f20dc6b654ff5314ff7abe3bd6a4182d9fd725",
"md5": "d50357d5cdfa8a62f6df92bdee455e85",
"sha256": "b149e2bb0bc69a45b73d33edf26047d34dc78c93aec8eccda2042e6f7f595ada"
},
"downloads": -1,
"filename": "redisenv-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d50357d5cdfa8a62f6df92bdee455e85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 18263,
"upload_time": "2023-03-15T11:35:34",
"upload_time_iso_8601": "2023-03-15T11:35:34.040556Z",
"url": "https://files.pythonhosted.org/packages/22/b2/93766d6c2194522856ce47f20dc6b654ff5314ff7abe3bd6a4182d9fd725/redisenv-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c21915197f059bff93bf2415b8d45a081d331480501c3c17d6f3d169637cbe5",
"md5": "75ce3151129cfbdf9c00ac06ab2748bf",
"sha256": "11cccdd010e163fb59edb6eae905d39a21cc4688a562eff9298f3d0c54b959bf"
},
"downloads": -1,
"filename": "redisenv-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "75ce3151129cfbdf9c00ac06ab2748bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 11249,
"upload_time": "2023-03-15T11:35:35",
"upload_time_iso_8601": "2023-03-15T11:35:35.715754Z",
"url": "https://files.pythonhosted.org/packages/0c/21/915197f059bff93bf2415b8d45a081d331480501c3c17d6f3d169637cbe5/redisenv-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-15 11:35:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "redisenv"
}
