Skip to content

DEV_TOOLS.md

Latest commit

 

History

History
137 lines (93 loc) · 2.37 KB

DEV_TOOLS.md

File metadata and controls

137 lines (93 loc) · 2.37 KB

Development Tools

This project uses various tools to maintain code quality:

Quick Setup

To quickly configure the development environment:

make setup

Development Dependencies Installation

# Production dependencies only
make install

# Development dependencies
make install-dev

Pre-commit Hooks

Pre-commit hooks are automatically executed on each commit to verify code quality.

Installation

make pre-commit-install

Manual execution on all files

make pre-commit

Formatting and Linting

Automatic formatting

make format

Complete linting

make lint

Auto-fix linting issues

make lint-fix

Tests

Running tests

make test

Tests with coverage

make test-cov

Available Makefile Commands

  • make setup - Sets up the complete development environment
  • make install - Installs production dependencies
  • make install-dev - Installs development dependencies
  • make format - Formats code with black and isort
  • make lint - Runs all linting checks
  • make lint-fix - Runs linting and automatically fixes issues
  • make test - Runs tests
  • make test-cov - Runs tests with coverage
  • make pre-commit - Runs pre-commit on all files
  • make pre-commit-install - Installs pre-commit hooks
  • make clean - Cleans cache and temporary files

Linting and Formatting Tools

Ruff - Code formatting

ruff format edge_mining/

Ruff - Linting

ruff check edge_mining/

Use the option --ignore=E501 to disable line length checks.

ruff check edge_mining/ --ignore=E501

mypy - Type checking

mypy edge_mining/

bandit - Security check

bandit -r edge_mining/

Configurations

  • .pre-commit-config.yaml: Pre-commit hooks configuration
  • pyproject.toml: Configuration for mypy, ruff, bandit, pytest and coverage
  • requirements-dev.txt: Development dependencies
  • Makefile: Automation commands

Troubleshooting

If pre-commit doesn't work properly:

  1. Make sure git is initialized: git init
  2. Reinstall pre-commit: make pre-commit-install
  3. Update hooks: pre-commit autoupdate

If you have dependency issues:

  1. Clean the environment: make clean
  2. Recreate the virtual environment: python -m venv .venv
  3. Reinstall dependencies: make setup