pytmodules 0.1.0__tar.gz

pytmodules-0.1.0/.gitignore

@@ -0,0 +1,61 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+dist/
+downloads/
+.eggs/
+*.egg-info/
+*.egg
+MANIFEST
+pip-wheel-metadata/
+
+# Unit test / coverage reports
+.pytest_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.hypothesis/
+.tox/
+.nox/
+
+# Type checkers / linters caches
+.mypy_cache/
+.pyre/
+.pytype/
+.ruff_cache/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+.pymodenv/
+.python-version
+
+# IDE / editor
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS files
+.DS_Store
+
+# Local docs builds
+docs/_build/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Logs
+*.log
+
+# Misc local/temp artifacts
+tmp/

pytmodules-0.1.0/CHANGELOG.md

@@ -0,0 +1,50 @@
+# 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.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [Unreleased]
+
+---
+
+## [0.1.0] - 2026-03-19
+
+### Added
+
+- Framework-agnostic `ModuleRegistry`, `Module`, and `ServiceProvider` core
+- Auto-detection of Django, FastAPI, Flask from your project environment
+- Auto-selection of the `django-api` scaffold preset when Django REST Framework is detected
+- `pymodules` CLI: `init`, `make`, `list`, `enable`, `disable`, `show`, `delete`, `publish`, `detect`, `presets`
+- Django `manage.py` integration commands:
+  - `module_make` — scaffold a new module
+  - `module_list` — list all modules and their status
+  - `module_enable` / `module_disable` — toggle modules at runtime
+  - `module_show` — inspect a module's manifest
+  - `module_delete` — remove a module from disk
+  - `module_publish` — publish module assets to the host app
+  - `module_make_model` — create a lightweight, non-bloated model file
+  - `module_make_serializer` — create Django REST Framework serializers for a model
+  - `module_make_viewset` — create Django REST Framework viewsets for a model
+  - `module_make_api_urls` — create or extend router-based API URL wiring for a module
+  - `module_make_model_migration` — create a migration targeting a specific model
+  - `module_make_migration` — run `makemigrations` scoped to one module
+  - `module_migrate` — run `migrate` scoped to one module (or all)
+- Eight scaffold presets: `plain`, `default`, `django`, `django-api`, `fastapi`, `fastapi-crud`, `flask`, `flask-api`
+- Per-project configuration via `pymodules.toml`
+- `module.json` manifest with versioning, enable/disable, provider registration, and dependency declarations
+- Service Provider pattern with two-phase `register` → `boot` lifecycle
+- Module dependency declarations (`requires`) with topological boot ordering
+- Circular and missing dependency detection with actionable error messages
+- Module-level settings merged into Django `settings` via `collect_settings()`
+- Module-level URL routing for Django, Flask, and FastAPI
+- Module-level Django API routing via `api/urls.py` discovery and mounting
+- Module-level Django migrations with `MIGRATION_MODULES` auto-configuration
+- Asset publishing system
+- Python 3.10, 3.11, 3.12, 3.13 support
+
+[Unreleased]: https://github.com/tomcroot/pymodules/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/tomcroot/pymodules/releases/tag/v0.1.0

pytmodules-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,124 @@
+# Contributing to pymodules
+
+Thank you for your interest in contributing! This document covers how to set up your development environment, run tests, and submit changes.
+
+---
+
+## Before You Start
+
+Please **open an issue first** to discuss what you would like to change. This avoids wasted effort if the direction doesn't align with the project's goals.
+
+---
+
+## Development Setup
+
+**Requirements:** Python 3.10+, Git
+
+```bash
+# 1. Fork and clone
+git clone https://github.com/tomcroot/pymodules
+cd pymodules
+
+# 2. Create a virtual environment
+python -m venv .venv
+source .venv/bin/activate   # Windows: .venv\Scripts\activate
+
+# 3. Install in editable mode with all dev dependencies
+pip install -e ".[dev]"
+
+# 4. Verify everything works
+pytest
+```
+
+---
+
+## Running Tests
+
+```bash
+# All tests
+pytest
+
+# With coverage
+pytest --cov=pymodules --cov-report=term-missing
+
+# Single test file
+pytest tests/test_pymodules.py -v
+```
+
+The test suite must pass on all supported Python versions (3.10–3.13) before a PR is merged. CI runs automatically on every push and pull request.
+
+---
+
+## Branch Naming
+
+| Type | Pattern | Example |
+|------|---------|---------|
+| Feature | `feat/<short-description>` | `feat/module-groups` |
+| Bug fix | `fix/<short-description>` | `fix/django-routes-import` |
+| Documentation | `docs/<short-description>` | `docs/fastapi-guide` |
+| Chore / tooling | `chore/<short-description>` | `chore/update-ci` |
+
+---
+
+## Commit Messages
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+feat: add module_make_view command
+fix: correct provider boot order when dependency missing
+docs: update Django integration example
+chore: bump pytest to 8.0
+```
+
+---
+
+## Pull Request Requirements
+
+- [ ] Tests pass (`pytest`)
+- [ ] New behaviour is covered by tests
+- [ ] `CHANGELOG.md` updated under `[Unreleased]`
+- [ ] No `yourname` / placeholder text in any file
+- [ ] PR description explains what changed and why
+
+---
+
+## Project Structure
+
+```
+pymodules/
+├── __init__.py           — public API
+├── module.py             — Module model
+├── registry.py           — ModuleRegistry (boot orchestration)
+├── generator.py          — scaffold presets
+├── provider.py           — ServiceProvider base
+├── detector.py           — framework auto-detection
+├── exceptions.py         — custom exception hierarchy
+├── commands/             — pymodules CLI (Click)
+├── integrations/         — Django / Flask / FastAPI adapters
+└── management/           — Django manage.py commands
+    └── commands/
+        ├── module_make_model.py
+        ├── module_make_model_migration.py
+        ├── module_make_migration.py
+        └── module_migrate.py
+tests/
+└── test_pymodules.py
+```
+
+---
+
+## Reporting Bugs
+
+Open a GitHub issue and include:
+
+- Python version (`python --version`)
+- pymodules version
+- Minimal reproduction case
+- Full traceback
+
+---
+
+## License
+
+By contributing you agree that your contributions will be licensed under the [MIT License](LICENSE).

pytmodules-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tomcroot
+
+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.