lib/github/README.md

   1 # Nit wrapper for Github API
   2
   3 This module provides a Nit object oriented interface to access the Github api.
   4
   5 ## Accessing the API
   6
   7 [[doc: GithubAPI]]
   8
   9 ### Authentification
  10
  11 [[doc: auth]]
  12
  13 Token can also be recovered from user config with `get_github_oauth`.
  14
  15 [[doc: get_github_oauth]]
  16
  17 ### Retrieving user data
  18
  19 [[doc: load_user]]
  20 [[doc: User]]
  21 [[list: User]]
  22
  23 ### Retrieving repo data
  24
  25 [[doc: load_repo]]
  26 [[doc: Repo]]
  27 [[list: Repo]]
  28
  29 ### Other data
  30
  31 [[list: github::api]]
  32
  33 ### Advanced uses
  34
  35 #### Caching
  36
  37 [[doc: cache]]
  38
  39 #### Custom requests
  40
  41 [[doc: github::GithubAPI::get]]
  42
  43 #### Change the user agent
  44
  45 [[doc: github::GithubAPI::user_agent]]
  46
  47 #### Debugging
  48
  49 [[doc: verbose_lvl]]
  50
  51 #### Using with GitLab
  52
  53 If URL scheme of GitLab API follows the one of Github API, it may be possible to
  54 configure this wrapper to use a custom URL.
  55
  56 [[doc: api_url]]
  57
  58 ## Creating hooks
  59
  60 Using this API you can create Github hooks able to respond to actions performed
  61 on a repository.
  62
  63 [[doc: hooks]]
  64
  65 ## Dealing with events
  66
  67 GithubAPI can trigger different events depending on the hook configuration.
  68
  69 [[doc: GithubEvent]]
  70
  71 [[list: github::events]]