Skip to content

Commit

Permalink
Doc update (#1019)
Browse files Browse the repository at this point in the history
* updated parsing docs to include notes on SIS api

* updated docs to include info on jhu sis api
  • Loading branch information
rguo123 authored and noahpresler committed Sep 9, 2017
1 parent 88c072e commit 67fd292
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/parsing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Ingest
You may leave out the school code to parse all schools. This will run for a substantial amount of time and is not recommended.

.. note:: To parse JHU data, you will need to acquire an API access key from `SIS <sis.jhu.edu/api>`_. Add the key to ``dev_credentials.py`` in the ``semesterly/`` directory.

Digest
######

Expand All @@ -41,4 +43,4 @@ For example, you can use the term and year flags to parse only a specific term::
python manage.py ingest [SCHOOLCODE] --term Fall --year 2017
If you are developing a parser or contributing to the pipeline design, you will more than likely need to learn more. Checkout :ref:`pipeline` or :ref:`addaschool`
If you are developing a parser or contributing to the pipeline design, you will more than likely need to learn more. Checkout :ref:`pipeline` or :ref:`addaschool`

0 comments on commit 67fd292

Please sign in to comment.