A command line interface for Opine
Project description
OPINE CLI
What is this repository for?
This is a command line interface (CLI) for Opine.
How do I get set up?
You can install opine-cli
as a python package using pip
.
-
Installing from the PyPI package index:
python -m pip install opine-cli
-
Install from the zipped distribution package:
python -m pip install <path/to/opine-cli-version.tar.gz>
Uninstall opine-cli
Run the command python -m pip uninstall opine-cli
Using opine-cli
First ensure that you have installed the opine-cli
package.
A few commands to get started with.
Initialize the cli
opine init
: Initialize the cli.- This command uses the default opine api endpoint
https://api.opine.world
. - You can also specify an endpoint to use:
opine init https://my_other_endpoint.opine. world
- The init command also requests your user name and password to log you into Opine.
- This command uses the default opine api endpoint
opine auth login
: To login explicitly.opine auth revoke
: To logout and remove all user credentials.
Accessing projects
opine projects list
: Get a list of projects. You can use the--output=FORMAT
flag to display the list in JSON format or as a table.opine projects list --output=json
: Format the results as json. This is the default.opine projects list --output=table
: Display the results as a table.
opine projects describe PROJECT-ID
: Get details of a project.opine config set project_id PROJECT-ID
: Set the default project to query in the configuration file.opine projects describe
: If a PROJECT-ID is set in the config, then it can be omitted in the query above. In the documentation, use[]
to indicate such optional attributes
opine projects stats [PROJECT-ID]
: Get projects statistics: number of forms, variable, data records and data values.opine projects stats [PROJECT-ID]
: Get projects statistics: number of forms, variable, data records and data values.
I need help. Who do I talk to?
- The Opine development team.
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
opine-cli-0.2.1.tar.gz
(6.2 kB
view details)
Built Distribution
opine_cli-0.2.1-py3-none-any.whl
(10.2 kB
view details)
File details
Details for the file opine-cli-0.2.1.tar.gz
.
File metadata
- Download URL: opine-cli-0.2.1.tar.gz
- Upload date:
- Size: 6.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
3b3a000ad261dedcd95affe4db0f71762740da861257867f9955565ccc6c06c6
|
|
MD5 |
d07c56974dfd9fdfd3d24917c0c275bc
|
|
BLAKE2b-256 |
25c3c0a532b4e1fd684bc24e222dd6588b8a00d99f5b835512f60913c5b073ed
|
File details
Details for the file opine_cli-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: opine_cli-0.2.1-py3-none-any.whl
- Upload date:
- Size: 10.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
e0d6f505e56908e3c4bb75b92842f81cb015b2c3d8eae78186eb3c35a9fe09c8
|
|
MD5 |
f93113bd2a5618c958ccbfbcc7ffdaf6
|
|
BLAKE2b-256 |
197b87c127d56446a6b8c2cd02edd1ec00d0a27b10ce9ea0b672a934619ed561
|