Skip to main content

Development Setup

Set up your development environment for contributing to Wegent.

Prerequisites​

  • Python 3.8+
  • Git
  • Node.js 18+ (for documentation)
  • Docker (optional)

Clone the Repository​

git clone https://github.com/wecode-ai/Wegent.git
cd Wegent

Set Up Virtual Environment​

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Install Dependencies​

# Install development dependencies
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

Configuration​

Create a local configuration file:

cp config.example.yaml config.local.yaml

Edit config.local.yaml with your settings.

Verify Setup​

Run the test suite:

pytest

IDE Setup​

VS Code​

Recommended extensions:

  • Python
  • Pylance
  • YAML

PyCharm​

Import the project and configure the Python interpreter to use the virtual environment.

Next Steps​