Commit 5b55bde1 by David Baumgold

Merge pull request #3 from edx/badges

Badges
parents 42ed1f38 17b18ea1
language: python language: python
python: "2.7" python: "2.7"
install: install:
- "pip install coveralls"
- "pip install -r requirements.txt" - "pip install -r requirements.txt"
script: make test quality script: make test quality
after_success:
- coveralls
========================
edX Analytics API Client
========================
The edX Analytics API Client (henceforth, client) allows users to retrieve data from the edX data warehouse. Currently,
the client supports retrieving course activity and enrollment data. By default, all data is returned in the JSON format.
Enrollment data may also be retrieved in the CSV format by changing the data_format argument.
Testing
=======
$ make validate
How to Contribute
-----------------
Contributions are very welcome, but for legal reasons, you must submit a signed
[individual contributor's agreement](http://code.edx.org/individual-contributor-agreement.pdf)
before we can accept your contribution. See our
[CONTRIBUTING](https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst)
file for more information -- it also contains guidelines for how to maintain
high code quality, which will make your contribution more likely to be accepted.
edX Analytics API Client |build-status| |coverage-status|
=========================================================
The edX Analytics API Client (henceforth, client) allows users to retrieve data from the edX data warehouse. Currently,
the client supports retrieving course activity and enrollment data. By default, all data is returned in the JSON format.
Enrollment data may also be retrieved in the CSV format by changing the data_format argument.
Testing
-------
$ make validate
How to Contribute
-----------------
Contributions are very welcome, but for legal reasons, you must submit a signed
`individual contributor's agreement`_ before we can accept your contribution. See our
`CONTRIBUTING`_ file for more information -- it also contains guidelines for how to maintain
high code quality, which will make your contribution more likely to be accepted.
.. _individual contributor's agreement: http://code.edx.org/individual-contributor-agreement.pdf
.. _CONTRIBUTING: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst
.. |build-status| image:: https://travis-ci.org/edx/edx-analytics-data-api-client.svg?branch=master
:target: https://travis-ci.org/edx/edx-analytics-data-api-client
.. |coverage-status| image:: https://coveralls.io/repos/edx/edx-analytics-data-api-client/badge.png
:target: https://coveralls.io/r/edx/edx-analytics-data-api-client
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment