Skip to content

Commit

Permalink
add readme , prepare for packaged version
Browse files Browse the repository at this point in the history
  • Loading branch information
gr0vity committed May 9, 2023
1 parent 221c69c commit 7bb4833
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
_manage/**
.vscode/
build/
resources/
Expand Down
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
##NanoLab

NanoLab is an easy-to-use testing tool designed to run test cases against a local network of nano-nodes. It utilizes [NanoMock](https://github.com/gr0vity-dev/nanomock), a highly customizable tool for creating dockerized nano networks, to facilitate quick and efficient testing of various configurations. Simply provide a config file for the test case and watch NanoLab streamline your testing process.

###Features:

- Run test cases against a local network of nano-nodes
- Leverages NanoMock for dockerized nano network creation
- Simple configuration with JSON
- Compatible with Python 3.8+ and Docker

###How to install:
`pip install nanolab`

###How to use:
|Command| Description
|----|----|
| `nanolab list`| List all available testcases
| `nanolab run -t {testcase}` | execute a testcase


###How to use with options:

|Command| flag |
|----|----|
| `-t --test-case` | Use one of the available testcases (`nanolab list`)
| | Can be a `/path/to/config.json` on your disk
| `--gh-user --gh-repo --gh-path` | Default : [gr0vity-dev nanolab-configs default](https://github.com/gr0vity-dev/nanolab-configs/tree/main/default)
| | Used in `nanolab list` to show available testcases
| | Used in `nanolab run` to download the selected testcase
| `-i --image` | List of docker images used per testrun
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
long_description = fh.read()

setup(name="nanolab",
version="0.0.6",
version="0.0.1",
author="gr0vity",
description="testing tool using nanomock",
long_description=long_description,
Expand Down

0 comments on commit 7bb4833

Please sign in to comment.