Metadata-Version: 2.1
Name: pyExecutioner
Version: 0.0.10
Summary: A library to execute code
Home-page: https://github.com/iCodeDevs/EXecutioner
Author: dravog
Author-email: dravog78@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/iCodeDevs/EXecutioner/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Software Development :: Libraries
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# EXecutioner

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/1fab847da8434968bb3c7bdaeae8fcb1)](https://www.codacy.com/gh/iCodeDevs/EXecutioner?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=iCodeDevs/EXecutioner&amp;utm_campaign=Badge_Grade)
![Build](https://github.com/iCodeDevs/EXecutioner/actions/workflows/test.yml/badge.svg)
![Build Docs](https://github.com/iCodeDevs/EXecutioner/actions/workflows/doc.yml/badge.svg)
[![codecov](https://codecov.io/gh/iCodeDevs/EXecutioner/branch/master/graph/badge.svg?token=OTT5WHUS9K)](https://codecov.io/gh/iCodeDevs/EXecutioner)

A python library to execute untrusted code and evaluate the output.

## Requirements

- Python Libraries denoted by requirements.txt

- [FireJail](https://firejail.wordpress.com/) (for FireJail Sandbox)

  ```bash
  sudo apt install firejail
  ```

- The compilers/interpreters for the language of choice (default support: python3, C)

  ```bash
  sudo apt install gcc
  ```

## INSTALLATION FOR DEV

- Clone the repository.

- make a virtual environment named 'venv' inside the repository. (Learn about [venv](https://docs.python.org/3/tutorial/venv.html))

  ```bash
  python -m venv venv
  ```

- access the virtualenv

  ```bash
  source venv/bin/activate
  ```

- install python dev dependencies

  ```bash
  pip install -r requirements.txt
  ```

## Documentation

Documentation can be found at <https://iCodeDevs.github.io/EXecutioner/>


