Skip to main content

PyPI CI Codecov Documentation Supported Python versions License 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.

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:

python3.11 -m venv ../openedx-calc-venv
source ../openedx-calc-venv/bin/activate

Install the dependencies:

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.

(TODO: Set up documentation)

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 page.

License

The code in this repository is licensed under version 3 of the AGPL unless otherwise noted. Please see the LICENSE file for details.

Contributing

Contributions are very welcome. Please read 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.

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.

Reporting Security Issues

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

Release files for openedx-calc 5.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openedx-calc 5.0.0
File Size Uploaded
openedx_calc-5.0.0.tar.gz 47.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openedx-calc 5.0.0
File Interpreter ABI Platform
openedx_calc-5.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 83.3 kB

Release files / openedx_calc-5.0.0.tar.gz

Download URL openedx_calc-5.0.0.tar.gz
Size 47.0 kB
Tags Source
SHA-256 checksum
How to use checksums
85cc24c7aa9fc509271a9a644a627b206fb4749220168fccd0dec9a9ffb8ee04
BLAKE2b-256 checksum
How to use checksums
2d554ba1aaeee41c5ccaf3527ba0b68e1d52261a8d3fb3963e2cb2aa86a7ef7b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / openedx_calc-5.0.0-py3-none-any.whl

Download URL openedx_calc-5.0.0-py3-none-any.whl
Size 36.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c7bf87c076965f72956ca28dd7925fe5fc86e173a943948a3100831c0b83e87d
BLAKE2b-256 checksum
How to use checksums
dd0f32ee108169aee03b8abbd9f9d90637b1022e6baae024788b40d563f414f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

5.0.0 This release

2 release files

4.0.3

2 release files

4.0.2

2 release files

4.0.1

2 release files

3.1.2

2 release files

3.1.0

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.0.9

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page