| Name | ovh-cli-yma JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | An ovh command line tool |
| upload_time | 2024-03-12 01:56:07 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
ovh
api
cli
tool
wrapper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
ovh-cli
=======
An Ovh command line interface to allow easy interaction with the Ovh Api
Usage
-----
Run the ``ovh-cli`` command to see the usage and the available commands.
Currently only a very small sub-set of Ovh's Api are available.
Configuration Quick Steps
-------------------------
1. Create an Ovh application
****************************
Create an Ovh Application to get the ``application_key`` and the ``application_secret`` (`create-an-application <https://github.com/ovh/python-ovh?tab=readme-ov-file#1-create-an-application>`_).
- `OVH Europe <https://eu.api.ovh.com/createApp/>`_
- `OVH US <https://api.us.ovhcloud.com/createApp/>`_
- `OVH North-America <https://ca.api.ovh.com/createApp/>`_
- `So you Start Europe <https://eu.api.soyoustart.com/createApp/>`_
- `So you Start North America <https://ca.api.soyoustart.com/createApp/>`_
- `Kimsufi Europe <https://eu.api.kimsufi.com/createApp/>`_
- `Kimsufi North America <https://ca.api.kimsufi.com/createApp/>`_
2. Create the ``ovh.conf`` file
*******************************
In order to enable ``ovh-cli``, you need to create an ``ovh.conf`` file (`configure-your-application <https://github.com/ovh/python-ovh?tab=readme-ov-file#2-configure-your-application>`_).
.. code:: ini
[default]
endpoint=ovh-eu
[ovh-eu]
application_key=<value>
application_secret=<value>
consumer_key=<value>
Fill the ``endpoint`` param with one of these values:
* ``ovh-eu`` for OVH Europe API
* ``ovh-us`` for OVH US API
* ``ovh-ca`` for OVH North-America API
* ``soyoustart-eu`` for So you Start Europe API
* ``soyoustart-ca`` for So you Start North America API
* ``kimsufi-eu`` for Kimsufi Europe API
* ``kimsufi-ca`` for Kimsufi North America API
Fill the ``application_key`` and the ``application_secret`` params with the values got in the previous step.
The ``consumer_key`` can be fetch in the next step.
3. Authorize the Ovh application and get the ``consumer_key``
*************************************************************
Make sure the ``ovh.conf`` is properly configured with ``endpoint``, ``application_key`` and ``application_secret`` params.
Run
.. code-block:: sh
ovh-cli account register
and follow the instructions. At the end of the process, you'll get the ``consumer_key``.
Official documentation
----------------------
Enable the access to the Ovh Api: `First Steps with the OVHcloud APIs <https://help.ovhcloud.com/csm/en-gb-api-getting-started-ovhcloud-api?id=kb_article_view&sysparm_article=KB0042784>`_
Ovh Python Api wrapper documentation: `github.com/ovh/python-ovh <https://github.com/ovh/python-ovh>`_
Meta
----
Yusef Maali - contact@yusefmaali.net
Distributed under the MIT license. See `LICENSE.txt <https://github.com/yusefmaali/ovh-cli/blob/master/LICENSE.txt>`_ for more information.
https://github.com/yusefmaali/ovh-cli
Raw data
{
"_id": null,
"home_page": "",
"name": "ovh-cli-yma",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "ovh,api,cli,tool,wrapper",
"author": "",
"author_email": "Yusef Maali <contact@yusefmaali.net>",
"download_url": "https://files.pythonhosted.org/packages/ee/3a/5c20a69e94e867567860942c7099dabce62833e4914fbae24e0249b1594c/ovh-cli-yma-1.0.0.tar.gz",
"platform": null,
"description": "ovh-cli\n=======\n\nAn Ovh command line interface to allow easy interaction with the Ovh Api\n\n\nUsage\n-----\n\nRun the ``ovh-cli`` command to see the usage and the available commands.\n\nCurrently only a very small sub-set of Ovh's Api are available.\n\n\nConfiguration Quick Steps\n-------------------------\n\n1. Create an Ovh application\n****************************\n\nCreate an Ovh Application to get the ``application_key`` and the ``application_secret`` (`create-an-application <https://github.com/ovh/python-ovh?tab=readme-ov-file#1-create-an-application>`_).\n\n- `OVH Europe <https://eu.api.ovh.com/createApp/>`_\n- `OVH US <https://api.us.ovhcloud.com/createApp/>`_\n- `OVH North-America <https://ca.api.ovh.com/createApp/>`_\n- `So you Start Europe <https://eu.api.soyoustart.com/createApp/>`_\n- `So you Start North America <https://ca.api.soyoustart.com/createApp/>`_\n- `Kimsufi Europe <https://eu.api.kimsufi.com/createApp/>`_\n- `Kimsufi North America <https://ca.api.kimsufi.com/createApp/>`_\n\n2. Create the ``ovh.conf`` file\n*******************************\n\nIn order to enable ``ovh-cli``, you need to create an ``ovh.conf`` file (`configure-your-application <https://github.com/ovh/python-ovh?tab=readme-ov-file#2-configure-your-application>`_).\n\n.. code:: ini\n\n [default]\n endpoint=ovh-eu\n\n [ovh-eu]\n application_key=<value>\n application_secret=<value>\n consumer_key=<value>\n\nFill the ``endpoint`` param with one of these values:\n\n* ``ovh-eu`` for OVH Europe API\n* ``ovh-us`` for OVH US API\n* ``ovh-ca`` for OVH North-America API\n* ``soyoustart-eu`` for So you Start Europe API\n* ``soyoustart-ca`` for So you Start North America API\n* ``kimsufi-eu`` for Kimsufi Europe API\n* ``kimsufi-ca`` for Kimsufi North America API\n\nFill the ``application_key`` and the ``application_secret`` params with the values got in the previous step.\n\nThe ``consumer_key`` can be fetch in the next step.\n\n3. Authorize the Ovh application and get the ``consumer_key``\n*************************************************************\n\nMake sure the ``ovh.conf`` is properly configured with ``endpoint``, ``application_key`` and ``application_secret`` params.\n\nRun\n\n.. code-block:: sh\n\n ovh-cli account register\n\nand follow the instructions. At the end of the process, you'll get the ``consumer_key``.\n\n\nOfficial documentation\n----------------------\n\nEnable the access to the Ovh Api: `First Steps with the OVHcloud APIs <https://help.ovhcloud.com/csm/en-gb-api-getting-started-ovhcloud-api?id=kb_article_view&sysparm_article=KB0042784>`_\n\nOvh Python Api wrapper documentation: `github.com/ovh/python-ovh <https://github.com/ovh/python-ovh>`_\n\n\nMeta\n----\n\nYusef Maali - contact@yusefmaali.net\n\nDistributed under the MIT license. See `LICENSE.txt <https://github.com/yusefmaali/ovh-cli/blob/master/LICENSE.txt>`_ for more information.\n\nhttps://github.com/yusefmaali/ovh-cli\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An ovh command line tool",
"version": "1.0.0",
"project_urls": {
"changelog": "https://github.com/yusefmaali/ovh-cli/blob/master/CHANGELOG.rst",
"download": "https://github.com/yusefmaali/ovh-cli/tarball/1.0.0",
"homepage": "https://github.com/yusefmaali/ovh-cli",
"repository": "https://github.com/yusefmaali/ovh-cli"
},
"split_keywords": [
"ovh",
"api",
"cli",
"tool",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab3f53ea53d91c2b916cf2d123a7767aac16f435c1281172a95997803b2cb3f5",
"md5": "ae76a5022d34a1a1f7efe207e90b45e5",
"sha256": "51456cd019d86b52ed0ae0fef701675d23786d7a84fa006531381d3e9e2a0b23"
},
"downloads": -1,
"filename": "ovh_cli_yma-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae76a5022d34a1a1f7efe207e90b45e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8396,
"upload_time": "2024-03-12T01:56:05",
"upload_time_iso_8601": "2024-03-12T01:56:05.982131Z",
"url": "https://files.pythonhosted.org/packages/ab/3f/53ea53d91c2b916cf2d123a7767aac16f435c1281172a95997803b2cb3f5/ovh_cli_yma-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee3a5c20a69e94e867567860942c7099dabce62833e4914fbae24e0249b1594c",
"md5": "7d1b99b373aeead882742df0a459c6d4",
"sha256": "c9413d1672cdb4ca2cbf7acde54efd524fc48be0a652a2fb4d6aaafe40b646a8"
},
"downloads": -1,
"filename": "ovh-cli-yma-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7d1b99b373aeead882742df0a459c6d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6949,
"upload_time": "2024-03-12T01:56:07",
"upload_time_iso_8601": "2024-03-12T01:56:07.997783Z",
"url": "https://files.pythonhosted.org/packages/ee/3a/5c20a69e94e867567860942c7099dabce62833e4914fbae24e0249b1594c/ovh-cli-yma-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 01:56:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yusefmaali",
"github_project": "ovh-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ovh-cli-yma"
}
