Skip to content

Latest commit

 

History

History
264 lines (180 loc) · 4.84 KB

development.md

File metadata and controls

264 lines (180 loc) · 4.84 KB

Development Setup

This guide will help you set up a development environment for contributing to StructKit.

Prerequisites

  • Python 3.8 or higher
  • Git
  • Virtual environment tool (venv, virtualenv, or conda)

Getting Started

1. Clone the Repository

git clone https://github.com/httpdss/structkit.git
cd struct

2. Create a Virtual Environment

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

3. Install Dependencies

# Install runtime dependencies
pip install -r requirements.txt

# Install development dependencies
pip install -r requirements.dev.txt

# Install the package in development mode
pip install -e .

4. Verify Installation

structkit --help

Development Workflow

Running Tests

# Run all tests
pytest

# Run tests with coverage
pytest --cov=structkit

# Run specific test file
pytest tests/test_specific.py

Code Quality

This project uses several tools to maintain code quality:

# Format code with black
black .

# Sort imports
isort .

# Lint with flake8
flake8 .

# Type checking with mypy
mypy structkit/

Pre-commit Hooks

Install pre-commit hooks to automatically run quality checks:

pre-commit install

This will run formatting, linting, and tests before each commit.

Project Structure

struct/
├── structkit/          # Main Python package
│   ├── commands/          # CLI command implementations
│   ├── contribs/          # Built-in structure templates
│   └── ...
├── tests/                 # Test files
├── docs/                  # Documentation
├── example/               # Example configurations
├── scripts/               # Utility scripts
└── requirements*.txt      # Dependencies

Adding New Features

1. Create a New Command

Commands are defined in structkit/commands/. Each command should:

  • Inherit from a base command class
  • Include proper argument parsing
  • Have comprehensive tests
  • Include documentation

Example:

# structkit/commands/my_command.py
from .base import BaseCommand

class MyCommand(BaseCommand):
    def add_arguments(self, parser):
        parser.add_argument('--option', help='My option')

    def handle(self, args):
        # Implementation here
        pass

2. Add Structure Templates

New structure templates go in structkit/contribs/. Each template should:

  • Have a clear directory structure
  • Provide good documentation
  • Include example usage

3. Write Tests

All new functionality must include tests:

# tests/test_my_feature.py
import pytest
from structkit.my_feature import MyFeature

def test_my_feature():
    feature = MyFeature()
    result = feature.do_something()
    assert result == expected_value

4. Update Documentation

  • Add or update relevant documentation in docs/
  • Add examples if applicable

Testing

Unit Tests

Run unit tests to verify individual components:

pytest tests/unit/

Integration Tests

Run integration tests to verify end-to-end functionality:

pytest tests/integration/

Debugging

Enable Debug Logging

structkit --log=DEBUG generate my-config.yaml ./output

Use Python Debugger

Add breakpoints in your code:

import pdb; pdb.set_trace()
structkit --log=DEBUG generate my-config.yaml ./output

Contributing Guidelines

Code Style

  • Follow PEP 8
  • Use type hints where appropriate
  • Write docstrings for public functions
  • Keep functions small and focused

Commit Messages

Use conventional commit format:

feat: add new template variable filter
fix: resolve issue with file permissions
docs: update installation guide
test: add tests for mappings functionality

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Make your changes
  4. Write tests
  5. Update documentation
  6. Submit a pull request

Review Process

All pull requests must:

  • Pass all tests
  • Include appropriate documentation
  • Follow code style guidelines
  • Have a clear description of changes

Troubleshooting

Common Issues

Import errors: Make sure you've installed the package in development mode:

pip install -e .

Test failures: Ensure all dependencies are installed:

pip install -r requirements.dev.txt

Permission errors: Check file permissions and ensure you're in the right directory.

Getting Help

  • Check existing issues on GitHub
  • Join our Discord community
  • Read the documentation thoroughly
  • Ask questions in discussions

Resources