{"id":16484896,"url":"https://github.com/stephenmoloney/ex_ovh","last_synced_at":"2025-03-23T12:32:45.544Z","repository":{"id":62429233,"uuid":"51514317","full_name":"stephenmoloney/ex_ovh","owner":"stephenmoloney","description":"An elixir client library for the OVH API. ","archived":false,"fork":false,"pushed_at":"2017-11-02T13:48:02.000Z","size":238,"stargazers_count":8,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T20:22:20.804Z","etag":null,"topics":["api","elixir","elixir-lang","ovh","ovh-api"],"latest_commit_sha":null,"homepage":"https://hex.pm/packages/ex_ovh","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stephenmoloney.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-11T12:51:05.000Z","updated_at":"2024-04-20T03:39:34.000Z","dependencies_parsed_at":"2022-11-01T20:06:40.632Z","dependency_job_id":null,"html_url":"https://github.com/stephenmoloney/ex_ovh","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenmoloney%2Fex_ovh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenmoloney%2Fex_ovh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenmoloney%2Fex_ovh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenmoloney%2Fex_ovh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stephenmoloney","download_url":"https://codeload.github.com/stephenmoloney/ex_ovh/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245104464,"owners_count":20561376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","elixir","elixir-lang","ovh","ovh-api"],"created_at":"2024-10-11T13:18:38.996Z","updated_at":"2025-03-23T12:32:45.259Z","avatar_url":"https://github.com/stephenmoloney.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ExOvh [![Build Status](https://travis-ci.org/stephenmoloney/ex_ovh.svg)](https://travis-ci.org/stephenmoloney/ex_ovh) [![Hex Version](http://img.shields.io/hexpm/v/ex_ovh.svg?style=flat)](https://hex.pm/packages/ex_ovh) [![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/ex_ovh) [![Deps Status](https://beta.hexfaktor.org/badge/prod/github/stephenmoloney/ex_ovh.svg)](https://beta.hexfaktor.org/github/stephenmoloney/ex_ovh)\n\nExOvh is an helper library for the [elixir language](http://elixir-lang.org/) for the [Ovh Api](https://api.ovh.com/).\nTo use the Openstack components of the OVH API, see [Openstex](https://github.com/stephenmoloney/openstex)\n\n\n#### Project Features\n\n- ***A Supervised agent*** running in the background which stores frequently accessed authentication information.\n- ***Helper*** modules for making building requests to the [Ovh Api](https://api.ovh.com/).\n- ***Request*** functions to send requests to the [Ovh Api](https://api.ovh.com/).\n\n\n#### Getting started - Step 1: Generating the OVH `application key`, `application secret` and `consumer key`.\n\n- This may be done manually by going to `https://eu.api.ovh.com/createApp/` and following the directions outlined by `OVH` at\n[their first steps guide](https://api.ovh.com/g934.first_step_with_api).\n\n- Alternatively, this may be achieved by running a mix task. This saves me a lot of time when generating a new application.\n\n- [Documentation here](https://github.com/stephenmoloney/ex_ovh/blob/master/docs/mix_task.md)\n\n\n#### Getting Started - Step 2: Generating the OVH client module for your elixir application\n\n- The client module (eg `AwesomeApp.OvhClient`) is the interface for accessing the\nfunctions of the ***ex_ovh*** `API`.\n\n- [Documentation here](https://github.com/stephenmoloney/ex_ovh/blob/master/docs/getting_started.md)\n\n\n#### Usage\n\n#### Examples - Method 1 - Building the queries manually and send the request (my preferred way)\n\n\n- `GET /me/api/application/#{app_id}`\n```\napp_id = \"0\"\nreq = %HTTPipe.Request{\n  method: :get,\n  url: \"/me/api/application/#{app_id}\"\n}\nMyApp.OvhClient.request!(req)\n```\n\n- `GET /cloud/project/{serviceName}/storage`\n```\nservice_name = \"service_name\"\nreq = %HTTPipe.Request{\n  method: :get,\n  url: \"/cloud/project/#{service_name}/storage\"\n}\n|\u003e MyApp.OvhClient.request!()\n```\n\n\n#### Examples - Method 2 - Build the request using provided helper functions and send the request\n\n***Note:*** Helper functions are only available currently for the `/Cloud` portion of the OVH API.\n*Eventually, I would like to write a macro to create the queries.*\n\n- `GET /cloud/project/{serviceName}/storage`\n```\nExOvh.V1.Cloud.get_containers(service_name) |\u003e ExOvh.request!()\n```\n\n- For more information [See Hex Docs](https://hexdocs.pm/ex_ovh/0.2/api-reference.html)\n\n\n#### Contributing\n\n- Pull requests welcome.\n\n\n#### Tests\n\n- Tests have not been written yet.\n\n\n#### TODO\n\n- [ ] Tests for OVH portion of library\n- [ ] Option to set the application ttl when running ovh mix task.\n- [x] Basic examples to be added to readme of usage of the api.\n- [ ] Add macro for building queries.\n- [ ] Write the usage guide - more examples of using the API.\n- [ ] Remove dependency on `:calendar` if tz info is not required.\n\n\n#### Note \n\nThis is an unofficial client to the OVH api and is not maintained by OVH.\n\n\n#### Licence \n\n[MIT Licence](LICENCE.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenmoloney%2Fex_ovh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephenmoloney%2Fex_ovh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenmoloney%2Fex_ovh/lists"}