Metadata-Version: 2.1
Name: getsmarter-api-clients
Version: 0.5.4
Summary: Clients to interact with GetSmarter APIs.
Home-page: https://github.com/edx/getsmarter-api-clients
Author: edX
Author-email: oscm@edx.org
License: AGPL 3.0
Keywords: Python edx
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
License-File: LICENSE.txt

getsmarter-api-clients
=============================

|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge|

Clients to interact with GetSmarter APIs.

The ``README.rst`` file should start with a brief description of the repository,
which sets it in the context of other repositories under the ``edx``
organization. It should make clear where this fits in to the overall edX
codebase.

Overview (please modify)
------------------------

The ``README.rst`` file should then provide an overview of the code in this
repository, including the main components and useful entry points for starting
to understand the code in more detail.

Documentation
-------------

(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)

Development Workflow
--------------------

One Time Setup
~~~~~~~~~~~~~~
.. code-block::

  # Clone the repository
  git clone git@github.com:edx/getsmarter-api-clients.git
  cd getsmarter-api-clients

  # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
  mkvirtualenv -p python3.8 getsmarter-api-clients


Every time you develop something in this repo
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block::

  # Activate the virtualenv
  workon getsmarter-api-clients

  # Grab the latest code
  git checkout main
  git pull

  # Install/update the dev requirements
  make requirements

  # Run the tests and quality checks (to verify the status before you make any changes)
  make validate

  # Make a new branch for your changes
  git checkout -b <your_github_username>/<short_description>

  # Using your favorite editor, edit the code to make your change.
  vim …

  # Run your new tests
  pytest ./path/to/new/tests

  # Run all the tests and quality checks
  make validate

  # Commit all your changes
  git commit …
  git push

  # Open a PR and ask for review.

License
-------

The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.

Please see `LICENSE.txt <LICENSE.txt>`_ for details.

How To Contribute
-----------------

Contributions are very welcome.
Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`__ for details.
Even though they were written with ``edx-platform`` in mind, the guidelines
should be followed for all Open edX projects.

The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you
can find it at `PULL_REQUEST_TEMPLATE.md <.github/PULL_REQUEST_TEMPLATE.md>`_.

The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you
can find it at `ISSUE_TEMPLATE.md <.github/ISSUE_TEMPLATE.md>`_.

Reporting Security Issues
-------------------------

Please do not report security issues in public. Please email security@edx.org.

Getting Help
------------

If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a `Slack invitation`_, then join our `community Slack workspace`_.

For more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.

.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/

.. |pypi-badge| image:: https://img.shields.io/pypi/v/getsmarter-api-clients.svg
    :target: https://pypi.python.org/pypi/getsmarter-api-clients/
    :alt: PyPI

.. |ci-badge| image:: https://github.com/edx/getsmarter-api-clients/workflows/Python%20CI/badge.svg?branch=main
    :target: https://github.com/edx/getsmarter-api-clients/actions
    :alt: CI

.. |codecov-badge| image:: https://codecov.io/github/edx/getsmarter-api-clients/coverage.svg?branch=main
    :target: https://codecov.io/github/edx/getsmarter-api-clients?branch=main
    :alt: Codecov

.. |doc-badge| image:: https://readthedocs.org/projects/getsmarter-api-clients/badge/?version=latest
    :target: https://getsmarter-api-clients.readthedocs.io/en/latest/
    :alt: Documentation

.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/getsmarter-api-clients.svg
    :target: https://pypi.python.org/pypi/getsmarter-api-clients/
    :alt: Supported Python versions

.. |license-badge| image:: https://img.shields.io/github/license/edx/getsmarter-api-clients.svg
    :target: https://github.com/edx/getsmarter-api-clients/blob/main/LICENSE.txt
    :alt: License


Change Log
----------

..
   All enhancements and patches to getsmarter-api-clients will be documented
   in this file.  It adheres to the structure of https://keepachangelog.com/ ,
   but in reStructuredText instead of Markdown (for ease of incorporation into
   Sphinx documentation and the PyPI description).
   
   This project adheres to Semantic Versioning (https://semver.org/).

.. There should always be an "Unreleased" section for changes pending release.

Unreleased
~~~~~~~~~~

*

[0.5.4]
~~~~~~~
* Add `org_id`` as an optional enterprise allocation param

[0.5.3]
~~~~~~~
* Return allocation response objects

[0.5.2]
~~~~~~~
* Include payload in error message

[0.5.1]
~~~~~~~
* Catch a `requests.HTTPError`, not an `urllib.error.HTTPError`.

[0.5.0] - 2023-04-12
~~~~~~~~~~~~~~~~~~~~

* Added new field for data_share_consent in enterprise_allocations

[0.4.0] - 2022-09-12
~~~~~~~~~~~~~~~~~~~~

* Add enterprise_allocations endpoint functionality to client

[0.1.0] - 2022-08-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Added
_____

* First release on PyPI.
