Branch : - branch - - tag -

• Commit

• Author : Stephen Moloney
  Date : 2017-02-16 15:58:02
  Hash : 74adf74a
  Message : update docs

• Files
• .gitignore
• CHANGELOG.md
• LICENCE.md
• README.md
• config
• docs
• lib
• mix.exs
• test

• 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 by OVH ath 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_ovh API.

  • Documentation here

  Usage

  • Basic examples to be added to readme.

  See Hex Docs

  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.
  • [ ] Write the usage guide - more examples of using the API.

  Note

  This is an unofficial client to the OVH api and is not maintained by OVH.

  Licence

  MIT Licence