commit 38d171839302c8fc59c5a1d535bf394ab6c1b56f Author: rob Date: Mon Jan 5 18:51:05 2026 -0400 Initial project setup Created by development-hub/new-project script diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..30c26d7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,53 @@ +# Python +__pycache__/ +*.py[cod] +*$py.class +*.so +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# Virtual environments +.venv/ +venv/ +ENV/ + +# IDE +.idea/ +.vscode/ +*.swp +*.swo + +# OS +.DS_Store +Thumbs.db + +# Testing +.pytest_cache/ +.coverage +htmlcov/ +.tox/ +.nox/ + +# mypy +.mypy_cache/ + +# Local config +.env +*.local.yaml + +# Documentation symlink (points to project-docs) +docs diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..6631e4e --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,49 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +**Directory MapView** - Map-style directory navigator with zoom and pan + +## Development Commands + +```bash +# Install for development +pip install -e ".[dev]" + +# Run tests +pytest + +# Run a single test +pytest tests/test_file.py::test_name +``` + +## Architecture + +*TODO: Describe the project architecture* + +### Key Modules + +*TODO: List key modules and their purposes* + +### Key Paths + +- **Source code**: `src/dir-mapview/` +- **Tests**: `tests/` +- **Documentation**: `docs/` (symlink to project-docs) + +## Documentation + +Documentation for this project lives in the centralized docs system: + +- **Source**: `~/PycharmProjects/project-docs/docs/projects/dir-mapview/` +- **Public URL**: `https://pages.brrd.tech/rob/dir-mapview/` + +When updating documentation: +1. Edit files in `docs/` (the symlink) or the full path above +2. Use `public: true` frontmatter for public-facing docs +3. Use `` / `` to hide sections +4. Run `~/PycharmProjects/project-docs/scripts/build-public-docs.sh dir-mapview --deploy` to publish + +Do NOT create documentation files directly in this repository. diff --git a/README.md b/README.md new file mode 100644 index 0000000..963dfc6 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Directory MapView + +Map-style directory navigator with zoom and pan + +## Installation + +```bash +pip install -e . +``` + +## Usage + +*TODO: Add usage instructions* + +## Documentation + +Full documentation is available at: https://pages.brrd.tech/rob/dir-mapview/ + +## Development + +```bash +# Clone the repository +git clone https://gitea.brrd.tech/rob/dir-mapview.git +cd dir-mapview + +# Create virtual environment +python -m venv .venv +source .venv/bin/activate + +# Install for development +pip install -e ".[dev]" + +# Run tests +pytest +``` + +## License + +*TODO: Add license* diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..03243e1 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,23 @@ +[build-system] +requires = ["setuptools>=61.0", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "dir-mapview" +version = "0.1.0" +description = "Map-style directory navigator with zoom and pan" +readme = "README.md" +requires-python = ">=3.10" +dependencies = [] + +[project.optional-dependencies] +dev = [ + "pytest>=7.0", + "pytest-cov>=4.0", +] + +[tool.setuptools.packages.find] +where = ["src"] + +[tool.pytest.ini_options] +testpaths = ["tests"]