Nortal Core CLI
Project description
Core CLI v0.11.10
Prerequisites
The following packages are used across python repositories. A global install of them all is highly recommended.
A running cluster from Local
Helm with
gateway
service port forwarded. Details on port forwarding below.
WSL
If running on Windows, you may need to install distutils
to install the service.
$ sudo apt-get install python3.10-distutils
Initial setup
$ invoke install-dev
Code Quality
Tests
invoke tests
invoke tests-coverage
Linting
invoke check-style
invoke isort
Running locally
Port forwarding
To access the gateway api locally, you will need to connect to the pod inside
the cluster using kubefwd
.
$ sudo kubefwd svc -n core -c ~/.kube/config
Neosctl
When running locally, if you do not manage your own virtual environments, you can use poetry to put you in a shell with access to the installed code.
$ poetry shell
Initialize profile
$ neosctl -p my-profile profile init
Initialising [default] profile.
Gateway API url [http://core-gateway.core-gateway:9000/api/gateway]: <http://gateway_api_url:port>
Registry API url [http://neos-registry.registry:80/api/registry]: <http://registry_api_url:port>
IAM API url [http://core-iam.core-iam:80/api/iam]: <http://iam_api_url:port>
Storage API url [http://core-storage.core-storage:9000/api/storage]: <http://storage_api_url:port>
Username: <username>
$ cat ~/.neosctl
To work with the same profile across multiple commands you can export the profile name as an environment variable.
$ neosctl -p my-profile product list
...
$ export NEOSCTL_PROFILE=my-profile
$ neosctl product list
Login
$ neosctl -p=<my-profile> auth login
Commands to work with data products
$ neosctl --help
$ neosctl product --help
$ neosctl metadata --help
To work with the same product across multiple commands you can export the product name as an environment variable.
$ neosctl product get my-data-product
...
$ export NEOSCTL_PRODUCT=my-data-product
$ neosctl product get
Generate docs
To generate docs in a markdown format, run the following command. The output DOCS.md file could be used to update the NEOS documentation site (docs.neosmesh.com).
pip install typer-cli
typer neosctl.cli utils docs --name neosctl --output DOCS.md
Releases
Release management is handled using bump2version
. The below commands will tag
a new release. This will also update the helm chart version, this should not be
manually changed.
$ invoke bump-patch
$ invoke bump-minor
$ invoke bump-major
> vX.Y.Z
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for neosctl-0.11.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b04f7601eefec07bb21cd20b2d19593003cee99677a109c7d1ad9b1aaab2a70a |
|
MD5 | 47372f18507c7336d22d8fd87d41661e |
|
BLAKE2b-256 | 73cb556872be2e20bdaa85f44056d3d8c2a5a6e36b19d8bf9e45f77c6eb53331 |