rowsmyth 0.1.0__tar.gz

rowsmyth-0.1.0/.gitignore

@@ -0,0 +1,27 @@
+# Python
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+_version.py
+
+# Virtual environments
+.venv
+
+# Tools
+.ruff_cache/
+.ty_cache/
+.mypy_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+site/
+
+# Env
+.env
+*.log
+
+# Testing scratch (private)
+testing/

rowsmyth-0.1.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- commitizen will append entries here on `cz bump` -->
+
+## 0.1.0 (2026-05-25)
+
+### Feat
+
+- `declarative_base()` with rowsmyth capabilities mixed in; accepts `metadata`, `type_annotation_map` and `registry` arguments matching `DeclarativeBase`
+- `generators()` classmethod for co-located factory-boy declarations; keys are column attributes or strings, values are any factory-boy declaration
+- `@variant` decorator for named model variants; returned dicts override specific generators when applied via `.mix()`
+- `Model.factory(n)` / `Model.factory(min, max)` for hierarchical data generation with exact or random-range counts
+- `FactoryBuilder.has(*builders, via=None)` to attach child builders; foreign keys resolved automatically from SQLAlchemy relationship metadata; use `via=` to disambiguate multiple relationships to the same parent
+- `FactoryBuilder.mix(**proportions)` to distribute generated instances across named variants using proportions that sum to <= 1.0; the remainder receives no variant
+- `FactoryBuilder.where(overrides)` to force fixed column values on every generated instance; takes precedence over variants and generators
+- `FactoryBuilder.random_seed(value)` to seed `random` and `Faker` for reproducible output
+- `FactoryBuilder.create()` to generate and persist instances to an in-memory SQLite database; returns a list of root model instances
+- `Base.dataset(*builders)` for flat multi-table generation; rows are created in FK dependency order with foreign keys sampled randomly from the created pool
+- `Dataset.random_seed(value)` to seed `random` and `Faker` for reproducible output
+- `Dataset.create()` to generate and persist instances; returns `dict[str, list[Model]]` keyed by `__tablename__`
+- `Model.__comment__` classproperty for table-level comment from `__table_args__`
+- `Model.__table_info__` classproperty for table-level `info` dict from `__table_args__`
+- `Model.__column_info__` classproperty for per-column `info` dicts, keyed by column name
+- `Model.__expectations__` classproperty for named `CheckConstraint` expressions keyed by constraint name; maps directly to data quality frameworks
+- `Model.__spark_schema__` classproperty to convert the model to a PySpark `StructType` preserving nullability and column metadata; requires `rowsmyth[spark]`

rowsmyth-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to rowsmyth
+
+Thank you for your interest in contributing!
+
+## Prerequisites
+
+- Python 3.12+
+- [uv](https://docs.astral.sh/uv/) - package manager
+- [pre-commit](https://pre-commit.com/) - git hooks
+
+## Setup
+
+```bash
+git clone https://github.com/LaurenceRawlings/rowsmyth.git
+cd rowsmyth
+make install
+```
+
+## Pull requests
+
+PRs are merged via **squash merge** - the PR title becomes the single commit
+on `main`. Keep each PR focused on one type of change so `cz bump` can
+determine the correct version bump from the commit history.
+
+**PR title format:** `type(optional-scope): short description`
+
+Example: `feat: add .where() method to FactoryBuilder`
+
+See the PR template for the full type reference and version bump rules.
+
+## Commit convention
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/).
+The `commit-msg` hook enforces this on local commits automatically.
+
+Commits within a branch are squashed on merge, so local commit messages are
+flexible - what matters is the **PR title**.
+
+| Type | Version bump | When to use |
+|------|-------------|-------------|
+| `feat` | minor | New user-visible feature |
+| `fix` | patch | Bug fix |
+| `feat!` / `fix!` | major | Breaking change (append `!`) |
+| `docs` | none | Documentation only |
+| `style` | none | Formatting, whitespace - no logic change |
+| `refactor` | none | No functional change |
+| `test` | none | Tests only |
+| `perf` | patch | Performance improvement |
+| `build` | none | Build system or dependency changes |
+| `ci` | none | CI/CD configuration changes |
+| `chore` | none | Maintenance not covered by other types |
+| `revert` | patch | Reverts a previous commit |
+
+## Running checks
+
+```bash
+make test        # tests only
+make lint        # ruff check + format check
+make typecheck   # ty strict mode
+make security    # bandit scan
+make pre-commit  # run all pre-commit hooks on all files
+```
+
+## Adding tests
+
+All PRs must maintain **100% test coverage**. If you add or change code, add
+tests that cover it. Docstring examples in `src/` must also be valid doctests -
+run `pytest --doctest-modules src/rowsmyth/` to verify them separately.
+
+## Understanding the codebase
+
+See [docs/design.md](docs/design.md) for an explanation of the internal
+architecture, module responsibilities and data flow.
+
+## Releasing (maintainers only)
+
+```bash
+cz bump
+git push
+git push --tags
+```
+
+`cz bump` reads the commit history, determines the next
+SemVer, updates `CHANGELOG.md` and creates a bump commit + `vX.Y.Z` tag.
+The CD workflow on GitHub Actions handles the rest.

rowsmyth-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Laurence Rawlings
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.