From 3521d44071d68a72f879ad50bb17c9cc5819487e Mon Sep 17 00:00:00 2001 From: rob Date: Wed, 7 Jan 2026 03:37:49 -0400 Subject: [PATCH] Initial project setup Created by development-hub/new-project script --- .gitignore | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++ CLAUDE.md | 48 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 39 +++++++++++++++++++++++++++++++++++++ pyproject.toml | 23 ++++++++++++++++++++++ 4 files changed, 163 insertions(+) create mode 100644 .gitignore create mode 100644 CLAUDE.md create mode 100644 README.md create mode 100644 pyproject.toml 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..39bcc8e --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,48 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +**GhostQA** - AI-powered visual GUI testing via natural language + +## 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/ghostqa/` +- **Tests**: `tests/` +- **Documentation**: `docs/` (symlink to project-docs) + +## Documentation + +Documentation lives in `docs/` (symlink to centralized docs system). + +**Before updating docs, read `docs/updating-documentation.md`** for full details on visibility rules and procedures. + +Quick reference: +- Edit files in `docs/` folder +- Use `public: true` frontmatter for public-facing docs +- Use `` / `` to hide sections +- Deploy: `~/PycharmProjects/project-docs/scripts/build-public-docs.sh ghostqa --deploy` + +Do NOT create documentation files directly in this repository. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5826cca --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# GhostQA + +AI-powered visual GUI testing via natural language + +## Installation + +```bash +pip install -e . +``` + +## Usage + +*TODO: Add usage instructions* + +## Documentation + +Full documentation is available at: https://pages.brrd.tech/rob/ghostqa/ + +## Development + +```bash +# Clone the repository +git clone https://gitea.brrd.tech/rob/ghostqa.git +cd ghostqa + +# 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..71686c0 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,23 @@ +[build-system] +requires = ["setuptools>=61.0", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "ghostqa" +version = "0.1.0" +description = "AI-powered visual GUI testing via natural language" +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"]