OSDU Command Line Interface
===========================
Command-line interface for interacting with OSDU.
Usage
=====
The first time you use the CLI you should run the configure command to provide connection information and other important configuration.
.. code-block:: bash
osdu config update
Once configured use the CLI as shown below. Omitting a command will display a list of available options.
.. code-block:: bash
osdu <command>
For more information, specify the `-h` flag:
.. code-block:: bash
osdu -h
osdu <command> -h
Change Log
==========
0.0.38
------
- msal non interactive auth added
- updated imported packages
- Support python 3.11, drop support for python 3.8
0.0.37
------
- fix for crash when workflow status result didn't contain an endTimeStamp
- fix dataload ingest --batch option should work as flag and with specified batch size
0.0.36
------
- Added entitlements members groups command
0.0.35
------
- Split storage get to storage list (for id's) and storage get (for records)
- storage get --id option added
0.0.34
------
- Bump sdk version to 0.0.12
- Added legal add and delete commands
- Fix entitlements add group error
- Add description option to entitlements add group
0.0.33
------
- fix storage delete returns 204 error when deleted successfully
0.0.32
------
- dataload ingest added options for passing legal tags and acl
- correct CRS Converter Service naming
0.0.31
------
- Added update check when running 'osdu' or 'osdu version'
0.0.30
------
- API documentation pages are shown in info commands
- workflow get, runs and status commands
0.0.29
------
- storage commands
0.0.28
------
- search kind command
- search id supports limit
- search query supports a specific query
- global query option renamed to filter
0.0.27
------
- file download and info commands
0.0.26
------
- crs transforms command
0.0.25
------
- test against python 3.10 in addition to 3.8, 3.9
- crs commands
0.0.24
------
- checkrefs authority, acl and legal parameters for generated files
0.0.23
------
- osdu version shows service versions
- added info subcommand to entitlements, legal, schema, search, unit, workflow.
0.0.22
------
- search query supports limit
0.0.21
------
- dataload verify supports reference-data {{NAMESPACE}} replacement
0.0.20
------
- dataload support sequence file for ordered loading (ref. standard reference-data)
0.0.19
------
- schema add --overwrite-existing option
- merge dataload checkrefs code (wip)
- user friendly output mode
- improved dataload helper text
- support for python 3.10
0.0.18
------
- split global options in help text for clarity
- search table output fields changed
0.0.17
------
- change osducli references to osdu
0.0.16
------
- fix ingestion batch sizes
0.0.15
------
- *entitlements members add* - added role option
- *entitlements members remove* command added
0.0.14
------
- callable as osdu instead of osducli
- search query & search id commands
- dataload ingest --skip-existing option
- Add legal service and list tags
0.0.13
------
- workflow register / unregister commands
- dataload ingest - wait and simulate options
0.0.12
------
- Fix config permissions
0.0.11
------
- schema commands
- dataload batching imporvements
0.0.10
------
- refeactor code to use click instead of knack
0.0.9
-----
- entitlements commands
0.0.8
-----
- use osdu-sdk 0.0.2
0.0.7
-----
- Uses osdu-sdk for backend code
0.0.6
-----
- Refactor of connection code
0.0.3
-----
- Bulk upload commands (file upload still missing)
- Interactive login
- Config improvements
- Additional testing
0.0.2
-----
- Cleanup and diverse fixes
0.0.1
-----
- Initial release.
Raw data
{
"_id": null,
"home_page": "https://community.opengroup.org/osdu/platform/data-flow/data-loading/osdu-cli",
"name": "osducli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "osdu",
"author": "Equinor ASA",
"author_email": "mhew@equinor.com",
"download_url": "https://files.pythonhosted.org/packages/86/ca/7ab65168de5a6c1260d1a9cb6edf66eeb4e3ea2d32fcbbd2f6c5c56ae60a/osducli-0.0.38.tar.gz",
"platform": null,
"description": "OSDU Command Line Interface\n===========================\n\nCommand-line interface for interacting with OSDU.\n\nUsage\n=====\n\nThe first time you use the CLI you should run the configure command to provide connection information and other important configuration.\n\n.. code-block:: bash\n\n osdu config update\n\nOnce configured use the CLI as shown below. Omitting a command will display a list of available options.\n\n.. code-block:: bash\n\n osdu <command>\n\nFor more information, specify the `-h` flag:\n\n.. code-block:: bash\n\n osdu -h\n osdu <command> -h\n\nChange Log\n==========\n\n0.0.38\n------\n\n- msal non interactive auth added\n- updated imported packages\n- Support python 3.11, drop support for python 3.8\n\n0.0.37\n------\n\n- fix for crash when workflow status result didn't contain an endTimeStamp\n- fix dataload ingest --batch option should work as flag and with specified batch size\n\n0.0.36\n------\n\n- Added entitlements members groups command\n\n0.0.35\n------\n\n- Split storage get to storage list (for id's) and storage get (for records)\n- storage get --id option added\n\n0.0.34\n------\n\n- Bump sdk version to 0.0.12\n- Added legal add and delete commands\n- Fix entitlements add group error\n- Add description option to entitlements add group\n\n0.0.33\n------\n\n- fix storage delete returns 204 error when deleted successfully\n\n0.0.32\n------\n\n- dataload ingest added options for passing legal tags and acl\n- correct CRS Converter Service naming\n \n0.0.31\n------\n\n- Added update check when running 'osdu' or 'osdu version'\n\n0.0.30\n------\n\n- API documentation pages are shown in info commands\n- workflow get, runs and status commands\n\n0.0.29\n------\n\n- storage commands\n\n0.0.28\n------\n\n- search kind command\n- search id supports limit\n- search query supports a specific query\n- global query option renamed to filter\n\n0.0.27\n------\n\n- file download and info commands\n \n0.0.26\n------\n\n- crs transforms command\n\n0.0.25\n------\n\n- test against python 3.10 in addition to 3.8, 3.9\n- crs commands\n\n0.0.24\n------\n\n- checkrefs authority, acl and legal parameters for generated files\n\n0.0.23\n------\n\n- osdu version shows service versions\n- added info subcommand to entitlements, legal, schema, search, unit, workflow.\n\n0.0.22\n------\n\n- search query supports limit\n\n0.0.21\n------\n\n- dataload verify supports reference-data {{NAMESPACE}} replacement\n\n0.0.20\n------\n\n- dataload support sequence file for ordered loading (ref. standard reference-data)\n \n0.0.19\n------\n\n- schema add --overwrite-existing option\n- merge dataload checkrefs code (wip)\n- user friendly output mode\n- improved dataload helper text\n- support for python 3.10\n\n0.0.18\n------\n\n- split global options in help text for clarity\n- search table output fields changed\n\n0.0.17\n------\n\n- change osducli references to osdu\n\n0.0.16\n------\n\n- fix ingestion batch sizes\n \n0.0.15\n------\n\n- *entitlements members add* - added role option\n- *entitlements members remove* command added\n\n0.0.14\n------\n- callable as osdu instead of osducli\n- search query & search id commands\n- dataload ingest --skip-existing option\n- Add legal service and list tags\n \n0.0.13\n------\n\n- workflow register / unregister commands\n- dataload ingest - wait and simulate options\n\n0.0.12\n------\n\n- Fix config permissions\n\n0.0.11\n------\n\n- schema commands\n- dataload batching imporvements\n\n0.0.10\n------\n\n- refeactor code to use click instead of knack\n\n0.0.9\n-----\n\n- entitlements commands\n\n0.0.8\n-----\n\n- use osdu-sdk 0.0.2\n \n0.0.7\n-----\n\n- Uses osdu-sdk for backend code\n \n0.0.6\n-----\n\n- Refactor of connection code\n\n0.0.3\n-----\n\n- Bulk upload commands (file upload still missing)\n- Interactive login\n- Config improvements\n- Additional testing\n\n0.0.2\n-----\n\n- Cleanup and diverse fixes\n \n0.0.1\n-----\n\n- Initial release.\n\n\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "OSDU command line",
"version": "0.0.38",
"project_urls": {
"Homepage": "https://community.opengroup.org/osdu/platform/data-flow/data-loading/osdu-cli",
"Issue Tracker": "https://community.opengroup.org/osdu/platform/data-flow/data-loading/osdu-cli/-/issues"
},
"split_keywords": [
"osdu"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "750521cd6606655ab44027e58f12bb867c3011715f13dfcc05fcd59468d2da3a",
"md5": "bca7c765aa9c82e382560373765d5232",
"sha256": "2bc1d7fe96c08408c9279c5fdb5e23eae7ec7387e5b13ef9057b3a40df25e35d"
},
"downloads": -1,
"filename": "osducli-0.0.38-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bca7c765aa9c82e382560373765d5232",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 112830,
"upload_time": "2023-08-24T06:50:37",
"upload_time_iso_8601": "2023-08-24T06:50:37.187330Z",
"url": "https://files.pythonhosted.org/packages/75/05/21cd6606655ab44027e58f12bb867c3011715f13dfcc05fcd59468d2da3a/osducli-0.0.38-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86ca7ab65168de5a6c1260d1a9cb6edf66eeb4e3ea2d32fcbbd2f6c5c56ae60a",
"md5": "a419a5e8339e4bfa0eda362955dbbd8b",
"sha256": "7403ba0e17d5951076722da2bc8429234b7601890476db8ecda868f38c7e90a9"
},
"downloads": -1,
"filename": "osducli-0.0.38.tar.gz",
"has_sig": false,
"md5_digest": "a419a5e8339e4bfa0eda362955dbbd8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 53643,
"upload_time": "2023-08-24T06:50:38",
"upload_time_iso_8601": "2023-08-24T06:50:38.578991Z",
"url": "https://files.pythonhosted.org/packages/86/ca/7ab65168de5a6c1260d1a9cb6edf66eeb4e3ea2d32fcbbd2f6c5c56ae60a/osducli-0.0.38.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-24 06:50:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "osducli"
}
JSON