/openedx-user-manager-api

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

openedx-user-manager-api

PyPI Travis Codecov Documentation Supported Python versions License

openedx-user-manager-api is a Django app for providing a user-manager relationship API in Open edX.

Overview

openedx-user-manager-api uses the pluggable django app pattern to ease installation. To use in edx-platform, simply install the app into your virtualenv.

..code_block:

$ pip install openedx-user-manager-api

Documentation

The full documentation is at https://openedx-user-manager-api.readthedocs.org.

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 for details.

Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

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

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

Reporting Security Issues

Please do not report security issues in public. Please email help@opencraft.com.

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.