moltpy 0.1.0__tar.gz

moltpy-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve MoltPy
+title: '[BUG] '
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Run command '...'
+2. Select modules '....'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Generated project structure**
+If applicable, share the relevant parts of the generated project.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Ubuntu 22.04, macOS 14]
+ - Python version: [e.g. 3.12]
+ - MoltPy version: [e.g. 0.1.0]
+ - Installation method: [e.g. pip, uv]
+
+**Additional context**
+Add any other context about the problem here.

moltpy-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for MoltPy
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

moltpy-0.1.0/.github/ISSUE_TEMPLATE/module_proposal.md

@@ -0,0 +1,26 @@
+---
+name: Module proposal
+about: Propose a new module for MoltPy
+title: '[MODULE] '
+labels: module
+assignees: ''
+
+---
+
+**Module name**
+A short, descriptive name for the module.
+
+**What does this module provide?**
+Describe the functionality this module adds to generated projects.
+
+**Why should this be built-in?**
+Explain why this module is generally useful for FastAPI projects.
+
+**Dependencies**
+List any modules this module implies or conflicts with.
+
+**Example usage**
+Show how a generated project would use this module.
+
+**Additional context**
+Add any other context, links, or examples here.

moltpy-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+## Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] New module
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project (run `uv run ruff check .` and `uv run ruff format .`)
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes (`uv run pytest`)
+- [ ] Any dependent changes have been merged and published
+
+## Testing
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

moltpy-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Lint with ruff
+        run: uv run ruff check .
+
+      - name: Type check with mypy
+        run: uv run mypy src/
+
+      - name: Run fast tests with coverage
+        run: uv run pytest -m "not slow" --cov=moltpy --cov-report=term-missing
+
+      - name: Build wheel
+        run: uv build
+
+  e2e-presets:
+    runs-on: ubuntu-latest
+    needs: test
+    strategy:
+      fail-fast: false
+      matrix:
+        preset: [minimal, standard, full-stack, microservice]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run E2E tests for ${{ matrix.preset }} preset
+        run: uv run pytest -m slow -k "test_preset_passes_full_toolchain and ${{ matrix.preset }}" -v
+
+  e2e-other:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run other slow E2E tests
+        run: uv run pytest -m slow -k "not test_preset_passes_full_toolchain" -v

moltpy-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Build wheel
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing always
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true

moltpy-0.1.0/.gitignore

@@ -0,0 +1,62 @@
+# Generated by Moltpy
+.venv/
+__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
+
+# Environment
+.env
+.venv
+env/
+venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Database
+*.db
+*.sqlite3
+
+# Logs
+*.log
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Docker
+.dockerignore
+!src/moltpy/modules/docker/templates/.dockerignore
+
+# Generated test projects
+test_*/
+*.lock
+digest.txt
+ROADMAP*.md

moltpy-0.1.0/.hypothesis/.gitignore

@@ -0,0 +1,9 @@
+# This .gitignore file was automatically created by Hypothesis. Hypothesis gitignores
+# .hypothesis by default, because we generally recommend that .hypothesis not be checked
+# into version control.
+#
+# If you *would* like to check .hypothesis into version control, you should delete this
+# file. Hypothesis will not re-create this .gitignore unless .hypothesis is deleted (and
+# if it does, that's a bug - please report it!)
+
+*

moltpy-0.1.0/.hypothesis/constants/04ccad45c547ba0d

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/presets.py
+# hypothesis_version: 6.152.5
+
+['*.json', '.config', '3.12', 'admin', 'api_versioning', 'auth', 'auth_social', 'celery', 'cors', 'database', 'docker', 'docs', 'email', 'events', 'full-stack', 'github_actions', 'graphql', 'grpc', 'health', 'kubernetes', 'logging', 'makefile', 'microservice', 'minimal', 'moltpy', 'notifications', 'observability', 'openapi', 'pagination', 'payments', 'pre_commit', 'presets', 'project', 'rate_limit', 'redis', 'scheduler', 'search', 'seeding', 'sentry', 'standard', 'storage', 'terraform', 'testing', 'users', 'websockets']

moltpy-0.1.0/.hypothesis/constants/32d48f415bb3914c

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/__init__.py
+# hypothesis_version: 6.152.5
+
+['0.1.0', '__version__']

moltpy-0.1.0/.hypothesis/constants/34257138be99f921

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/wizard.py
+# hypothesis_version: 6.152.5
+
+['3.10', '3.11', '3.12', '3.13', 'Choose a preset', 'Project description', 'Python version', '[dim](auto)[/dim]', '[green]✓[/green]', '_', 'blue', 'bool', 'choice', 'custom', 'git_init', 'int', 'pre_commit_install', 'uv_sync']

moltpy-0.1.0/.hypothesis/constants/34a945045c8f5e1c

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/builder.py
+# hypothesis_version: 6.152.5
+
+[1024, '   make run-dev', '   uv sync', '*.py', '-m', '.', '.env', '.env.example', 'File', 'POSTGRES_PASSWORD=.*', 'PYTHONPATH', 'Running uv sync...', 'SECRET_KEY=.*', 'Size', 'Source', 'VIRTUAL_ENV', 'add', 'commit', 'cyan', 'dim', 'docker', 'email', 'git', 'git_init', 'green', 'init', 'install', 'observability', 'openapi', 'pre-commit', 'pre_commit_install', 'right', 'run', 'sync', 'terraform', 'uv', 'uv_sync']

moltpy-0.1.0/.hypothesis/constants/67b0a8ccf18bf5d2

@@ -0,0 +1,4 @@
+# file: /usr/lib/python3.12/sitecustomize.py
+# hypothesis_version: 6.152.5
+
+[]

moltpy-0.1.0/.hypothesis/constants/7333d4e14de2dcfe

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/modules/base.py
+# hypothesis_version: 6.152.5
+
+['snippets', 'static', 'templates']

moltpy-0.1.0/.hypothesis/constants/79232dc5a8b150ab

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/external.py
+# hypothesis_version: 6.152.5
+
+[120, '#', '--branch', '--depth', '.cache', '.config', '/', '1', '@', 'XDG_CACHE_HOME', 'XDG_CONFIG_HOME', 'clone', 'git', 'github:', 'github_modules', 'main', 'manifest.json', 'modules', 'moltpy']

moltpy-0.1.0/.hypothesis/constants/7fa87bd09966148a

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/cli.py
+# hypothesis_version: 6.152.5
+
+[',', ', ', '--config-file', '--description', '--dry-run', '--force', '--modules', '--name', '--no-interactive', '--output', '--preset', '--python-version', '--refresh-modules', '--skip-alembic', '--target', '--template-dir', '-d', '-f', '-m', '-n', '-o', '-p', '-t', '3.12', 'Output file path', 'Preset description', 'Preset name', 'Project description', 'Project name', 'Python version', 'Target directory', '[dim](custom)[/dim]', '_', '__main__', 'delete', 'fields', 'full-stack', 'github:', 'info', 'init-config', 'list', 'microservice', 'minimal', 'model_name', 'modules', 'moltpy', 'moltpy.yaml', 'my_project', 'name', 'project', 'resource', 'save', 'standard']

moltpy-0.1.0/.hypothesis/constants/86a2776199f98a65

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/config.py
+# hypothesis_version: 6.152.5
+
+['  []', '  {}', '# Modules to include', '.json', '.yaml', '.yml', '3.10', '3.11', '3.12', '3.13', 'Default value', 'Preset configuration', 'Preset description', 'Preset name', 'Project description', '^[a-z][a-z0-9_]*$', 'after', 'choice', 'external_modules:', 'forbid', 'git_init', 'module_variables:', 'modules:', 'name', 'post_generation:', 'pre_commit_install', 'python_version', 'uv_sync']

moltpy-0.1.0/.hypothesis/constants/90804030db72529a

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/.venv/bin/pytest
+# hypothesis_version: 6.152.5
+
+['-script.pyw', '.exe', '__main__']

moltpy-0.1.0/.hypothesis/constants/94a22bcc563fcd2c

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/generator.py
+# hypothesis_version: 6.152.5
+
+['""', '"Long text content"', '"Test value"', '"Updated long text"', '"Updated value"', '(.)([A-Z][a-z]+)', '([a-z0-9])([A-Z])', ', ', '-', '--autogenerate', '--fix', '-m', '.py', '3.14', '42', '6.28', '99', ':', 'Boolean', 'False', 'Float', 'Integer', 'JSON', 'String(255)', 'Text', 'True', 'UUID', '\\1_\\2', '_', '__init__.py', 'aeiou', 'alembic', 'alembic.ini', 'api', 'api.py', 'app', 'app/', 'bool', 'ch', 'check', 'child', 'children', 'database.py', 'datetime', 'dict[str, Any]', 'es', 'exec', 'feet', 'fields', 'float', 'foot', 'format', 'geese', 'generator_templates', 'goose', 'ies', 'int', 'json', 'main.py', 'man', 'men', 'mice', 'model.py.j2', 'models', 'mouse', 'ox', 'oxen', 'pascal_name', 'people', 'person', 'plural_name', 'python_imports', 'return app', 'revision', 'router.py.j2', 'routers', 'ruff', 'run', 's', 'schema.py.j2', 'schemas', 'service.py.j2', 'services', 'sh', 'snake_name', 'sqlalchemy_imports', 'str', 'teeth', 'test_api.py.j2', 'tests', 'tests/', 'text', 'tooth', 'uuid', 'uv', 'v1', 'woman', 'women', 'x', 'y', 'z', '{"key": "value"}', '{"updated": true}']

moltpy-0.1.0/.hypothesis/constants/dcfc11e80df68bc7

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/registry.py
+# hypothesis_version: 6.152.5
+
+['manifest.json', 'module.py', 'modules']

moltpy-0.1.0/.hypothesis/constants/f7f0660e4e4feaa9

@@ -0,0 +1,4 @@
+# file: /home/runner/work/moltpy/moltpy/src/moltpy/renderer.py
+# hypothesis_version: 6.152.5
+
+['# moltpy:SNIPPETS', '(.)([A-Z][a-z]+)', '([a-z0-9])([A-Z])', '*', '*.j2', '-', '.j2', '\\1-\\2', '\\1_\\2', '_', '__init__.py', 'config', 'core', 'description', 'has_module', 'manifest', 'modules', 'modules_info', 'name', 'project', 'python_version', 'snippet', 'snippets', 'static', 'templates', 'to_kebab_case', 'to_pascal_case', 'to_snake_case', 'utf-8', 'variables']

moltpy-0.1.0/AGENTS.md

@@ -0,0 +1,103 @@
+# MoltPy — Agent Context
+
+Moltpy is a Python CLI tool (`moltpy`) that generates production-ready FastAPI project templates from Jinja2 modules.
+
+## Developer Commands
+
+Always use `uv`, never `pip`:
+
+```bash
+# Install dependencies
+uv sync --extra dev
+
+# Run tests (fast)
+uv run pytest
+
+# Run with coverage
+uv run pytest --cov=moltpy --cov-report=term-missing
+
+# Lint → format → typecheck (CI order)
+uv run ruff check .
+uv run ruff format .
+uv run mypy src/
+
+# Build wheel
+uv build
+```
+
+## Running Tests Selectively
+
+```bash
+# Exclude slow E2E tests that run full toolchain inside generated projects
+uv run pytest -m "not slow"
+
+# Run only slow golden-path tests
+uv run pytest -m slow
+
+# Run a single test file
+uv run pytest tests/test_builder.py
+```
+
+## Architecture
+
+- **Entry point**: `src/moltpy/cli.py:main` — Click CLI with subcommands `new`, `generate`, `modules`, `preset`, `init-config`
+- **Builder**: `src/moltpy/builder.py` — orchestrates render → validate → .env generation → post-generation hooks
+- **Renderer**: `src/moltpy/renderer.py` — Jinja2 sandboxed environment; renders `templates/`, module `templates/`, `snippets/`, and `static/`
+- **Registry**: `src/moltpy/registry.py` — discovers modules, resolves `implies` dependencies topologically, validates `conflicts`
+- **Generator**: `src/moltpy/generator.py` — day-2 CRUD resource scaffolding (`moltpy generate resource`)
+- **Config**: `src/moltpy/config.py` — Pydantic models for `ProjectConfig`, `ModuleManifest`, `Preset`
+
+### Module Layout
+
+Each module lives in `src/moltpy/modules/<name>/`:
+
+```
+<name>/
+  manifest.json      # name, description, category, implies, conflicts, variables
+  module.py          # Optional BaseModule subclass with pre_render / post_render hooks
+  templates/         # Jinja2 files rendered into the project (.j2 suffix stripped)
+  snippets/          # Small fragments injected into shared files via MOLTPY:SNIPPETS markers
+  static/            # Copied as-is
+```
+
+Core templates (always rendered) are in `src/moltpy/templates/`.
+
+## Key Conventions & Gotchas
+
+- **Template syntax**: All templates use `.j2` extension; output name has `.j2` stripped. Static files have no `.j2`.
+- **Snippet markers**: Snippets inject at `<!-- MOLTPY:SNIPPETS -->` or `# MOLTPY:SNIPPETS`. The builder runs `_cleanup_markers` to remove any leftovers. Tests enforce no leftover markers via `assert_no_leftover_markers`.
+- **Python validation**: Every generated `.py` file is compiled with `py_compile` before the build finishes. Syntax errors fail the build.
+- **`.env` generation**: `.env.example` is rendered first; then the builder replaces `SECRET_KEY=...` and `POSTGRES_PASSWORD=...` with cryptographically secure random values and writes `.env`. Existing `.env` is never overwritten.
+- **Post-generation hooks**: Controlled by `post_generation` in config (`uv_sync`, `git_init`, `pre_commit_install`). The builder strips `VIRTUAL_ENV` and `PYTHONPATH` from the environment before running subprocess hooks to avoid contaminating the generated project.
+- **External modules**: Load from `github:user/repo#module-name` or `~/.config/moltpy/modules/`. GitHub modules are cloned to a cache dir and reloaded with `--refresh-modules`.
+- **Template overrides**: `--template-dir` provides user templates that override built-ins. Override templates are validated with Jinja2 parse at load time.
+- **Presets**: Built-ins are `minimal`, `standard`, `full-stack`, `microservice`. User presets are stored in `~/.config/moltpy/presets/` as JSON and can override built-ins.
+- **Custom Jinja filters**: `to_snake_case`, `to_pascal_case`, `to_kebab_case` are available in all templates.
+
+## Testing Patterns
+
+- **Unit tests**: `tests/test_*.py` — test individual components in isolation.
+- **Snapshot tests**: `tests/test_snapshots.py` uses `syrupy` to snapshot the full generated file tree. Use `scrub_snapshot()` to redact non-deterministic secrets before snapshot comparison.
+- **E2E tests**: `tests/test_end_to_end.py` generates full projects and asserts:
+  - File existence and valid Python syntax (`compile()`)
+  - Valid `pyproject.toml` (TOML parse)
+  - Valid YAML, JSON, Makefile, Dockerfile, Terraform, INI, proto, and HTML email templates
+  - **Dynamic execution**: For `standard` preset, the test runs `uv sync`, `ruff format`, `ruff check --fix`, `mypy app/`, and `pytest` inside the generated project. Set `DATABASE_URL=sqlite+aiosqlite:///:memory:` for these.
+  - **Resource generator E2E**: Generates a `standard` project, injects a new resource, runs `uv sync` and `ruff check`, then runs the generated project's `pytest`.
+- **Slow marker**: Tests that invoke `uv sync` or subprocess toolchains inside generated projects are marked `@pytest.mark.slow`. CI runs all tests; local dev usually skips slow with `-m "not slow"`.
+- **Helpers**: `tests/_helpers.py` provides `read_project_tree()`, `scrub_snapshot()`, `assert_no_leftover_markers()`.
+
+## Style & Tooling
+
+- **Ruff**: `line-length = 100`, target Python 3.10+. Rules: E, F, I, N, W, UP, B, C4, SIM.
+- **MyPy**: `strict = true`, target Python 3.10.
+- **pytest**: `testpaths = ["tests"]`.
+
+## CI
+
+`.github/workflows/ci.yml` runs on Python 3.10–3.13:
+1. `uv sync --extra dev`
+2. `uv run ruff check .`
+3. `uv run mypy src/`
+4. `uv run pytest --cov=moltpy --cov-report=term-missing`
+5. `uv build`

moltpy-0.1.0/CHANGELOG.md

@@ -0,0 +1,33 @@
+# 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).
+
+## [Unreleased]
+
+### Added
+- Initial project scaffolding with module-based architecture
+- CLI commands: `new`, `generate`, `modules`, `preset`, `init-config`
+- 36 built-in modules covering auth, database, infrastructure, observability, and more
+- Preset system: `minimal`, `standard`, `full-stack`, `microservice`
+- External module support from GitHub and local paths
+- Interactive configuration wizard
+- Day-2 CRUD resource generator
+- Sandboxed Jinja2 template rendering with snippet injection
+- Post-generation hooks: `uv_sync`, `git_init`, `pre_commit_install`
+- Comprehensive test suite: unit, snapshot, and E2E tests
+
+## [0.1.0] - 2026-05-02
+
+### Added
+- Beta release.
+- Production-ready FastAPI project generator via CLI.
+- Module dependency resolution with topological sorting.
+- Conflict detection between mutually exclusive modules.
+- Secure `.env` generation with cryptographically random secrets.
+- Python syntax validation via `py_compile` for all generated files.
+
+[Unreleased]: https://github.com/iolimat/moltpy/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/iolimat/moltpy/releases/tag/v0.1.0

moltpy-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[your-email@example.com]. All complaints will be reviewed and investigated
+promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations