For convenient reference in development, here are the Orcoursetrion API docs.
The actions that are available to use.
Action library access
orcoursetrion.actions.
create_export_repo
(course, term, description=None)[source]¶Creates a course repo at
ORC_GH_API_URL
with key
ORC_GH_OAUTH2_TOKEN
, at
organization ORC_STUDIO_ORG
,
and with collabarator
ORC_STUDIO_DEPLOY_TEAM
Parameters: |
|
---|---|
Returns: |
|
Return type: | dict |
orcoursetrion.actions.
create_xml_repo
(course, term, team, description=None)[source]¶Creates a course repo at
ORC_GH_API_URL
with key
ORC_GH_OAUTH2_TOKEN
and at
organization ORC_XML_ORG
, and
with team
as a collaborator (Along with
ORC_XML_DEPLOY_TEAM
).
This also adds a github Web hook to the course development
environment gitreload
server via
ORC_STAGING_GITRELOAD
.
Parameters: |
|
---|---|
Returns: |
|
Return type: | dict |
API libraries.
Orchestrion library
orcoursetrion.lib.
GitHub
(api_url, oauth2_token)[source]¶Bases: object
API class for handling calls to github
Initialize a requests session for use with this class by specifying the base API endpoint and key.
Parameters: |
|
---|
add_team_repo
(org, repo, team)[source]¶Add a repo to an existing team (by name) in the specified org.
We first look up the team to get its ID (https://developer.github.com/v3/orgs/teams/#list-teams), and then add the repo to that team (https://developer.github.com/v3/orgs/teams/#add-team-repo).
Parameters: |
|
---|---|
Raises: |
|
add_web_hook
(org, repo, url)[source]¶Adds an active hook to a github repository.
This utilizes https://developer.github.com/v3/repos/hooks/#create-a-hook to create a form type Web hook that responds to push events (basically all the defaults).
Parameters: |
|
---|---|
Raises: |
|
Returns: |
|
Return type: | dict |
create_repo
(org, repo, description)[source]¶Creates a new github repository or raises exceptions
Parameters: |
|
---|---|
Raises: |
|
Returns: |
|
Return type: | dict |
orcoursetrion.lib.
GitHubException
[source]¶Bases: exceptions.Exception
Base exception class others inherit.
orcoursetrion.lib.
GitHubRepoExists
[source]¶Bases: orcoursetrion.lib.github.GitHubException
Repo exists, and thus cannot be created.
Configuration options
Configuration needed for Orchestrion to function (i.e. API keys)
config.
ORC_GH_OAUTH2_TOKEN
= GitHub OAUTH2 Token¶config.
ORC_GH_API_URL
= GitHub API URL¶config.
ORC_COURSE_PREFIX
= Prefix to use in repository name¶config.
ORC_STUDIO_ORG
= Organization to use for Studio export repos¶config.
ORC_STUDIO_DEPLOY_TEAM
= Deployment team for Studio Export repos¶config.
ORC_XML_ORG
= Organization to use for XML/latex2edx courses¶config.
ORC_XML_DEPLOY_TEAM
= Deployment team for XML/latex2edx courses¶config.
ORC_STAGING_GITRELOAD
= `gitreload <https://github.com/mitodl/gitreload>`_
server URL (including username and password) for the
course development LMS.¶