Lewati ke konten utama

Development Setup

Development Setup

Python 3.14+

Buat isolated editable environment untuk mengembangkan dan menguji Custy.

Commandpip install -e .[dev]

Category

Developer Guide

Quick Command

python -m pip install -e .[dev]
editable installpytestRuffBlackpre-commit

Requirements​

Before You Begin

  • Python 3.14+Required

    Gunakan interpreter yang memenuhi project metadata.

  • GitRequired

    Diperlukan source checkout dan Custy workflows.

  • pip and venvRequired

    Install dependencies dalam isolated environment.

Manual Setup​

Terminal
bash
python -m venv venv
# Activate the environment for your shell
venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

Makefile Setup​

Make helpers menggunakan interpreter dari directory venv/. Jalankan make setup untuk combined setup atau gunakan target individual ketika ingin mengontrol setiap tahap.

Terminal
bash
make venv
make upgrade-pip
make install-dev

# Combined setup termasuk development tools dan Git hook

make setup

Pre-Commit Workflow​

Gunakan target berikut untuk setup dan pemeriksaan harian tanpa mengingat module invocation internal.

Terminal
bash
# Install Git hook dan isolated hook environments
make pre-commit-install-hooks

# Validate .pre-commit-config.yaml

make pre-commit-validate

# Check staged files

make pre-commit-run-staged

# Check semua tracked files

make pre-commit-run

Verify the Environment​

Terminal
bash
custy --help
python -m pytest --version
python -m ruff --version
python -m black --version
python -m pre_commit --version

Related Commands

Commands commonly used together with this command.

Docker

Gunakan container workflow.