-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: updates README using template
See OEP-55 / 0003 README specification
- Loading branch information
1 parent
5d18b75
commit 493506e
Showing
1 changed file
with
107 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,151 @@ | ||
| .. image:: https://github.com/openedx/edx-submissions/workflows/Python%20CI/badge.svg?branch=master | ||
| :target: https://github.com/openedx/edx-submissions/actions?query=workflow%3A%22Python+CI%22 | ||
| :alt: Build status | ||
|
|
||
| .. image:: https://coveralls.io/repos/edx/edx-submissions/badge.png?branch=master | ||
| :target: https://coveralls.io/r/edx/edx-submissions?branch=master | ||
| :alt: Coverage badge | ||
|
|
||
|
|
||
| edx-submissions | ||
| =============== | ||
| ############### | ||
|
|
||
| API for creating submissions and scores. | ||
| |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge| |license-badge| |status-badge| | ||
|
|
||
|
|
||
| Overview | ||
| -------- | ||
| Purpose | ||
| ******* | ||
|
|
||
| ``submissions`` is a Django app that defines a common interface for creating submissions and scores. | ||
|
|
||
| Getting Started with Development | ||
| ******************************** | ||
|
|
||
| Getting Started | ||
| --------------- | ||
|
|
||
| To install the ``submissions`` app: | ||
| To install the ``submissions`` app, run these commands from the `edx-submissions` root directory: | ||
|
|
||
| .. code:: bash | ||
| python setup.py install | ||
| pip install -e | ||
| To run the test suite: | ||
|
|
||
| .. code:: bash | ||
| make test_requirements | ||
| tox # to run only a single environment, do e.g. tox -e py35-django22-drf39 | ||
| pip install tox | ||
| tox # to run only a single environment, do e.g. tox -e py38-django42-drf314 | ||
| To use a Django shell to test commands: | ||
|
|
||
| .. code:: bash | ||
| make dev_requirements | ||
| ./manage.py migrate | ||
| ./manage.py shell --settings=settings | ||
| 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: | ||
|
|
||
| .. code:: bash | ||
| edx-submissions | ||
| Getting Help | ||
| ************ | ||
|
|
||
| Documentation | ||
| ============= | ||
|
|
||
| Start by going through `the documentation`_ (generated from `/docs </docs/source/index.rst>`_). If you need more help see below. | ||
|
|
||
| .. _the documentation: https://docs.openedx.org/projects/edx-submissions | ||
|
|
||
| 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 <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 ``LICENSE.txt`` for details. | ||
| Please see `LICENSE.txt <LICENSE.txt>`_ for details. | ||
|
|
||
|
|
||
| How To Contribute | ||
| ----------------- | ||
| 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 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. | ||
|
|
||
| Please read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`_ for details. | ||
| 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/edx-submissions | ||
|
|
||
| Reporting Security Issues | ||
| ------------------------- | ||
| ************************* | ||
|
|
||
| Please do not report security issues in public. Please email [email protected]. | ||
|
|
||
| .. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-submissions.svg | ||
| :target: https://pypi.python.org/pypi/edx-submissions/ | ||
| :alt: PyPI | ||
|
|
||
| .. |ci-badge| image:: https://github.com/openedx/edx-submissions/actions/workflows/ci.yml/badge.svg?branch=master | ||
| :target: https://github.com/openedx/edx-submissions/actions/workflows/pypi-publish.yml?branch=master | ||
| :alt: CI | ||
|
|
||
| Please do not report security issues in public. Please email [email protected] | ||
| .. |codecov-badge| image:: https://codecov.io/github/openedx/edx-submissions/coverage.svg?branch=master | ||
| :target: https://codecov.io/github/openedx/edx-submissions?branch=master | ||
| :alt: Codecov | ||
|
|
||
| .. |doc-badge| image:: https://readthedocs.org/projects/edx-submissions/badge/?version=latest | ||
| :target: https://docs.openedx.org/projects/edx-submissions | ||
| :alt: Documentation | ||
|
|
||
| Mailing List and IRC Channel | ||
| ---------------------------- | ||
| .. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-submissions.svg | ||
| :target: https://pypi.python.org/pypi/edx-submissions/ | ||
| :alt: Supported Python versions | ||
|
|
||
| You can discuss this code on the `edx-code Google Group`__ or in the | ||
| ``edx-code`` IRC channel on Freenode. | ||
| .. |license-badge| image:: https://img.shields.io/github/license/openedx/edx-submissions.svg | ||
| :target: https://github.com/openedx/edx-submissions/blob/master/LICENSE.txt | ||
| :alt: License | ||
|
|
||
| __ https://groups.google.com/forum/#!forum/edx-code | ||
| .. .. |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 |