https://github.com/transpect/github-api
XProc steps that implement the GitHub API
https://github.com/transpect/github-api
github
Last synced: 16 days ago
JSON representation
XProc steps that implement the GitHub API
- Host: GitHub
- URL: https://github.com/transpect/github-api
- Owner: transpect
- License: bsd-2-clause
- Created: 2016-03-08T19:30:55.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-08T22:45:52.000Z (over 9 years ago)
- Last Synced: 2025-11-29T23:10:04.308Z (7 months ago)
- Topics: github
- Language: XProc
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-api
XProc steps that implement the GitHub API
## Description
Currently there exist two XProc steps for requesting the GitHub API. They use primarily XProc's `p:http-request` and rely on the capability of the XProc processor to expose JSON as XML.
## Dependencies
The GitHub API responds to HTTP requests with JSON messages. In order, the XProc steps rely on an XProc processor which is able to automatically convert the JSON provided by the API to an XML representation. [XML Calabash](http://xmlcalabash.com/) use a proprietary extension named [transparentJSON](xmlcalabash.com/docs/reference/langext.html#ext.transparent-json) for this purpose. [MorganaXProc](http://www.xml-project.com/) is currently not capable of exposing JSON as XML so we suggest to use XML Calabash.
## Authentification
The GitHub API limits the number of requests to 60 requests per day. To bypass this limit, you have to generate an access token in your GitHub settings. You can pass this token with the equally named option `token`.
## Steps
### tr:list-repos
#### output ports
`result`: provides the repositories and their metadata as transparentJSON XML document.
#### options
`token`: GitHub access token
`username`: name of the user or organization
`group`: Belongs the username to a regular user or to an organization? The following values are permitted: `users` and `orgs`
### tr:repo-directory-list
#### output ports
`result`: provides the directories and files below the submitted contents URL as XML representation.
#### options
`token`: GitHub access token
`contents-url`: GitHub contents URL. If you request a repository, this information is shipped within `j:contents_005furl`. Here is an example for a contents URL: `https://api.github.com/repos/transpect/github-api/contents`