release-notes
#############
.. note::
This README was auto-generated. Maintainer: please review its contents and
update all relevant sections. Instructions to you are marked with
"PLACEHOLDER" or "TODO". Update or remove those sections, and remove this
note when you are done.
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |status-badge|
Purpose
*******
Edx Release Notes Backend.
TODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.
It should be described in the context of other repositories under the ``openedx``
organization. It should make clear where this fits into the overall Open edX
codebase and should be oriented towards people who are new to the Open edX
project.
Getting Started with Development
********************************
Please see the Open edX documentation for `guidance on Python development`_ in this repo.
.. _guidance on Python development: https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html
Getting Help
************
Documentation
=============
PLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.
.. _the documentation: https://docs.openedx.org/projects/release-notes
(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
More 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 anything non-trivial, the best path is to open an issue in this
repository with as many details about the issue you are facing as you
can provide.
https://github.com/edx/release-notes/issues
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/
License
*******
The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.
Please see `LICENSE.txt <LICENSE.txt>`_ for details.
Contributing
************
Contributions are very welcome.
Please read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.
This project is currently accepting all types of contributions, bug fixes,
security fixes, maintenance work, or new features. However, please make sure
to discuss your new feature idea with the maintainers before beginning development
to maximize the chances of your change being accepted.
You can start a conversation by creating a new issue on this repo summarizing
your idea.
The Open edX Code of Conduct
****************************
All community members are expected to follow the `Open edX Code of Conduct`_.
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
People
******
The assigned maintainers for this component and other project details may be
found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
file in this repo.
.. _Backstage: https://backstage.openedx.org/catalog/default/component/release-notes
Reporting Security Issues
*************************
Please do not report security issues in public. Please email security@openedx.org.
.. |pypi-badge| image:: https://img.shields.io/pypi/v/release-notes.svg
:target: https://pypi.python.org/pypi/release-notes/
:alt: PyPI
.. |ci-badge| image:: https://github.com/edx/release-notes/actions/workflows/ci.yml/badge.svg?branch=master
:target: https://github.com/edx/release-notes/actions/workflows/ci.yml
:alt: CI
.. |codecov-badge| image:: https://codecov.io/github/edx/release-notes/coverage.svg?branch=master
:target: https://codecov.io/github/edx/release-notes?branch=master
:alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/release-notes/badge/?version=latest
:target: https://docs.openedx.org/projects/release-notes
:alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/release-notes.svg
:target: https://pypi.python.org/pypi/release-notes/
:alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/edx/release-notes.svg
:target: https://github.com/edx/release-notes/blob/master/LICENSE.txt
:alt: License
.. TODO: Choose one of the statuses below and remove the other status-badge lines.
.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red
Change Log
##########
..
All enhancements and patches to release_notes 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.1.0 – 2025-09-29
**********************************************
Added
=====
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/edx/release-notes",
"name": "edx-release-notes",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Python edx",
"author": "Edx Project",
"author_email": "fmaqsood@2u.com",
"download_url": "https://files.pythonhosted.org/packages/8f/d3/a7bc8f757882d103b9d14766008fdde3d309e667aaf22c50df9e7f0cdb6d/edx_release_notes-0.1.1.tar.gz",
"platform": null,
"description": "release-notes\n#############\n\n.. note::\n\n This README was auto-generated. Maintainer: please review its contents and\n update all relevant sections. Instructions to you are marked with\n \"PLACEHOLDER\" or \"TODO\". Update or remove those sections, and remove this\n note when you are done.\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge|\n\nPurpose\n*******\n\nEdx Release Notes Backend.\n\nTODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.\nIt should be described in the context of other repositories under the ``openedx``\norganization. It should make clear where this fits into the overall Open edX\ncodebase and should be oriented towards people who are new to the Open edX\nproject.\n\nGetting Started with Development\n********************************\n\nPlease see the Open edX documentation for `guidance on Python development`_ in this repo.\n\n.. _guidance on Python development: https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html\n\nGetting Help\n************\n\nDocumentation\n=============\n\nPLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.\n\n.. _the documentation: https://docs.openedx.org/projects/release-notes\n\n(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)\n\nMore Help\n=========\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the\ncommunity.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.\n\nFor anything non-trivial, the best path is to open an issue in this\nrepository with as many details about the issue you are facing as you\ncan provide.\n\nhttps://github.com/edx/release-notes/issues\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\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\nContributing\n************\n\nContributions are very welcome.\nPlease read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features. However, please make sure\nto discuss your new feature idea with the maintainers before beginning development\nto maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nThe Open edX Code of Conduct\n****************************\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nPeople\n******\n\nThe assigned maintainers for this component and other project details may be\nfound in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``\nfile in this repo.\n\n.. _Backstage: https://backstage.openedx.org/catalog/default/component/release-notes\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/release-notes.svg\n :target: https://pypi.python.org/pypi/release-notes/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/edx/release-notes/actions/workflows/ci.yml/badge.svg?branch=master\n :target: https://github.com/edx/release-notes/actions/workflows/ci.yml\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/edx/release-notes/coverage.svg?branch=master\n :target: https://codecov.io/github/edx/release-notes?branch=master\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/release-notes/badge/?version=latest\n :target: https://docs.openedx.org/projects/release-notes\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/release-notes.svg\n :target: https://pypi.python.org/pypi/release-notes/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/release-notes.svg\n :target: https://github.com/edx/release-notes/blob/master/LICENSE.txt\n :alt: License\n\n.. TODO: Choose one of the statuses below and remove the other status-badge lines.\n.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red\n\n\nChange Log\n##########\n\n..\n All enhancements and patches to release_notes 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\n*\n\n0.1.0 \u2013 2025-09-29\n**********************************************\n\nAdded\n=====\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "Edx Release Notes Backend.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/edx/release-notes"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8842358a9e211674bc4cf729096af737f787df202dae517cbb45658312411cf4",
"md5": "692677317243731a33f5f9ccb4094861",
"sha256": "aab3e73b4d08b5fdf49038018e42824727282405455125db624a3eb0bc3c5543"
},
"downloads": -1,
"filename": "edx_release_notes-0.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "692677317243731a33f5f9ccb4094861",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.11",
"size": 23973,
"upload_time": "2025-10-24T13:36:39",
"upload_time_iso_8601": "2025-10-24T13:36:39.554866Z",
"url": "https://files.pythonhosted.org/packages/88/42/358a9e211674bc4cf729096af737f787df202dae517cbb45658312411cf4/edx_release_notes-0.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8fd3a7bc8f757882d103b9d14766008fdde3d309e667aaf22c50df9e7f0cdb6d",
"md5": "f58c59ab7724117d46d57a70595ce83e",
"sha256": "7acd401b27ea0bbb93d485660ebdd7a8613ba9d6499fe9615c93c1593a392212"
},
"downloads": -1,
"filename": "edx_release_notes-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "f58c59ab7724117d46d57a70595ce83e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 23705,
"upload_time": "2025-10-24T13:36:40",
"upload_time_iso_8601": "2025-10-24T13:36:40.321111Z",
"url": "https://files.pythonhosted.org/packages/8f/d3/a7bc8f757882d103b9d14766008fdde3d309e667aaf22c50df9e7f0cdb6d/edx_release_notes-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 13:36:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edx",
"github_project": "release-notes",
"github_not_found": true,
"lcname": "edx-release-notes"
}
JSON
