-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moved block_offset to payment channel strategy from config as an
optional parameter Added call allowance to payment channel strategy as an optional parameter Split .gitignore to have a top level one and separate ones for each package Same for LICENSE Updated CLI README, added top-level README (sdk-specific is still in progress)
- Loading branch information
1 parent
707cf21
commit c25c09a
Showing
8 changed files
with
176 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,3 @@ | ||
blockchain/node_modules/ | ||
__pycache__/ | ||
|
||
snet_cli/venv/ | ||
.idea/ | ||
snet_cli/snet_cli.egg-info/ | ||
snet_cli/snet_cli/resources/contracts/abi | ||
snet_cli/snet_cli/resources/contracts/networks | ||
snet_cli/snet_cli/resources/proto/*.py | ||
snet_cli/build/ | ||
snet_cli/dist/ | ||
|
||
snet_sdk/venv/ | ||
snet_sdk/snet_sdk.egg-info/ | ||
__pycache__ | ||
snet_sdk/snet_sdk/resources/contracts/abi | ||
snet_sdk/snet_sdk/resources/contracts/networks | ||
snet_sdk/build/ | ||
snet_sdk/dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,124 +1,18 @@ | ||
# snet-cli | ||
# snet-python-monorepo | ||
|
||
[![CircleCI](https://circleci.com/gh/singnet/snet-cli.svg?style=svg)](https://circleci.com/gh/singnet/snet-cli) | ||
|
||
SingularityNET CLI | ||
SingularityNET Python Monorepo | ||
|
||
## Getting Started | ||
## Packages | ||
This repository is a monorepo that includes several packages that we publish to PyPI from a shared codebase, specifically: | ||
|
||
These instructions are for the development and use of the SingularityNET CLI. | ||
For further details, please check our full [Documentation](http://snet-cli-docs.singularitynet.io/). | ||
|Package |Description | | ||
|----------------------------------------------|---------------------------------------------------------------------| | ||
|[snet-cli](https://pypi.org/project/snet-cli/)|Command line interface to interact with the SingularityNET platform | | ||
|[snet-sdk](https://pypi.org/project/snet-sdk/)|Integrate SingularityNET services seamlessly into Python applications| | ||
|
||
### Installing with pip | ||
|
||
#### Install prerequisites | ||
|
||
You should have python with version >= 3.6.5 and pip installed. | ||
|
||
Additionally you should install the following packages: | ||
|
||
* libudev | ||
* libusb 1.0 | ||
|
||
If you use Ubuntu (or any Linux distribution with APT package support) you should do the following: | ||
|
||
```bash | ||
sudo apt-get install libudev-dev libusb-1.0-0-dev | ||
``` | ||
|
||
#### Install snet-cli using pip | ||
|
||
```bash | ||
$ pip3 install snet-cli | ||
``` | ||
|
||
|
||
#### Enabling commands autocomplete | ||
If you want to enable auto completion of commands, you should install the following package | ||
* python-argcomplete | ||
|
||
On ubuntu (or any Linux distribution with APT package support), you should do the following | ||
|
||
```bash | ||
sudo apt install python-argcomplete | ||
``` | ||
After the package is installed, activate autocomplete | ||
|
||
##### for all python commands (which includes snet commands as well) | ||
|
||
```bash | ||
sudo activate-global-python-argcomplete | ||
``` | ||
Note: Changes will not take effect until shell is restarted. | ||
|
||
##### only for snet commands, then you should do the following | ||
```bash | ||
echo 'eval "$(register-python-argcomplete snet)"' >> ~/.bashrc | ||
``` | ||
then | ||
```bash | ||
source ~/.bashrc | ||
``` | ||
|
||
## Commands | ||
|
||
Complete documentation is available [here](http://snet-cli-docs.singularitynet.io/) | ||
|
||
|
||
## Development | ||
|
||
### Installing | ||
|
||
#### Prerequisites | ||
|
||
* [Python 3.6.5](https://www.python.org/downloads/release/python-365/) | ||
* [Node 8+ w/npm](https://nodejs.org/en/download/) | ||
|
||
--- | ||
|
||
* Clone the git repository | ||
```bash | ||
$ git clone [email protected]:singnet/snet-cli.git | ||
$ cd snet-cli | ||
``` | ||
|
||
* Install development/test blockchain dependencies | ||
```bash | ||
$ ./scripts/blockchain install | ||
``` | ||
|
||
* Install the package in development/editable mode | ||
```bash | ||
$ pip3 install -e . | ||
``` | ||
|
||
#### Building Docs | ||
|
||
* Install sphinx, sphinx-argparse and the rtd theme | ||
```bash | ||
$ pip install sphinx | ||
$ pip install sphinx-argparse | ||
$ pip install sphinx-rtd-theme | ||
``` | ||
|
||
* Run the build-docs.sh in the docs directory | ||
```bash | ||
$ cd docs | ||
$ sh build-docs.sh | ||
``` | ||
|
||
The documentation is generated under the docs/build/html folder | ||
|
||
### Release | ||
|
||
This project is published to [PyPI](https://pypi.org/project/snet-cli/). | ||
|
||
### Versioning | ||
|
||
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the | ||
[tags on this repository](https://github.com/singnet/snet-cli/tags). | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the | ||
[LICENSE](https://github.com/singnet/alpha-daemon/blob/master/LICENSE) file for details. | ||
[LICENSE](https://github.com/singnet/snet-cli/blob/master/LICENSE) file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
venv/ | ||
snet_cli.egg-info/ | ||
snet_cli/resources/contracts/abi | ||
snet_cli/resources/contracts/networks | ||
snet_cli/resources/proto/*.py | ||
build/ | ||
dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 SingularityNET | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# snet-cli | ||
|
||
[![CircleCI](https://circleci.com/gh/singnet/snet-cli.svg?style=svg)](https://circleci.com/gh/singnet/snet-cli) | ||
|
||
SingularityNET CLI | ||
|
||
## Getting Started | ||
|
||
These instructions are for the development and use of the SingularityNET CLI. | ||
For further details, please check our full [Documentation](http://snet-cli-docs.singularitynet.io/). | ||
|
||
### Installing with pip | ||
|
||
#### Install prerequisites | ||
|
||
You should have python with version >= 3.6.5 and pip installed. | ||
|
||
Additionally you should install the following packages: | ||
|
||
* libudev | ||
* libusb 1.0 | ||
|
||
If you use Ubuntu (or any Linux distribution with APT package support) you should do the following: | ||
|
||
```bash | ||
sudo apt-get install libudev-dev libusb-1.0-0-dev | ||
``` | ||
|
||
#### Install snet-cli using pip | ||
|
||
```bash | ||
$ pip3 install snet-cli | ||
``` | ||
|
||
|
||
#### Enabling commands autocomplete | ||
If you want to enable auto completion of commands, you should install the following package | ||
* python-argcomplete | ||
|
||
On ubuntu (or any Linux distribution with APT package support), you should do the following | ||
|
||
```bash | ||
sudo apt install python-argcomplete | ||
``` | ||
After the package is installed, activate autocomplete | ||
|
||
##### for all python commands (which includes snet commands as well) | ||
|
||
```bash | ||
sudo activate-global-python-argcomplete | ||
``` | ||
Note: Changes will not take effect until shell is restarted. | ||
|
||
##### only for snet commands, then you should do the following | ||
```bash | ||
echo 'eval "$(register-python-argcomplete snet)"' >> ~/.bashrc | ||
``` | ||
then | ||
```bash | ||
source ~/.bashrc | ||
``` | ||
|
||
## Commands | ||
|
||
Complete documentation is available [here](http://snet-cli-docs.singularitynet.io/) | ||
|
||
|
||
## Development | ||
|
||
### Installing | ||
|
||
#### Prerequisites | ||
|
||
* [Python 3.6.5](https://www.python.org/downloads/release/python-365/) | ||
* [Node 8+ w/npm](https://nodejs.org/en/download/) | ||
|
||
--- | ||
|
||
* Clone the git repository | ||
```bash | ||
$ git clone [email protected]:singnet/snet-cli.git | ||
$ cd snet-cli/snet-cli | ||
``` | ||
|
||
* Install development/test blockchain dependencies | ||
```bash | ||
$ ./scripts/blockchain install | ||
``` | ||
|
||
* Install the package in development/editable mode | ||
```bash | ||
$ pip3 install -e . | ||
``` | ||
|
||
#### Building Docs | ||
|
||
* Install sphinx, sphinx-argparse and the rtd theme | ||
```bash | ||
$ pip install sphinx | ||
$ pip install sphinx-argparse | ||
$ pip install sphinx-rtd-theme | ||
``` | ||
|
||
* Run the build-docs.sh in the docs directory | ||
```bash | ||
$ cd docs | ||
$ sh build-docs.sh | ||
``` | ||
|
||
The documentation is generated under the docs/build/html folder | ||
|
||
### Release | ||
|
||
This project is published to [PyPI](https://pypi.org/project/snet-cli/). | ||
|
||
### Versioning | ||
|
||
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the | ||
[tags on this repository](https://github.com/singnet/snet-cli/tags). | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the | ||
[LICENSE](https://github.com/singnet/alpha-daemon/blob/master/LICENSE) file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
venv/ | ||
snet_sdk.egg-info/ | ||
snet_sdk/resources/contracts/abi | ||
snet_sdk/resources/contracts/networks | ||
build/ | ||
dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters