Metadata-Version: 2.4
Name: ctfdpy
Version: 0.1.0a1
Summary: A python wrapper around the CTFd API
Author-email: JusCodin <70018166+Jus-Codin@users.noreply.github.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Requires-Dist: httpx>=0.28.1
Requires-Dist: pydantic[email]>=2.10.6
Requires-Dist: typing-extensions>=4.12.2
Description-Content-Type: text/markdown

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

```console
$ 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

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

$ cd ctfdpy

$ pip install -e .
```

Alternatively, you can install it directly from the repository:

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

### Example Usage
TODO