Getting Started

Development Setup

Setting up your environment to develop and test Featuresmith

Featuresmith uses a monorepo structure managed by uv workspaces. Follow this guide to set up a clean, isolated local development environment.

Prerequisites

Python 3.11 or higher installed on your system.
Astral uv installed (see uv docs).
Git for source control.

1. Clone and Sync Workspace

Clone the repository and run uv sync to automatically create a virtual environment and link all local packages:

bash

1git clone https://github.com/adityagangwani30/FeatureSmith.git
2cd FeatureSmith
3uv sync

2. Install Pre-commit Hooks

We use pre-commit hooks to enforce formatting (Ruff) and static typing (Mypy) before code is committed:

bash

1uv run pre-commit install

3. Running Checks and Tests

Ensure your configuration is correct by running the test suite and linters:

bash

1# Run formatting checks
2uv run ruff format . --check
3
4# Run linter checks
5uv run ruff check .
6
7# Run type checks
8uv run mypy .
9
10# Run import boundary constraints
11uv run lint-imports
12
13# Run test suite
14uv run pytest

Windows Environment Note: If pytest encounters permissions or lockout issues with standard system temp directories, point the temp folders directly inside the workspace:$env:TMP=".pytest_tmp"; $env:TEMP=".pytest_tmp"; uv run pytest

Getting Started

Development Setup

Setting up your environment to develop and test Featuresmith

Featuresmith uses a monorepo structure managed by uv workspaces. Follow this guide to set up a clean, isolated local development environment.

Prerequisites

Python 3.11 or higher installed on your system.
Astral uv installed (see uv docs).
Git for source control.

1. Clone and Sync Workspace

Clone the repository and run uv sync to automatically create a virtual environment and link all local packages:

bash

1git clone https://github.com/adityagangwani30/FeatureSmith.git
2cd FeatureSmith
3uv sync

2. Install Pre-commit Hooks

We use pre-commit hooks to enforce formatting (Ruff) and static typing (Mypy) before code is committed:

bash

1uv run pre-commit install

3. Running Checks and Tests

Ensure your configuration is correct by running the test suite and linters:

bash

1# Run formatting checks
2uv run ruff format . --check
3
4# Run linter checks
5uv run ruff check .
6
7# Run type checks
8uv run mypy .
9
10# Run import boundary constraints
11uv run lint-imports
12
13# Run test suite
14uv run pytest