coursesapi

Note

This README was auto-generated. Maintainer: please review its contents and update all relevant sections. Instructions to you are marked with "PLACEHOLDER" or "TODO". Update or remove those sections, and remove this note when you are done.

Purpose

Courses API for Open edX.

TODO: The README.rst file should start with a brief description of the repository and its purpose. It should be described in the context of other repositories under the openedx organization. It should make clear where this fits in to the overall Open edX codebase and should be oriented towards people who are new to the Open edX project.

Getting Started

Developing

One Time Setup

# Clone the repository
git clone [email protected]:openedx/coursesapi.git
cd coursesapi

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 coursesapi

Every time you develop something in this repo

# Activate the virtualenv
workon coursesapi

# Grab the latest code
git checkout main
git pull

# Install/update the dev requirements
make requirements

# Run the tests and quality checks (to verify the status before you make any changes)
make validate

# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>

# Using your favorite editor, edit the code to make your change.
vim ...

# Run your new tests
pytest ./path/to/new/tests

# Run all the tests and quality checks
make validate

# Commit all your changes
git commit ...
git push

# Open a PR and ask for review.

Deploying

TODO: How can a new user go about deploying this component? Is it just a few commands? Is there a larger how-to that should be linked here?

PLACEHOLDER: For details on how to deploy this component, see the deployment how-to

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/coursesapi/issues

For more information about these options, see the Getting Help page.

License

The code in this repository is licensed under the AGPL 3.0 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 [email protected].