Merge branch 'rc/0.1.0' into release

.gitignore

@@ -13,7 +13,6 @@ develop-eggs/
 dist/
 downloads/
 eggs/
-lib/
 lib64/
 parts/
 sdist/
@@ -52,3 +51,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# For loading up local environment
+.env

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+python:
+    - 2.7
+install:
+    - pip install -e .
+    - pip install coveralls
+script:
+    - python setup.py test --coverage --pep8 --flakes
+    - coverage run --source=orcoursetrion setup.py test 
+after_success: 
+    coveralls

README.rst

@@ -0,0 +1,26 @@
+Orcoursetrion (a.k.a. Automatic Course Provisioning X)
+------------------------------------------------------
+
+Automatic course provisioning for the edx-platform using github and
+zendesk.
+
+
+Quick Start
+===========
+
+To get started, clone the repository, and run ``pip install .`` or
+just install directory from github.com with ``pip install
+git+https://github.com/mitodl/orcoursetrion``.
+
+Once installed, create or acquire an `OAUTH2 token from github
+<https://help.github.com/articles/creating-an-access-token-for-command-line-use/>`_. That
+at least has the ``repo``, ``write:repo_hook``, and ``write:org``
+permissions.
+
+Add the environment variable ``ORC_GH_OAUTH2_TOKEN=<your token>``
+to your environment, and run ``orcoursetrion --help`` for available
+commands and actions.
+
+If you are adding an XML course, you will also need to define
+``ORC_STAGING_GITRELOAD`` in your environment for where Web hooks
+should be sent for push events.

doc_requirements.txt

@@ -0,0 +1,7 @@
+--index-url https://pypi.python.org/simple/
+
+# Handy for development to install both
+-e .
+sphinx>=1.2.3
+sphinx_bootstrap_theme>=0.4.5
+sphinxcontrib-napoleon

docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Orcoursetrion.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Orcoursetrion.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Orcoursetrion"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Orcoursetrion"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/_templates/page.html

@@ -0,0 +1,20 @@
+{# Import the theme's layout. #}
+{% extends "!page.html" %}
+{% set bootswatch_css_custom = ['_static/site.css'] %}
+{% block header %}
+  {{ super() }}
+  <a href="https://github.com/mitodl/orcoursetrion"
+     class="visible-desktop hidden-xs"><img
+    id="gh-banner"
+    style="position: absolute; top: 50px; right: 0; border: 0; z-index: 100;"
+    src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png"
+    alt="Fork me on GitHub"></a>
+  <script>
+    // Adjust banner height.
+    $(function () {
+      var navHeight = $(".navbar .container").css("height");
+      $("#gh-banner").css("top", navHeight);
+    });
+  </script>
+
+{% endblock %}

docs/api.rst

@@ -0,0 +1,63 @@
+Orcoursetrion API Docs
+----------------------
+
+For convenient reference in development, here are the Orcoursetrion
+API docs.
+
+Actions
+=======
+
+The actions that are available to use.
+
+.. automodule:: orcoursetrion.actions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :imported-members:
+
+Library
+=======
+
+API libraries.
+
+.. automodule:: orcoursetrion.lib
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :imported-members:
+
+.. _configuration:
+
+Configuration
+=============
+
+Configuration options
+
+.. automodule:: orcoursetrion.config
+
+.. autoattribute:: orcoursetrion.config.ORC_GH_OAUTH2_TOKEN
+   :annotation: = GitHub OAUTH2 Token
+
+.. autoattribute:: orcoursetrion.config.ORC_GH_API_URL
+   :annotation: = GitHub API URL
+
+.. autoattribute:: orcoursetrion.config.ORC_COURSE_PREFIX
+   :annotation: = Prefix to use in repository name
+
+.. autoattribute:: orcoursetrion.config.ORC_STUDIO_ORG
+   :annotation: = Organization to use for Studio export repos
+
+.. autoattribute:: orcoursetrion.config.ORC_STUDIO_DEPLOY_TEAM
+   :annotation: = Deployment team for Studio Export repos
+
+.. autoattribute:: orcoursetrion.config.ORC_XML_ORG
+    :annotation: = Organization to use for XML/latex2edx courses
+
+.. autoattribute:: orcoursetrion.config.ORC_XML_DEPLOY_TEAM
+    :annotation: = Deployment team for XML/latex2edx courses
+
+.. autoattribute:: orcoursetrion.config.ORC_STAGING_GITRELOAD
+    :annotation: = `gitreload <https://github.com/mitodl/gitreload>`_
+                 server URL (including username and password) for the
+                 course development LMS.
+

docs/command.rst

@@ -0,0 +1,33 @@
+Command Line
+============
+
+There is an exposed command line interface that is available upon
+installation of the repository.  It can be run with ``orcoursetrion``, and
+``orcoursetrion --help`` will provide the most up to date help information.
+
+The command allows you to run commands that correspond to actions,
+currently the only supported action is ``create_export_repo``, and if
+your configuration is setup correctly (see :ref:`configuration`), and
+at least minimally have set
+:py:attr:`~orcoursetrion.config.ORC_GH_OAUTH2_TOKEN` and you run
+``orcoursetrion create_export_repo -t Spring_2030 -c DevOps.001 -d 'My
+awesome class repo'`` you should see it respond with the URL of the
+repo that it just created for you.
+
+
+Available Actions
+=================
+
+:create_export_repo:
+
+   This will create a new repository with the content deployment team
+   from :py:attr:`~orcoursetrion.config.ORC_STUDIO_DEPLOY_TEAM` added to
+   the repository.
+
+:create_xml_repo:
+
+   This will create a new repository with the
+   :py:attr:`~orcoursetrion.config.ORC_XML_DEPLOY_TEAM` and a command
+   line specified team added to repository.  It will also set up a git
+   hook to the URL specified with
+   :py:attr:`~orcoursetrion.config.ORC_STAGING_GITRELOAD`.