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
~~~~~~~~~~
* Nothing unreleased
[0.6.1]
~~~~~~~
* Adds an enterprise allocation cancellation method
[0.6.0]
~~~~~~~
* Adds optional arg to create_enterprise_allocation() to either raise (current/default behavior),
or not raise and fall through to returning the response. This will allow callers
to do things with the response payload in error conditions.
[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.
Raw data
{
"_id": null,
"home_page": "https://github.com/edx/getsmarter-api-clients",
"name": "getsmarter-api-clients",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Python edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/28/b1/056f9bb4154d9b26520f73c1a4f65de09de6c7c86870c0d6bd7fb3dd72f2/getsmarter-api-clients-0.6.1.tar.gz",
"platform": null,
"description": "getsmarter-api-clients\n=============================\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge|\n\nClients to interact with GetSmarter APIs.\n\nThe ``README.rst`` file should start with a brief description of the repository,\nwhich sets it in the context of other repositories under the ``edx``\norganization. It should make clear where this fits in to the overall edX\ncodebase.\n\nOverview (please modify)\n------------------------\n\nThe ``README.rst`` file should then provide an overview of the code in this\nrepository, including the main components and useful entry points for starting\nto understand the code in more detail.\n\nDocumentation\n-------------\n\n(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)\n\nDevelopment Workflow\n--------------------\n\nOne Time Setup\n~~~~~~~~~~~~~~\n.. code-block::\n\n # Clone the repository\n git clone git@github.com:edx/getsmarter-api-clients.git\n cd getsmarter-api-clients\n\n # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it\n mkvirtualenv -p python3.8 getsmarter-api-clients\n\n\nEvery time you develop something in this repo\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. code-block::\n\n # Activate the virtualenv\n workon getsmarter-api-clients\n\n # Grab the latest code\n git checkout main\n git pull\n\n # Install/update the dev requirements\n make requirements\n\n # Run the tests and quality checks (to verify the status before you make any changes)\n make validate\n\n # Make a new branch for your changes\n git checkout -b <your_github_username>/<short_description>\n\n # Using your favorite editor, edit the code to make your change.\n vim \u2026\n\n # Run your new tests\n pytest ./path/to/new/tests\n\n # Run all the tests and quality checks\n make validate\n\n # Commit all your changes\n git commit \u2026\n git push\n\n # Open a PR and ask for review.\n\nLicense\n-------\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.\nPlease read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`__ for details.\nEven though they were written with ``edx-platform`` in mind, the guidelines\nshould be followed for all Open edX projects.\n\nThe pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you\ncan find it at `PULL_REQUEST_TEMPLATE.md <.github/PULL_REQUEST_TEMPLATE.md>`_.\n\nThe issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you\ncan find it at `ISSUE_TEMPLATE.md <.github/ISSUE_TEMPLATE.md>`_.\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@edx.org.\n\nGetting Help\n------------\n\nIf you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.\n\nOur real-time conversations are on Slack. You can request a `Slack invitation`_, then join our `community Slack workspace`_.\n\nFor more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/getsmarter-api-clients.svg\n :target: https://pypi.python.org/pypi/getsmarter-api-clients/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/edx/getsmarter-api-clients/workflows/Python%20CI/badge.svg?branch=main\n :target: https://github.com/edx/getsmarter-api-clients/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/edx/getsmarter-api-clients/coverage.svg?branch=main\n :target: https://codecov.io/github/edx/getsmarter-api-clients?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/getsmarter-api-clients/badge/?version=latest\n :target: https://getsmarter-api-clients.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/getsmarter-api-clients.svg\n :target: https://pypi.python.org/pypi/getsmarter-api-clients/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/getsmarter-api-clients.svg\n :target: https://github.com/edx/getsmarter-api-clients/blob/main/LICENSE.txt\n :alt: License\n\n\nChange Log\n----------\n\n..\n All enhancements and patches to getsmarter-api-clients will be documented\n in this file. It adheres to the structure of https://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n \n This project adheres to Semantic Versioning (https://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n* Nothing unreleased\n\n[0.6.1]\n~~~~~~~\n* Adds an enterprise allocation cancellation method\n\n[0.6.0]\n~~~~~~~\n* Adds optional arg to create_enterprise_allocation() to either raise (current/default behavior),\n or not raise and fall through to returning the response. This will allow callers\n to do things with the response payload in error conditions.\n\n[0.5.4]\n~~~~~~~\n* Add `org_id`` as an optional enterprise allocation param\n\n[0.5.3]\n~~~~~~~\n* Return allocation response objects\n\n[0.5.2]\n~~~~~~~\n* Include payload in error message\n\n[0.5.1]\n~~~~~~~\n* Catch a `requests.HTTPError`, not an `urllib.error.HTTPError`.\n\n[0.5.0] - 2023-04-12\n~~~~~~~~~~~~~~~~~~~~\n\n* Added new field for data_share_consent in enterprise_allocations\n\n[0.4.0] - 2022-09-12\n~~~~~~~~~~~~~~~~~~~~\n\n* Add enterprise_allocations endpoint functionality to client\n\n[0.1.0] - 2022-08-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAdded\n_____\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "Clients to interact with GetSmarter APIs.",
"version": "0.6.1",
"project_urls": {
"Homepage": "https://github.com/edx/getsmarter-api-clients"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "220c73bca63cf8ab41bbea4331f6890e9feb4807df8feb9d6a66a29a959cb7af",
"md5": "ff71a8cc13d4f41c6bf514e0a0d6a43b",
"sha256": "786dce3adf11419c0a2c16c952d7d5b65e4af348cd3a052645f19f294ee4d9e6"
},
"downloads": -1,
"filename": "getsmarter_api_clients-0.6.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff71a8cc13d4f41c6bf514e0a0d6a43b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 19949,
"upload_time": "2023-07-10T17:17:27",
"upload_time_iso_8601": "2023-07-10T17:17:27.775469Z",
"url": "https://files.pythonhosted.org/packages/22/0c/73bca63cf8ab41bbea4331f6890e9feb4807df8feb9d6a66a29a959cb7af/getsmarter_api_clients-0.6.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28b1056f9bb4154d9b26520f73c1a4f65de09de6c7c86870c0d6bd7fb3dd72f2",
"md5": "27289daeea7dacad86adf984bd43cf0b",
"sha256": "89e06e75ca79124ae9990e328fafeed0b5fd0c88abbdf2470951b2d690aa6f87"
},
"downloads": -1,
"filename": "getsmarter-api-clients-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "27289daeea7dacad86adf984bd43cf0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 22479,
"upload_time": "2023-07-10T17:17:29",
"upload_time_iso_8601": "2023-07-10T17:17:29.397549Z",
"url": "https://files.pythonhosted.org/packages/28/b1/056f9bb4154d9b26520f73c1a4f65de09de6c7c86870c0d6bd7fb3dd72f2/getsmarter-api-clients-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-10 17:17:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edx",
"github_project": "getsmarter-api-clients",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "getsmarter-api-clients"
}
JSON
