| Name | vws-cli JSON |
| Version |
2024.10.6
JSON |
| download |
| home_page | None |
| Summary | A CLI for the Vuforia Web Services (VWS) API. |
| upload_time | 2024-10-06 19:21:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2019 Adam Dangoor 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. |
| keywords |
cli
vuforia
vws
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|Build Status| |codecov| |PyPI| |Documentation Status|
vws-cli
=======
A CLI for `Vuforia Web Services`_.
.. _Vuforia Web Services: https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api
.. contents::
:local:
Installation
------------
With `pip`
^^^^^^^^^^
Requires Python |minimum-python-version|\+.
.. code-block:: shell
pip install VWS-CLI
With Homebrew (macOS, Linux, WSL)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Requires `Homebrew`_.
.. code-block:: shell
brew tap VWS-Python/vws
brew install vws-cli
.. _Homebrew: https://docs.brew.sh/Installation
Pre-built Linux binaries
^^^^^^^^^^^^^^^^^^^^^^^^
See the `full documentation`_ for details on how to install pre-built Linux binaries.
.. _full documentation: https://vws-cli.readthedocs.io/en/latest/install.html#pre-built-linux-binaries
Usage example
-------------
.. skip doccmd[shellcheck]: next
.. code-block:: console
$ vws add-target \
--server-access-key "$SERVER_ACCESS_KEY" \
--server-secret-key "$SERVER_SECRET_KEY" \
--name my_image_name \
--width 2 \
--image ~/Documents/my_image.png \
--application-metadata "$(echo 'my_metadata' | base64)" \
--active-flag true
03b99df0-78cf-4b01-b929-f1860d4f8ed1
$ vws --help
...
$ vuforia-cloud-reco my_image.jpg \
--max-num-results 5 \
--include-target-data none
- target_id: b60f60121d37418eb1de123c381b2af9
- target_id: e3a6e1a216ad4df3aaae1f6dd309c800
$
Full documentation
------------------
See the `full documentation <https://vws-cli.readthedocs.io/en/latest>`__ for information on:
* All available commands.
* Setting up autocompletion.
* How to contribute to this project.
* Release notes.
.. |Build Status| image:: https://github.com/VWS-Python/vws-cli/actions/workflows/ci.yml/badge.svg?branch=main
:target: https://github.com/VWS-Python/vws-cli/actions
.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-cli/branch/main/graph/badge.svg
:target: https://codecov.io/gh/VWS-Python/vws-cli
.. |Documentation Status| image:: https://readthedocs.org/projects/vws-cli/badge/?version=latest
:target: https://vws-cli.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |PyPI| image:: https://badge.fury.io/py/VWS-CLI.svg
:target: https://badge.fury.io/py/VWS-CLI
.. |minimum-python-version| replace:: 3.12
Raw data
{
"_id": null,
"home_page": null,
"name": "vws-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "cli, vuforia, vws",
"author": null,
"author_email": "Adam Dangoor <adamdangoor@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/87/0f/0706effcf89202d520395e0426f6efdce580bdb46be827d12b19f7747777/vws_cli-2024.10.6.tar.gz",
"platform": null,
"description": "|Build Status| |codecov| |PyPI| |Documentation Status|\n\nvws-cli\n=======\n\nA CLI for `Vuforia Web Services`_.\n\n.. _Vuforia Web Services: https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api\n\n.. contents::\n :local:\n\nInstallation\n------------\n\nWith `pip`\n^^^^^^^^^^\n\nRequires Python |minimum-python-version|\\+.\n\n.. code-block:: shell\n\n pip install VWS-CLI\n\nWith Homebrew (macOS, Linux, WSL)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nRequires `Homebrew`_.\n\n.. code-block:: shell\n\n brew tap VWS-Python/vws\n brew install vws-cli\n\n.. _Homebrew: https://docs.brew.sh/Installation\n\nPre-built Linux binaries\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nSee the `full documentation`_ for details on how to install pre-built Linux binaries.\n\n.. _full documentation: https://vws-cli.readthedocs.io/en/latest/install.html#pre-built-linux-binaries\n\nUsage example\n-------------\n\n.. skip doccmd[shellcheck]: next\n\n.. code-block:: console\n\n $ vws add-target \\\n --server-access-key \"$SERVER_ACCESS_KEY\" \\\n --server-secret-key \"$SERVER_SECRET_KEY\" \\\n --name my_image_name \\\n --width 2 \\\n --image ~/Documents/my_image.png \\\n --application-metadata \"$(echo 'my_metadata' | base64)\" \\\n --active-flag true\n 03b99df0-78cf-4b01-b929-f1860d4f8ed1\n $ vws --help\n ...\n $ vuforia-cloud-reco my_image.jpg \\\n --max-num-results 5 \\\n --include-target-data none\n - target_id: b60f60121d37418eb1de123c381b2af9\n - target_id: e3a6e1a216ad4df3aaae1f6dd309c800\n $\n\nFull documentation\n------------------\n\nSee the `full documentation <https://vws-cli.readthedocs.io/en/latest>`__ for information on:\n\n* All available commands.\n* Setting up autocompletion.\n* How to contribute to this project.\n* Release notes.\n\n.. |Build Status| image:: https://github.com/VWS-Python/vws-cli/actions/workflows/ci.yml/badge.svg?branch=main\n :target: https://github.com/VWS-Python/vws-cli/actions\n.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-cli/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/VWS-Python/vws-cli\n.. |Documentation Status| image:: https://readthedocs.org/projects/vws-cli/badge/?version=latest\n :target: https://vws-cli.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. |PyPI| image:: https://badge.fury.io/py/VWS-CLI.svg\n :target: https://badge.fury.io/py/VWS-CLI\n.. |minimum-python-version| replace:: 3.12\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019 Adam Dangoor 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. ",
"summary": "A CLI for the Vuforia Web Services (VWS) API.",
"version": "2024.10.6",
"project_urls": {
"Source": "https://github.com/VWS-Python/vws-cli"
},
"split_keywords": [
"cli",
" vuforia",
" vws"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7d1d8a189e775e5824b242488cbaab3d4290c40a223b8674ff4b2a0666fabbf3",
"md5": "81ff7a85c273ba9efae31c7f8ddff0dc",
"sha256": "8eb2dda7f94e2662baeb388efd82ae06d0a85451c2b9dfdd9cc966180ebf2e03"
},
"downloads": -1,
"filename": "vws_cli-2024.10.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81ff7a85c273ba9efae31c7f8ddff0dc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 12922,
"upload_time": "2024-10-06T19:21:08",
"upload_time_iso_8601": "2024-10-06T19:21:08.064472Z",
"url": "https://files.pythonhosted.org/packages/7d/1d/8a189e775e5824b242488cbaab3d4290c40a223b8674ff4b2a0666fabbf3/vws_cli-2024.10.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "870f0706effcf89202d520395e0426f6efdce580bdb46be827d12b19f7747777",
"md5": "9f14dcce511ebf3ad092dbac46b7787d",
"sha256": "253aff521588cfc08de30e765eb4204f1454b35a1e3c9530faeddea1137bbeb5"
},
"downloads": -1,
"filename": "vws_cli-2024.10.6.tar.gz",
"has_sig": false,
"md5_digest": "9f14dcce511ebf3ad092dbac46b7787d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 38643,
"upload_time": "2024-10-06T19:21:09",
"upload_time_iso_8601": "2024-10-06T19:21:09.905236Z",
"url": "https://files.pythonhosted.org/packages/87/0f/0706effcf89202d520395e0426f6efdce580bdb46be827d12b19f7747777/vws_cli-2024.10.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-06 19:21:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VWS-Python",
"github_project": "vws-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vws-cli"
}
