Metadata-Version: 2.1
Name: olympix-test-generator
Version: 1.1
Summary: Used to auto-generate unit tests for smart contracts using the Forge framework.
Home-page: https://github.com/olympix/olympix-test-generator
Author: Evan Fenster
Author-email: evan@olympix.ai
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown

# Olympix Test Generator

Olympix Test Generator is a Python package designed to assist with the generation of unit tests for Solidity smart contracts. These unit tests are specifically designed to be ran through [Foundry](https://book.getfoundry.sh/), a tool for writing unit tests in Solidity. 

## Installation

You can install Olympix Test Generator using pip:

```bash
pip install olympix-test-generator
```

## Usage

The package includes a command-line interface for generating tests.

Before running the script, make sure to set the `OLYMPIX_API_KEY` environment variable in your system.

To generate a test, run:

```bash
olympix generate
```

The tool will guide you through the process of generating the test.

## Project Structure

The project includes the following Python files:

- `client.py`: The main script for interacting with the Olympix DevSecTools API. It includes an interactive command-line interface.

## Dependencies

This project's dependencies are specified in the `requirements.txt` file.
