Skip to main content

codejail-includes

Project description

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 git@github.com: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. Even though they were written with edx-platform in mind, the guidelines should be followed for all Open edX projects.

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 security@edx.org.

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.

Change Log

Unreleased

[1.0.0] - 2022-05-17

Added

  • First release on PyPI.

  • codejail includes moved from edx-platform to individual pypi package.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codejail-includes-1.0.0.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

codejail_includes-1.0.0-py2.py3-none-any.whl (25.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file codejail-includes-1.0.0.tar.gz.

File metadata

  • Download URL: codejail-includes-1.0.0.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for codejail-includes-1.0.0.tar.gz
Algorithm Hash digest
SHA256 80b57257141ec51e87cb03e024893176413903c8bff382f7ec47f87c525137c2
MD5 daa745edf9fe41e28aa10cdd2da38c89
BLAKE2b-256 67f279cfdd999539a3a624b7e6ef90263982144ba368dca22b19f701935c7fc1

See more details on using hashes here.

Provenance

File details

Details for the file codejail_includes-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for codejail_includes-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 00b1685761060841e4256f72b9c5ccabc20802193823b8e86fcf0383cef17fc5
MD5 a0d346b63b0e80b4ad55a2e3a246535e
BLAKE2b-256 3eca3ddfb2370dd3ec5350c7af0b08cbbb900e29736fd95d6211076e4b84020c

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page