README.md

Cybersecurity Institute Hackathon 2024

Welcome to the Second Annual Cybersecurity Institute Hackathon 2024. We will be using this repository to contain our RescueBox "tool-suite".

Getting Started

Step 1: Forking this repository

Begin by forking this repository to your GitHub account.

Step 2: Create a directory for your open-source trust and safety tool

Under the directory tool-suite, create a directory for your project. For example, this could be tool-suite/deep-fake-classification.

Step 3: Start Hacking!

See the development section for more help on project setup.

Step 4: Submit a PR back to this repository

When you're done, submit a PR back to this repository, so we can have everyone's tools ready to go!

Development

Create a virtual environment

python -m venv env

This uses venv to create a new virutal envrionment for you.

Activate the virtual envrionment

source env/bin/activate

Installing dependencies

Create a requirements.txt under your tool. For example, tool-suite/deep-fake-classification/requirements.txt

Then, run

pip install -e ".[dev]"

followed by

pip install -r tool-suite/deep-fake-classification/requirements.txt

Flask-ML

This repository already contains a copy of the Python library FlaskML. Check out the website for more examples and usage documentation: https://umass-rescue.github.io/Flask-ML/