Skip to content

A package that is included during sandboxed codejail operations.

License

Notifications You must be signed in to change notification settings

openedx/codejail-includes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

69c006c · Feb 27, 2024

History

29 Commits
Feb 27, 2024
May 26, 2022
Feb 27, 2024
May 26, 2022
Apr 26, 2023
May 16, 2022
Feb 27, 2024
May 16, 2022
May 26, 2022
Sep 23, 2022
Oct 23, 2023
May 26, 2022
May 26, 2022
May 26, 2022
May 26, 2022
Apr 24, 2023
Sep 14, 2022
May 26, 2022
May 26, 2022
Feb 27, 2024
May 26, 2022
Feb 27, 2024

Repository files navigation

codejail-includes

PyPI License

CodeJail manages execution of untrusted code in secure sandboxes. It is designed primarily for Python execution, but can be used for other languages as well.

Documentation

(TODO: Set up documentation)

Development Workflow

One Time Setup

# Clone the repository
git clone [email protected]:openedx/codejail-includes.git
cd codejail-includes

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

Every time you develop something in this repo

# Activate the virtualenv
workon codejail-includes

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

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.

The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you can find it at PULL_REQUEST_TEMPLATE.md.

The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you can find it at ISSUE_TEMPLATE.md.

Reporting Security Issues

Please do not report security issues in public. Please email [email protected].

Getting 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 more information about these options, see the Getting Help page.