Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

docs: Add deprecation notice to readme #170

Merged
merged 2 commits into from
Mar 11, 2024
Merged

docs: Add deprecation notice to readme #170

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
233b079
docs: Add deprecation notice to readme
bmtcril Mar 6, 2024
646f206
docs: Update README.rst
bmtcril Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 16 additions & 19 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
edX Analytics API Client |build-status| |coverage-status|
=========================================================
edX Analytics API Client
========================

DEPRECATION NOTICE
------------------

The Insights product and associated repositories are in the process of being
deprecated and removed from service. Details on the deprecation status and
process can be found in the relevant `Github issue <https://github.com/openedx/public-engineering/issues/221>_`.

This repository is slated may be archived and moved to the openedx-unsupported
Github organization at any time.
bmtcril marked this conversation as resolved.
Show resolved Hide resolved

The following sections are for historical purposes only.



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.
Expand All @@ -8,20 +22,3 @@ Enrollment data may also be retrieved in the CSV format by changing the data_for
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/openedx/.github/blob/master/CONTRIBUTING.md

.. |build-status| image:: https://github.com/openedx/edx-analytics-data-api-client/workflows/Python%20CI/badge.svg?branch=master
:target: https://github.com/openedx/edx-analytics-data-api-client/actions?query=workflow%3A%22Python+CI%22
.. |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
Loading