SingularityNET CLI

These instructions are for the development and use of the SingularityNET CLI. For further details, please check our full Documentation.

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:

sudo apt-get install libudev-dev libusb-1.0-0-dev

$ pip3 install snet-cli

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

sudo apt install python-argcomplete

After the package is installed, activate autocomplete

sudo activate-global-python-argcomplete

Note: Changes will not take effect until shell is restarted.

echo 'eval "$(register-python-argcomplete snet)"' >> ~/.bashrc

then

source ~/.bashrc

Complete documentation is available here

• Python 3.6.5
• Node 8+ w/npm

• Clone the git repository

$ git clone [email protected]:singnet/snet-cli.git
$ cd snet-cli

• Install development/test blockchain dependencies

$ ./scripts/blockchain install

• Install the package in development/editable mode

$ pip3 install -e .

• Install sphinx, sphinx-argparse and the rtd theme

$ pip install sphinx
$ pip install sphinx-argparse
$ pip install sphinx-rtd-theme

• Run the build-docs.sh in the docs directory

$ cd docs
$ sh build-docs.sh

The documentation is generated under the docs/build/html folder

This project is published to PyPI.

We use SemVer for versioning. For the versions available, see the tags on this repository.

This project is licensed under the MIT License - see the LICENSE file for details.