pade

(โ˜… 122)

Python Agent DEvelopment framework

  • .dockerignore
  • .gitignore
  • docker-compose-dev.yml
  • docker-compose.yml
  • LICENSE
  • MIGRACAO_GUIA.md
  • MIGRATION_GUIDE.md
  • pyproject.toml
  • README.md
  • setup.py
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/grei-ufc/pade

Downloads the entire project code from GitHub to your computer.

cd pade

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
$ docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

$ docker compose -f docker-compose-dev.yml up -d

Runs the command against the services defined in the compose file.

$ docker ps

Type this command into your terminal and run it.

$ docker compose exec pade bash

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
$ pip install pade-agents

Installs the Python libraries listed in requirements.txt (or similar).

$ python -m pade.core.new_ams test test@test.com 123 8000

Runs the Python script (or module).

$ python -m pade.core.sniffer 8001

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation