kmx.io/ex_ovh/README.md
ExOvh 
ExOvh is an helper library for the elixir language for the Ovh Api. To use the Openstack components of the OVH API, see Openstex
Project Features
- Config supervised agent running in the background which stores frequently accessed authentication information.
- Query modules for making building requests to the Ovh Api.
- Request functions to send Queries to the Ovh Api.
Getting started - Step 1: Generating the OVH application key, application secret and consumer key.
-
This may be done manually by going to
https://eu.api.ovh.com/createApp/and following the directions outlined byOVHath their first steps guide. -
Alternatively, this may be achieved by running a mix task. This saves me a lot of time when generating a new application. Documentation here
Getting Started - Step 2: Generating the OVH client module for your elixir application
-
The client module (eg
AwesomeApp.OvhClient) is the interface for accessing the functions of the ex_ovhAPI.
Usage
- Basic examples to be added to readme.
Contributing
- Pull requests welcome.
Tests
- Tests have not been written yet.
TODO
- [ ] Tests for OVH portion of library
- [ ] Option to set the application ttl when running ovh mix task.
- [ ] Add queries for the remainder of the OVH API. (Webstorage CDN and Cloud are the only ones covered so far)
- [ ] Basic examples to be added to readme of usage of the api.
- [ ] Add macro for building queries.
Note
This is an unofficial client to the OVH api and is not maintained by OVH.
Licence
Source
-
README.md
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
# ExOvh [](https://travis-ci.org/stephenmoloney/ex_ovh) [](https://hex.pm/packages/ex_ovh) [](https://hexdocs.pm/ex_ovh) [](https://beta.hexfaktor.org/github/stephenmoloney/ex_ovh) ExOvh is an helper library for the [elixir language](http://elixir-lang.org/) for the [Ovh Api](https://api.ovh.com/). To use the Openstack components of the OVH API, see [Openstex](https://github.com/stephenmoloney/openstex) #### Project Features - Config supervised agent running in the background which stores frequently accessed authentication information. - Query modules for making building requests to the [Ovh Api](https://api.ovh.com/). - Request functions to send Queries to the [Ovh Api](https://api.ovh.com/). #### Getting started - Step 1: Generating the OVH `application key`, `application secret` and `consumer key`. - This may be done manually by going to `https://eu.api.ovh.com/createApp/` and following the directions outlined by `OVH` ath [their first steps guide](https://api.ovh.com/g934.first_step_with_api). - Alternatively, this may be achieved by running a mix task. This saves me a lot of time when generating a new application. [Documentation here](https://github.com/stephenmoloney/ex_ovh/blob/master/docs/mix_task.md) #### Getting Started - Step 2: Generating the OVH client module for your elixir application - The client module (eg `AwesomeApp.OvhClient`) is the interface for accessing the functions of the ***ex_ovh*** `API`. - [Documentation here](https://github.com/stephenmoloney/ex_ovh/blob/master/docs/getting_started.md) #### Usage - Basic examples to be added to readme. [See Hex Docs](https://hexdocs.pm/ex_ovh/0.2/api-reference.html) #### Contributing - Pull requests welcome. #### Tests - Tests have not been written yet. #### TODO - [ ] Tests for OVH portion of library - [ ] Option to set the application ttl when running ovh mix task. - [ ] Add queries for the remainder of the OVH API. (Webstorage CDN and Cloud are the only ones covered so far) - [ ] Basic examples to be added to readme of usage of the api. - [ ] Add macro for building queries. #### Note This is an unofficial client to the OVH api and is not maintained by OVH. #### Licence [MIT Licence](LICENCE.md)