edx-when
=============================
|pypi-badge| |CI| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge|
Overview
--------
edx-when is designed to be the central source of dates for the LMS.
This repository is deployed to PyPI and designed to be installed and imported by an installation of edx-platform.
As part of being integrated into edx-platform, edx-when shares the **same** database as the rest of the platform.
It is written to by Studio when a Course is published
(via https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/course_date_signals/handlers.py)
and then the LMS reads from it in several locations.
This repo contains start, end, and due dates for Courses and offers the
functionality to have both absolute and relative dates.
License
-------
The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.
Please see ``LICENSE.txt`` for details.
How To Contribute
-----------------
Contributions are very welcome.
Please read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`_ for details.
PR description template should be automatically applied if you are sending PR from github interface; otherwise you
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/openedx/edx-when/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_
Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you
can find it at `ISSUE_TEMPLATE.md <https://github.com/openedx/edx-when/blob/master/.github/ISSUE_TEMPLATE.md>`_
Reporting Security Issues
-------------------------
Please do not report security issues in public. Please email security@openedx.org.
Getting Help
------------
Have a question about this repository, or about Open edX in general? Please
refer to this `list of resources`_ if you need any assistance.
.. _list of resources: https://open.edx.org/getting-help
.. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-when.svg
:target: https://pypi.python.org/pypi/edx-when/
:alt: PyPI
.. |CI| image:: https://github.com/openedx/edx-when/workflows/Python%20CI/badge.svg?branch=master
:target: https://github.com/openedx/edx-when/actions?query=workflow%3A%22Python+CI%22
:alt: CI
.. |codecov-badge| image:: http://codecov.io/github/edx/edx-when/coverage.svg?branch=master
:target: http://codecov.io/github/edx/edx-when?branch=master
:alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/edx-when/badge/?version=latest
:target: http://edx-when.readthedocs.io/en/latest/
:alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-when.svg
:target: https://pypi.python.org/pypi/edx-when/
:alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/edx/edx-when.svg
:target: https://github.com/openedx/edx-when/blob/master/LICENSE.txt
:alt: License
Change Log
----------
..
All enhancements and patches to edx_when will be documented
in this file. It adheres to the structure of http://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 (http://semver.org/).
.. There should always be an "Unreleased" section for changes pending release.
Unreleased
~~~~~~~~~~
[2.5.0] - 2024-04-02
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add support for Python 3.11. Dropped django32 support.
* Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
deprecated
[2.4.0] - 2023-06-21
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Support added for Django 4.2
[2.3.0] - 2022-02-15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added Django40 support
* Dropped Django22, 30 and 31 support
[2.2.2] - 2021-10-21
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Bug fix to bust cache when Personalized Learner Schedules are updated.
[2.2.1] - 2021-09-15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Bug fix for optimization in 2.2.0, to account for missing block_type data.
[2.2.0] - 2021-08-27
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added optimization when requesting course block dates for an outline, where block dates below subsections are unneeded.
* Use current version of the course to improve the cache key, along with using the TieredCache to cache date data.
[2.1.0] - 2021-07-23
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added Django 3.2 Support
[2.0.0] - 2021-01-19
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Dropped python3.5 support.
[1.3.2] - 2021-01-15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Don't warn about missing schedules for relative dates.
It happens for legitimate reasons, and the layer above can check instead.
[1.3.1] - 2020-11-19
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Updated travis badge in README.rst to point to travis-ci.com instead of travis-ci.org
[1.3.0] - 2020-07-16
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Django 3.x deprecation warnings are fixed
[1.2.9] - 2020-06-30
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Don't return due dates for enrollments originally created too close to the
course end to allow for finishing the course in time.
[1.2.8] - 2020-06-17
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Don't return due dates for enrollments created after course end
[1.2.4] - 2020-06-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Updates function in API for finding learners with a specific Schedule
that has an assignment on a given day, to also be inclusive of absolute
date schedules (everyone active in the course without an override).
[1.2.3] - 2020-04-30
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Dropped support for Django versions below 2.2
* Added support for python 3.8
[1.1.4] - 2019-03-30
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Drop the active index from ContentDate. It has low cardinality and Aurora was
doing a lot of extra work to try to do an intersect query with that and
the course_id index, when using the latter by itself would be far more
efficient.
[1.1.3] - 2019-03-25
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Use memcache to cache ContentDate information in get_dates_for_course
[0.1.0] - 2019-03-04
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added
_____
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/edx-when",
"name": "edx-when",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Django edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/17/71/e6f56b2672e8a8ad57a4500f74abfe592defdee39a6805063295d4726429/edx-when-2.5.0.tar.gz",
"platform": null,
"description": "edx-when\n=============================\n\n|pypi-badge| |CI| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge|\n\nOverview\n--------\n\nedx-when is designed to be the central source of dates for the LMS.\nThis repository is deployed to PyPI and designed to be installed and imported by an installation of edx-platform.\nAs part of being integrated into edx-platform, edx-when shares the **same** database as the rest of the platform.\nIt is written to by Studio when a Course is published\n(via https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/course_date_signals/handlers.py)\nand then the LMS reads from it in several locations.\nThis repo contains start, end, and due dates for Courses and offers the\nfunctionality to have both absolute and relative dates.\n\nLicense\n-------\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see ``LICENSE.txt`` for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.\n\nPlease read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`_ for details.\n\n\nPR description template should be automatically applied if you are sending PR from github interface; otherwise you\ncan find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/openedx/edx-when/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_\n\nIssue report template should be automatically applied if you are sending it from github UI as well; otherwise you\ncan find it at `ISSUE_TEMPLATE.md <https://github.com/openedx/edx-when/blob/master/.github/ISSUE_TEMPLATE.md>`_\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\nGetting Help\n------------\n\nHave a question about this repository, or about Open edX in general? Please\nrefer to this `list of resources`_ if you need any assistance.\n\n.. _list of resources: https://open.edx.org/getting-help\n\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-when.svg\n :target: https://pypi.python.org/pypi/edx-when/\n :alt: PyPI\n\n.. |CI| image:: https://github.com/openedx/edx-when/workflows/Python%20CI/badge.svg?branch=master\n :target: https://github.com/openedx/edx-when/actions?query=workflow%3A%22Python+CI%22\n :alt: CI\n\n.. |codecov-badge| image:: http://codecov.io/github/edx/edx-when/coverage.svg?branch=master\n :target: http://codecov.io/github/edx/edx-when?branch=master\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/edx-when/badge/?version=latest\n :target: http://edx-when.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-when.svg\n :target: https://pypi.python.org/pypi/edx-when/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/edx-when.svg\n :target: https://github.com/openedx/edx-when/blob/master/LICENSE.txt\n :alt: License\n\n\nChange Log\n----------\n\n..\n All enhancements and patches to edx_when will be documented\n in this file. It adheres to the structure of http://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 (http://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n\n[2.5.0] - 2024-04-02\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add support for Python 3.11. Dropped django32 support.\n* Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is\n deprecated\n\n[2.4.0] - 2023-06-21\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Support added for Django 4.2\n\n[2.3.0] - 2022-02-15\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added Django40 support\n* Dropped Django22, 30 and 31 support\n\n\n[2.2.2] - 2021-10-21\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Bug fix to bust cache when Personalized Learner Schedules are updated.\n\n[2.2.1] - 2021-09-15\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Bug fix for optimization in 2.2.0, to account for missing block_type data.\n\n[2.2.0] - 2021-08-27\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added optimization when requesting course block dates for an outline, where block dates below subsections are unneeded.\n* Use current version of the course to improve the cache key, along with using the TieredCache to cache date data.\n\n[2.1.0] - 2021-07-23\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nAdded Django 3.2 Support\n\n[2.0.0] - 2021-01-19\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nDropped python3.5 support.\n\n[1.3.2] - 2021-01-15\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDon't warn about missing schedules for relative dates.\nIt happens for legitimate reasons, and the layer above can check instead.\n\n[1.3.1] - 2020-11-19\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nUpdated travis badge in README.rst to point to travis-ci.com instead of travis-ci.org\n\n\n[1.3.0] - 2020-07-16\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDjango 3.x deprecation warnings are fixed\n\n[1.2.9] - 2020-06-30\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDon't return due dates for enrollments originally created too close to the\ncourse end to allow for finishing the course in time.\n\n[1.2.8] - 2020-06-17\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDon't return due dates for enrollments created after course end\n\n[1.2.4] - 2020-06-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nUpdates function in API for finding learners with a specific Schedule\nthat has an assignment on a given day, to also be inclusive of absolute\ndate schedules (everyone active in the course without an override).\n\n[1.2.3] - 2020-04-30\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Dropped support for Django versions below 2.2\n* Added support for python 3.8\n\n[1.1.4] - 2019-03-30\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Drop the active index from ContentDate. It has low cardinality and Aurora was\n doing a lot of extra work to try to do an intersect query with that and\n the course_id index, when using the latter by itself would be far more\n efficient.\n\n\n[1.1.3] - 2019-03-25\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Use memcache to cache ContentDate information in get_dates_for_course\n\n\n[0.1.0] - 2019-03-04\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAdded\n_____\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "Your project description goes here",
"version": "2.5.0",
"project_urls": {
"Homepage": "https://github.com/openedx/edx-when"
},
"split_keywords": [
"django",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c8e57f629c75f0c84f8937dfedb1201f30ce8562e602c490607a335a4c6945f6",
"md5": "df67af359cf69d2e31010c9b86de5dbd",
"sha256": "ece4f8ecea339465691b53f85d3d300f629c2330b3c7375aa48450dc9b0b9ec1"
},
"downloads": -1,
"filename": "edx_when-2.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "df67af359cf69d2e31010c9b86de5dbd",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 33299,
"upload_time": "2024-04-05T19:27:06",
"upload_time_iso_8601": "2024-04-05T19:27:06.841994Z",
"url": "https://files.pythonhosted.org/packages/c8/e5/7f629c75f0c84f8937dfedb1201f30ce8562e602c490607a335a4c6945f6/edx_when-2.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1771e6f56b2672e8a8ad57a4500f74abfe592defdee39a6805063295d4726429",
"md5": "37e70a664d91837317a58423b9f8ebcc",
"sha256": "482ce1acb5c0b391867603dd9622b4e90eb31a3251c341295f796c18bf6b29e5"
},
"downloads": -1,
"filename": "edx-when-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "37e70a664d91837317a58423b9f8ebcc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 40070,
"upload_time": "2024-04-05T19:27:09",
"upload_time_iso_8601": "2024-04-05T19:27:09.044114Z",
"url": "https://files.pythonhosted.org/packages/17/71/e6f56b2672e8a8ad57a4500f74abfe592defdee39a6805063295d4726429/edx-when-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 19:27:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "edx-when",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "edx-when"
}
JSON
