CTFdPy

CTFdPy is an API wrapper for CTFd, a Capture The Flag platform.

It is designed to make it easier to interact with the CTFd API in Python to streamline the setup process for CTFs.

Warning

This tool is still under development. Bugs and breaking changes should be expected.

Getting Started

Installation

Installing from PyPI

To install from PyPI, run the following command:

$ pip install -U ctfdpy

Installing from Source

Warning

Installing from source will pull the latest changes from the repository. This may include new features, bug fixes, or breaking changes. If you want to use a stable version, it is recommended to install from PyPI.

Git clone the repository, and pip install it

$ git clone https://github.com/Jus-Codin/CTFdPy.git

$ cd ctfdpy

$ pip install -e .

Alternatively, you can install it directly from the repository:

$ pip install -U git+https://github.com/Jus-Codin/CTFdPy.git

Example Usage

TODO