codeplain 0.2.2__tar.gz → 0.2.4__tar.gz

codeplain-0.2.4/.flake8

@@ -0,0 +1,28 @@
+[flake8]
+max-line-length = 120
+# E203 is ignored because it conflicts with Black's formatting of slice notation
+# Black formats slices like `a[1 : 2]` but flake8 expects `a[1:2]`
+# E501 is ignored because we handle line length with Black's formatter
+# B001 is ignored because we also check it with check E722
+# N... is ignored because it's just naming conventions
+# U101 is ignored because leading underscores signal that the argument is not used
+extend-ignore = E203, E501, B001, N803, N806, N813, U101, U101
+exclude =
+    .git,
+    __pycache__,
+    .venv,
+    .env,
+    .conda,
+    build,
+    dist,
+    tests,
+    examples
+per-file-ignores =
+    __init__.py: F401
+    tests/*: U100
+max-complexity = 15
+enable-extensions = U100
+# Plugin-specific configuration
+unused-arguments-ignore-args = self,cls,_
+# don't show warnings for unused *args and **kwargs.
+unused-arguments-ignore-variadic-names = True

codeplain-0.2.4/.github/workflows/lint-and-test.yml

@@ -0,0 +1,126 @@
+name: Code Quality & Tests
+
+on:
+  push:
+  pull_request:
+
+env:
+  PYTHON_VERSION: "3.11"
+
+jobs:
+  black:
+    name: Black Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Check formatting with Black
+        run: black . --check
+
+  isort:
+    name: Import Sorting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install isort
+      - name: Sort imports with isort
+        run: isort . --check-only --diff
+
+  flake8:
+    name: Flake8 Linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+      - name: Lint with flake8
+        run: flake8 .
+
+  mypy:
+    name: MyPy Type Checking
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Type check with mypy
+        run: mypy . --check-untyped-defs
+
+  tests:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Configure git for tests
+        run: |
+          git config --global user.email "test@example.com"
+          git config --global user.name "Test Runner"
+          git config --global init.defaultBranch main
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install coverage
+      - name: Run tests with coverage
+        run: |
+          export $(cat .env.dev.example | xargs)
+          coverage run -m pytest tests/ -v
+          coverage xml
+          coverage report
+      - name: Upload coverage reports
+        uses: codecov/codecov-action@v3

codeplain-0.2.4/.github/workflows/nofity-slack-on-main-merge.yml

@@ -0,0 +1,22 @@
+name: Notify Slack on Merge to Main
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - main
+
+jobs:
+  notify:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true
+    steps:
+      - name: Send notification to Slack
+        uses: slackapi/slack-github-action@v1.24.0
+        with:
+          payload: |
+            {
+              "text": ${{ toJSON(format('[Codeplain Client] PR <{0}|#{1}: {2}> was merged to main by `{3}`.', github.event.pull_request.html_url, github.event.pull_request.number, github.event.pull_request.title, github.actor)) }}
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

codeplain-0.2.4/.github/workflows/publish-install-script.yml

@@ -0,0 +1,30 @@
+name: Publish Install Script to R2
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'install.sh'
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: Upload to Cloudflare R2
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Upload install.sh to R2
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.R2_SECRET_ACCESS_KEY }}
+          R2_ENDPOINT: ${{ secrets.R2_ENDPOINT }}
+          R2_BUCKET: ${{ secrets.R2_BUCKET }}
+        run: |
+          aws s3 cp install.sh s3://${R2_BUCKET}/install/install.sh \
+            --endpoint-url "${R2_ENDPOINT}" \
+            --content-type "text/plain"
+
+          echo "✓ install.sh uploaded to R2"

codeplain-0.2.4/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,109 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to build (e.g., 0.2.1)"
+        required: true
+        type: string
+      publish_to_pypi:
+        description: "Actually publish to PyPI?"
+        required: true
+        default: false
+        type: boolean
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Extract version
+        id: get_version
+        run: |
+          if [ "${{ github.event_name }}" = "release" ]; then
+            # Strip 'v' prefix from tag (v0.2.1 -> 0.2.1)
+            VERSION=${GITHUB_REF_NAME#v}
+          else
+            # Use manual input
+            VERSION="${{ github.event.inputs.version }}"
+          fi
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+          echo "Extracted version: $VERSION"
+
+      - name: Update version in pyproject.toml
+        run: |
+          sed -i "s/^version = .*/version = \"${{ steps.get_version.outputs.VERSION }}\"/" pyproject.toml
+          echo "Updated pyproject.toml:"
+          grep "^version" pyproject.toml
+
+      - name: Commit version update to repo
+        if: github.event_name == 'release'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add pyproject.toml
+          git commit -m "Bump version to ${{ steps.get_version.outputs.VERSION }}"
+          git push origin HEAD:main
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Build package
+        run: |
+          uv build
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Upload assets to GitHub Release
+        if: github.event_name == 'release'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release upload ${{ github.ref_name }} dist/* --clobber
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs: build
+    if: github.event_name == 'release' || github.event.inputs.publish_to_pypi == 'true'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/codeplain
+
+    steps:
+      - name: Download distribution packages
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          uv tool run twine upload dist/*

codeplain-0.2.4/.gitignore

@@ -0,0 +1,32 @@
+__pycache__
+.DS_Store
+
+# Plain
+examples/**/build*/
+examples/**/conformance_tests/
+examples/**/conformance_tests.backup/
+examples/**/node_build/
+examples/**/node_conformance_tests/
+examples/**/package-lock.json
+examples/**/node_modules/
+examples/**/node_harness_tests/
+examples/**/plain_modules/
+
+examples/**/go_build/
+examples/**/python_build/
+
+examples/**/go_plain_modules/
+examples/**/python_plain_modules/
+examples/**/node_plain_modules/
+
+
+*.log
+
+.venv
+build
+dist
+*.egg-info
+
+.env
+
+.coverage

codeplain-0.2.4/.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug plain2code.py for file hello_world_python.plain",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/plain2code.py",
+            "args": [
+                "${workspaceFolder}/examples/example_hello_world_python/hello_world_python.plain",
+            ],
+            "subProcess": false,
+            "cwd": "${workspaceFolder}/examples/example_hello_world_python",
+            "console": "integratedTerminal",
+            "justMyCode": false,
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}"
+            }
+        }
+    ]
+}

codeplain-0.2.4/.vscode/settings.json

@@ -0,0 +1,32 @@
+{
+    "editor.formatOnSave": true,
+    "editor.insertSpaces": true,
+    "editor.detectIndentation": false,
+    "editor.codeActionsOnSave": {
+        "source.organizeImports": "explicit"
+    },
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.formatOnSave": true,
+        "editor.rulers": [120],
+        "editor.insertSpaces": true,
+        "editor.tabSize": 4
+    },
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "notebook.defaultFormatter": "ms-python.black-formatter",
+    "python.testing.unittestEnabled": true,
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestArgs": [
+        "-v",
+        "-p",
+        "test_*.py",
+        "-t",
+        "${workspaceFolder}"
+    ],
+    "python.analysis.extraPaths": [
+        "${workspaceFolder}"
+    ],
+    "files.associations": {
+        "**/tests/data/*": "text"
+    }
+}

{codeplain-0.2.2 → codeplain-0.2.4}/PKG-INFO

@@ -1,32 +1,31 @@
 Metadata-Version: 2.4
 Name: codeplain
-Version: 0.2.2
+Version: 0.2.4
 Summary: Transform plain language specifications into working code
+License-File: LICENSE
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Code Generators
 Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: python-liquid2==0.3.0
+Requires-Dist: gitpython==3.1.42
 Requires-Dist: mistletoe==1.3.0
+Requires-Dist: networkx==3.6.1
+Requires-Dist: python-frontmatter==1.1.0
+Requires-Dist: python-liquid2==0.3.0
+Requires-Dist: pyyaml==6.0.2
 Requires-Dist: requests==2.32.3
+Requires-Dist: rich==14.2.0
+Requires-Dist: textual==1.0.0
 Requires-Dist: tiktoken==0.12.0
-Requires-Dist: PyYAML==6.0.2
-Requires-Dist: gitpython==3.1.42
 Requires-Dist: transitions==0.9.3
-Requires-Dist: textual==1.0.0
-Requires-Dist: rich==14.2.0
-Requires-Dist: python-frontmatter==1.1.0
-Requires-Dist: networkx==3.6.1
 Provides-Extra: dev
-Requires-Dist: pytest==8.3.5; extra == "dev"
-Requires-Dist: flake8==7.0.0; extra == "dev"
-Requires-Dist: black==24.2.0; extra == "dev"
-Requires-Dist: isort==5.13.2; extra == "dev"
-Requires-Dist: mypy==1.11.2; extra == "dev"
-Dynamic: license-file
+Requires-Dist: black==24.2.0; extra == 'dev'
+Requires-Dist: flake8==7.0.0; extra == 'dev'
+Requires-Dist: isort==5.13.2; extra == 'dev'
+Requires-Dist: mypy==1.11.2; extra == 'dev'
+Requires-Dist: pytest==8.3.5; extra == 'dev'
+Description-Content-Type: text/markdown
 
 # Codeplain plain2code renderer
 

{codeplain-0.2.2 → codeplain-0.2.4}/codeplain_REST_api.py

@@ -65,12 +65,6 @@ class CodeplainAPI:
                     if response_json["error_code"] == "PlainSyntaxError":
                         raise plain2code_exceptions.PlainSyntaxError(response_json["message"])
 
-                    if response_json["error_code"] == "OnlyRelativeLinksAllowed":
-                        raise plain2code_exceptions.OnlyRelativeLinksAllowed(response_json["message"])
-
-                    if response_json["error_code"] == "LinkMustHaveTextSpecified":
-                        raise plain2code_exceptions.LinkMustHaveTextSpecified(response_json["message"])
-
                     if response_json["error_code"] == "NoRenderFound":
                         raise plain2code_exceptions.NoRenderFound(response_json["message"])
 

codeplain-0.2.4/docs/generate_cli.py

@@ -0,0 +1,20 @@
+import os
+import sys
+
+from plain2code_arguments import create_parser
+
+# Add the parent directory to the path so we can import plain2code_arguments
+sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+
+# Get the parser and generate help text
+parser = create_parser()
+help_text = parser.format_help()
+
+# Create markdown
+md = "# Plain2Code CLI Reference\n\n```text\n" + help_text + "\n```"
+
+# Run generate_cli.py in the docs folder
+
+with open("plain2code_cli.md", "w", encoding="utf-8") as f:
+    f.write(md)

codeplain-0.2.4/docs/plain2code_cli.md

@@ -0,0 +1,66 @@
+# Plain2Code CLI Reference
+
+```text
+usage: generate_cli.py [-h] [--verbose] [--base-folder BASE_FOLDER] [--build-folder BUILD_FOLDER] [--config-name CONFIG_NAME]
+                       [--render-range RENDER_RANGE | --render-from RENDER_FROM] [--unittests-script UNITTESTS_SCRIPT]
+                       [--conformance-tests-folder CONFORMANCE_TESTS_FOLDER] [--conformance-tests-script CONFORMANCE_TESTS_SCRIPT]
+                       [--api [API]] [--api-key API_KEY] [--full-plain] [--dry-run] [--replay-with REPLAY_WITH]
+                       [--template-dir TEMPLATE_DIR] [--copy-build] [--build-dest BUILD_DEST] [--copy-conformance-tests]
+                       [--conformance-tests-dest CONFORMANCE_TESTS_DEST]
+                       filename
+
+Render plain code to target code.
+
+positional arguments:
+  filename              Path to the plain file to render. The directory containing this file has highest precedence for template
+                        loading, so you can place custom templates here to override the defaults. See --template-dir for more
+                        details about template loading.
+
+options:
+  -h, --help            show this help message and exit
+  --verbose, -v         Enable verbose output
+  --base-folder BASE_FOLDER
+                        Base folder for the build files
+  --build-folder BUILD_FOLDER
+                        Folder for build files
+  --render-range RENDER_RANGE
+                        Specify a range of functional requirements to render (e.g. '1.1,2.3'). Use comma to separate start and end
+                        IDs. If only one ID is provided, only that requirement is rendered. Range is inclusive of both start and
+                        end IDs.
+  --render-from RENDER_FROM
+                        Continue generation starting from this specific functional requirement (e.g. '2.1'). The requirement with
+                        this ID will be included in the output. The ID must match one of the functional requirements in your plain
+                        file.
+  --unittests-script UNITTESTS_SCRIPT
+                        Shell script to run unit tests on generated code. Receives the build folder path as its first argument
+                        (default: 'build').
+  --conformance-tests-folder CONFORMANCE_TESTS_FOLDER
+                        Folder for conformance test files
+  --conformance-tests-script CONFORMANCE_TESTS_SCRIPT
+                        Path to conformance tests shell script. The conformance tests shell script should accept the build folder
+                        path (containing generated source code) as its first argument and the conformance tests folder path
+                        (containing test files) as its second argument.
+  --api [API]           Alternative base URL for the API. Default: `https://api.codeplain.ai`
+  --api-key API_KEY     API key used to access the API. If not provided, the CLAUDE_API_KEY environment variable is used.
+  --full-plain          Display the complete plain specification before code generation. This shows your plain file with any
+                        included template content expanded. Useful for understanding what content is being processed.
+  --dry-run             Preview of what Codeplain would do without actually making any changes.
+  --replay-with REPLAY_WITH
+  --template-dir TEMPLATE_DIR
+                        Path to a custom template directory. Templates are searched in the following order: 1) directory containing
+                        the plain file, 2) this custom template directory (if provided), 3) built-in standard_template_library
+                        directory
+  --copy-build          If set, copy the build folder to `--build-dest` after every successful rendering.
+  --build-dest BUILD_DEST
+                        Target folder to copy build output to (used only if --copy-build is set).
+  --copy-conformance-tests
+                        If set, copy the conformance tests folder to `--conformance-tests-dest` after every successful rendering.
+                        Requires --conformance-tests-script.
+  --conformance-tests-dest CONFORMANCE_TESTS_DEST
+                        Target folder to copy conformance tests output to (used only if --copy-conformance-tests is set).
+
+configuration:
+  --config-name CONFIG_NAME
+                        Path to the config file, defaults to config.yaml
+
+```