edx-submissions

Purpose

submissions is a Django app that defines a common interface for creating submissions and scores.

Getting Started with Development

To install the submissions app, run these commands from the edx-submissions root directory:

pip install -e

To run the test suite:

pip install tox
tox # to run only a single environment, do e.g. tox -e py312-django42-drflatest

To use a Django shell to test commands:

make dev_requirements
python manage.py migrate
python manage.py shell --settings=settings
>>> from submissions.serializers import StudentItemSerializer
>>> <other commands...>

Deploying

Tagged versions of the edx-submissions library are released to pypi.org.

To use the latest release in your project, add the following to your pip requirements file:

edx-submissions

Getting Help

Documentation

Start by going through the documentation (generated from /docs). If you need more help see below.

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/edx-submissions/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 LICENSE.txt 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 have a discussion about your new feature idea with the maintainers prior to 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.

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.