openedx-calc
############
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |status-badge|
Purpose
*******
A helper library for mathematical calculations and symbolic mathematics, used by the `edx-platform`_.
This code originally lived in the `edx-platform`_ repo, but now exists here independently.
Getting Started with Development
********************************
General
=======
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
Instructions
============
Fork and clone the repository, then open a terminal and cd into the repo folder.
Create a virtual environment with one of the python versions specified for the repo.
Currently those are Python 3.11 and 3.12. Example:
.. code-block:: bash
python3.11 -m venv ../openedx-calc-venv
source ../openedx-calc-venv/bin/activate
Install the dependencies:
.. code-block:: bash
make requirements
Then you can run the tests with just `tox`.
When Upgrading Requirements
---------------------------
Run `make upgrade` to get new versions, and `tox -r` to build the new virtual environment.
Getting Help
************
Documentation
=============
PLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.
.. _the documentation: https://docs.openedx.org/projects/{{cookiecutter.repo_name}}
(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/openedx/openedx-calc/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 version 3 of the AGPL unless otherwise noted.
Please see the `LICENSE`_ file for details.
.. _edx-platform: https://github.com/openedx/edx-platform
.. _LICENSE: https://github.com/openedx/openedx-calc/blob/master/LICENSE
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.
Because this repo is used for a wide variety of mathematical calculations,
including learner grades, it may occasionally be desirable to maintain
bug-for-bug compatibility with previous versions. Additions to the repo
are more likely to be accepted than changes that could alter the outputs
of existing functions.
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/openedx-calc
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/openedx-calc.svg
:target: https://pypi.python.org/pypi/openedx-calc/
:alt: PyPI
.. |ci-badge| image:: https://github.com/openedx/openedx-calc/workflows/Python%20CI/badge.svg?branch=main
:target: https://github.com/openedx/openedx-calc/actions
:alt: CI
.. |codecov-badge| image:: https://codecov.io/github/openedx/openedx-calc/coverage.svg?branch=main
:target: https://codecov.io/github/openedx/openedx-calc?branch=main
:alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/openedx-calc/badge/?version=latest
:target: https://docs.openedx.org/projects/openedx-calc
:alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-calc.svg
:target: https://pypi.python.org/pypi/openedx-calc/
:alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/openedx/openedx-calc.svg
:target: https://github.com/openedx/openedx-calc/blob/main/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
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/openedx-calc",
"name": "openedx-calc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/aa/2f/e233c06258e41e51fa645723641606687f672d69f663fd4a999afc1c3bc0/openedx_calc-4.0.1.tar.gz",
"platform": null,
"description": "openedx-calc\n############\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge|\n\n\nPurpose\n*******\n\nA helper library for mathematical calculations and symbolic mathematics, used by the `edx-platform`_.\n\nThis code originally lived in the `edx-platform`_ repo, but now exists here independently.\n\n\nGetting Started with Development\n********************************\n\nGeneral\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\nInstructions\n============\n\nFork and clone the repository, then open a terminal and cd into the repo folder.\n\nCreate a virtual environment with one of the python versions specified for the repo. \nCurrently those are Python 3.11 and 3.12. Example:\n\n.. code-block:: bash\n\n python3.11 -m venv ../openedx-calc-venv\n source ../openedx-calc-venv/bin/activate\n\nInstall the dependencies:\n\n.. code-block:: bash\n\n make requirements\n\nThen you can run the tests with just `tox`.\n\nWhen Upgrading Requirements\n---------------------------\n\nRun `make upgrade` to get new versions, and `tox -r` to build the new virtual environment.\n\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/{{cookiecutter.repo_name}}\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/openedx/openedx-calc/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 version 3 of the AGPL unless otherwise noted. \nPlease see the `LICENSE`_ file for details.\n\n.. _edx-platform: https://github.com/openedx/edx-platform\n.. _LICENSE: https://github.com/openedx/openedx-calc/blob/master/LICENSE\n\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\nBecause this repo is used for a wide variety of mathematical calculations,\nincluding learner grades, it may occasionally be desirable to maintain\nbug-for-bug compatibility with previous versions. Additions to the repo\nare more likely to be accepted than changes that could alter the outputs\nof existing functions.\n\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/openedx-calc\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/openedx-calc.svg\n :target: https://pypi.python.org/pypi/openedx-calc/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/openedx/openedx-calc/workflows/Python%20CI/badge.svg?branch=main\n :target: https://github.com/openedx/openedx-calc/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/openedx/openedx-calc/coverage.svg?branch=main\n :target: https://codecov.io/github/openedx/openedx-calc?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/openedx-calc/badge/?version=latest\n :target: https://docs.openedx.org/projects/openedx-calc\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-calc.svg\n :target: https://pypi.python.org/pypi/openedx-calc/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/openedx/openedx-calc.svg\n :target: https://github.com/openedx/openedx-calc/blob/main/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",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "A helper library for mathematical calculations and symbolic mathematics, used by Open edX.",
"version": "4.0.1",
"project_urls": {
"Homepage": "https://github.com/openedx/openedx-calc"
},
"split_keywords": [
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f23af40e4adfe30e9618c5fb6a8c2e2de9645e306da9484e3d6068aa93804dda",
"md5": "af268d52fe104cdfdfafcc18aa29bc7f",
"sha256": "ab4b0afbe1f0ad7fee70fc05ff4886dcdec9a75fd4cda6c2aa0f4e350f13cdbd"
},
"downloads": -1,
"filename": "openedx_calc-4.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af268d52fe104cdfdfafcc18aa29bc7f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 36228,
"upload_time": "2024-11-25T13:26:35",
"upload_time_iso_8601": "2024-11-25T13:26:35.183153Z",
"url": "https://files.pythonhosted.org/packages/f2/3a/f40e4adfe30e9618c5fb6a8c2e2de9645e306da9484e3d6068aa93804dda/openedx_calc-4.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aa2fe233c06258e41e51fa645723641606687f672d69f663fd4a999afc1c3bc0",
"md5": "3898d039173e43772a8dd8d28b21b3e4",
"sha256": "05760dbb48745fe00981587243541e1b2a33b34bce05eac41d5be136bbbeeae5"
},
"downloads": -1,
"filename": "openedx_calc-4.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3898d039173e43772a8dd8d28b21b3e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 46960,
"upload_time": "2024-11-25T13:26:36",
"upload_time_iso_8601": "2024-11-25T13:26:36.255060Z",
"url": "https://files.pythonhosted.org/packages/aa/2f/e233c06258e41e51fa645723641606687f672d69f663fd4a999afc1c3bc0/openedx_calc-4.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 13:26:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "openedx-calc",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "openedx-calc"
}
JSON
