codeplain 0.2.1__tar.gz → 0.2.2__tar.gz

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

@@ -1,31 +1,32 @@
 Metadata-Version: 2.4
 Name: codeplain
-Version: 0.2.1
+Version: 0.2.2
 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
-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
+Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: python-liquid2==0.3.0
-Requires-Dist: pyyaml==6.0.2
+Requires-Dist: mistletoe==1.3.0
 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: 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
+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
 
 # Codeplain plain2code renderer
 

codeplain-0.2.2/codeplain.egg-info/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: codeplain
+Version: 0.2.2
+Summary: Transform plain language specifications into working code
+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: mistletoe==1.3.0
+Requires-Dist: requests==2.32.3
+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
+
+# Codeplain plain2code renderer
+
+Render ***plain source to software code using the Codeplain API.
+
+## Codeplain.ai - Code Generation as a Service
+
+Codeplain is a platform that generates software code using large language models based on requirements you specify in ***plain specification language.
+
+Schematic overview of the Codeplain's code generation service
+
+<img src="https://raw.githubusercontent.com/Codeplain-ai/plain2code_client/main/resources/codeplain_overview.png">
+
+### Abstracting Away Code Generation Complexity with ***plain
+
+
+***plain is a novel specification language that helps abstracting away complexity of using large language models for code generation.
+
+An example application in ***plain
+
+<img src="https://raw.githubusercontent.com/Codeplain-ai/plain2code_client/main/resources/plain_example.png" width="70%" height="70%">
+
+
+## Getting started
+
+### Prerequisites
+
+
+#### System requirements
+
+To run the plain2code client, you need Python 3.11 or a later version.
+
+**Windows users:** Please install WSL (Windows Subsystem for Linux) as this is currently the supported environment for running plain code on Windows.
+
+#### Authorization - Codeplain API Key
+
+We are using Codeplain API Key to authorize requests to the Codeplain API. To get your Codeplain API Key, please contact Codeplain.ai support at support@codeplain.ai.
+
+In order to generate code, you need to export the following environment variable:
+
+```bash
+export CODEPLAIN_API_KEY="your_actual_api_key_here"
+```
+
+### Installation Steps
+
+1. Clone this repository
+2. Set your Codeplain API key as an environment variable:
+   ```
+   export CODEPLAIN_API_KEY=your_api_key_here
+   ```
+3. (Recommended) Create and activate a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate
+   ```
+4. Install required libraries
+   ```
+   pip install -r requirements.txt
+   ```
+
+### Quick Start
+
+After completing the installation steps above, you can immediately test the system with a simple "Hello World" example:
+
+- Change to the example folder and run the example:
+   ```
+   cd examples/example_hello_world_python
+   python ../../plain2code.py hello_world_python.plain
+   ```
+
+   *Note: Rendering will take a few minutes to complete.*
+
+- The system will generate a Python application in the `build` directory. You can run it with:
+   ```
+   cd build
+   python hello_world.py
+   ```
+
+## Additional Resources
+
+### Examples and Sample Projects
+
+- See the [examples](examples) folder for sample projects in Golang, Python, and React.
+- For example application how to implement task manager in ***plain see [example-task-manager](https://github.com/Codeplain-ai/example-task-manager) repository.
+- For example application how to implement SaaS connectors in ***plain see [example-saas-connectors](https://github.com/Codeplain-ai/example-saas-connectors) repository.
+
+### Documentation
+
+- For more details on the ***plain format, see the [***plain language specification](docs/plain_language_specification.md).
+- For step-by-step instructions for creating your first ***plain project see the [Kickstart your ***plain project](docs/starting_a_plain_project_from_scratch.md).
+- For complete CLI documentation and usage examples, see [plain2code CLI documentation](docs/plain2code_cli.md).
+
+

codeplain-0.2.2/codeplain.egg-info/SOURCES.txt

@@ -0,0 +1,81 @@
+LICENSE
+README.md
+codeplain_REST_api.py
+concept_utils.py
+diff_utils.py
+event_bus.py
+file_utils.py
+git_utils.py
+hash_key.py
+memory_management.py
+module_renderer.py
+plain2code.py
+plain2code_arguments.py
+plain2code_console.py
+plain2code_events.py
+plain2code_exceptions.py
+plain2code_logger.py
+plain2code_nodes.py
+plain2code_read_config.py
+plain2code_state.py
+plain2code_utils.py
+plain_file.py
+plain_modules.py
+plain_spec.py
+pyproject.toml
+spinner.py
+system_config.py
+codeplain.egg-info/PKG-INFO
+codeplain.egg-info/SOURCES.txt
+codeplain.egg-info/dependency_links.txt
+codeplain.egg-info/entry_points.txt
+codeplain.egg-info/requires.txt
+codeplain.egg-info/top_level.txt
+config/__init__.py
+config/system_config.yaml
+render_machine/__init__.py
+render_machine/code_renderer.py
+render_machine/conformance_test_helpers.py
+render_machine/conformance_tests.py
+render_machine/implementation_code_helpers.py
+render_machine/render_context.py
+render_machine/render_types.py
+render_machine/render_utils.py
+render_machine/state_machine_config.py
+render_machine/states.py
+render_machine/triggers.py
+render_machine/actions/analyze_specification_ambiguity.py
+render_machine/actions/base_action.py
+render_machine/actions/commit_conformance_tests_changes.py
+render_machine/actions/commit_implementation_code_changes.py
+render_machine/actions/create_dist.py
+render_machine/actions/exit_with_error.py
+render_machine/actions/finish_functional_requirement.py
+render_machine/actions/fix_conformance_test.py
+render_machine/actions/fix_unit_tests.py
+render_machine/actions/prepare_repositories.py
+render_machine/actions/prepare_testing_environment.py
+render_machine/actions/refactor_code.py
+render_machine/actions/render_conformance_tests.py
+render_machine/actions/render_functional_requirement.py
+render_machine/actions/run_conformance_tests.py
+render_machine/actions/run_unit_tests.py
+render_machine/actions/summarize_conformance_tests.py
+standard_template_library/__init__.py
+standard_template_library/golang-console-app-template.plain
+standard_template_library/python-console-app-template.plain
+standard_template_library/typescript-react-app-boilerplate.plain
+standard_template_library/typescript-react-app-template.plain
+tests/test_git_utils.py
+tests/test_imports.py
+tests/test_plainfile.py
+tests/test_plainfileparser.py
+tests/test_plainspec.py
+tests/test_requires.py
+tui/__init__.py
+tui/components.py
+tui/models.py
+tui/plain2code_tui.py
+tui/state_handlers.py
+tui/styles.css
+tui/widget_helpers.py

codeplain-0.2.2/codeplain.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

codeplain-0.2.2/codeplain.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+codeplain = plain2code:main

codeplain-0.2.1/requirements.txt → codeplain-0.2.2/codeplain.egg-info/requires.txt

@@ -1,19 +1,18 @@
 python-liquid2==0.3.0
 mistletoe==1.3.0
-python-frontmatter==1.1.0
 requests==2.32.3
-rich==14.2.0
 tiktoken==0.12.0
 PyYAML==6.0.2
 gitpython==3.1.42
-pytest==8.3.4
+transitions==0.9.3
 textual==1.0.0
+rich==14.2.0
+python-frontmatter==1.1.0
 networkx==3.6.1
-transitions==0.9.3
-
 
-# Development dependencies
+[dev]
+pytest==8.3.5
 flake8==7.0.0
 black==24.2.0
 isort==5.13.2
-mypy==1.11.2
+mypy==1.11.2

codeplain-0.2.2/codeplain.egg-info/top_level.txt

@@ -0,0 +1,41 @@
+code_complexity
+codeplain
+codeplain_REST_api
+codeplain_constants
+codeplain_local_api
+codeplain_models
+codeplain_types
+codeplain_utils
+concept_utils
+config
+content_extractor
+event_bus
+file_utils
+git_utils
+hash_key
+llm
+llm_exceptions
+llm_handler
+llm_selector
+module_renderer
+plain2code
+plain2code_arguments
+plain2code_console
+plain2code_events
+plain2code_exceptions
+plain2code_logger
+plain2code_nodes
+plain2code_read_config
+plain2code_state
+plain2code_tui
+plain2code_utils
+plain_file
+plain_modules
+plain_spec
+render_cache
+render_machine
+spinner
+standard_template_library
+system_config
+tui
+tui_components

{codeplain-0.2.1 → codeplain-0.2.2}/plain2code.py

@@ -17,7 +17,7 @@ from event_bus import EventBus
 from module_renderer import ModuleRenderer
 from plain2code_arguments import parse_arguments
 from plain2code_console import console
-from plain2code_exceptions import PlainSyntaxError
+from plain2code_exceptions import MissingAPIKey, PlainSyntaxError
 from plain2code_logger import (
     CrashLogHandler,
     IndentedFormatter,
@@ -161,6 +161,17 @@ def render(args, run_state: RunState, codeplain_api, event_bus: EventBus):  # no
 
     console.info(f"Rendering {args.filename} to target code.")
 
+    # Compute render range from either --render-range or --render-from
+    render_range = None
+    if args.render_range or args.render_from:
+        # Parse the plain file to get the plain_source for FRID extraction
+        _, plain_source, _ = plain_file.plain_file_parser(args.filename, template_dirs)
+
+        if args.render_range:
+            render_range = get_render_range(args.render_range, plain_source)
+        elif args.render_from:
+            render_range = get_render_range_from(args.render_from, plain_source)
+
     codeplainAPI = codeplain_api.CodeplainAPI(args.api_key, console)
     codeplainAPI.verbose = args.verbose
     assert args.api is not None and args.api != "", "API URL is required"
@@ -169,7 +180,7 @@ def render(args, run_state: RunState, codeplain_api, event_bus: EventBus):  # no
     module_renderer = ModuleRenderer(
         codeplainAPI,
         args.filename,
-        args.render_range,
+        render_range,
         template_dirs,
         args,
         run_state,
@@ -208,6 +219,12 @@ def main():
     run_state = RunState(spec_filename=args.filename, replay_with=args.replay_with)
 
     try:
+        # Validate API key is present
+        if not args.api_key:
+            raise MissingAPIKey(
+                "API key is required. Please set the CODEPLAIN_API_KEY environment variable or provide it with the --api-key argument."
+            )
+
         render(args, run_state, codeplain_api, event_bus)
     except InvalidFridArgument as e:
         console.error(f"Error rendering plain code: {str(e)}.\n")
@@ -237,6 +254,8 @@ def main():
         console.error(f"Error rendering plain code: {str(e)}\n")
         console.debug(f"Render ID: {run_state.render_id}")
         dump_crash_logs(args)
+    except MissingAPIKey as e:
+        console.error(f"Missing API key: {str(e)}\n")
     except Exception as e:
         console.error(f"Error rendering plain code: {str(e)}\n")
         console.debug(f"Render ID: {run_state.render_id}")

{codeplain-0.2.1 → codeplain-0.2.2}/plain2code_arguments.py

@@ -5,10 +5,6 @@ import re
 from plain2code_read_config import get_args_from_config
 
 CODEPLAIN_API_KEY = os.getenv("CODEPLAIN_API_KEY")
-if not CODEPLAIN_API_KEY:
-    CLAUDE_API_KEY = os.getenv("CLAUDE_API_KEY")
-    if not CLAUDE_API_KEY:
-        raise ValueError("CODEPLAIN_API_KEY or CLAUDE_API_KEY environment variable is not set")
 
 
 DEFAULT_BUILD_FOLDER = "plain_modules"

{codeplain-0.2.1 → codeplain-0.2.2}/plain2code_exceptions.py

@@ -43,3 +43,7 @@ class MultipleRendersFound(Exception):
 
 class UnexpectedState(Exception):
     pass
+
+
+class MissingAPIKey(Exception):
+    pass

{codeplain-0.2.1 → codeplain-0.2.2}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
 
 [project]
 name = "codeplain"
-version = "0.2.1"
+version = "0.2.2"
 description = "Transform plain language specifications into working code"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -40,16 +40,54 @@ dev = [
 [project.scripts]
 codeplain = "plain2code:main"
 
-[tool.hatch.build.targets.wheel]
-# Include all Python files from the root directory
-include = [
-    "*.py",
-    "config/**/*",
-    "render_machine/**/*", 
-    "standard_template_library/**/*",
-    "tui/**/*"
+[tool.setuptools]
+py-modules = [
+    "plain2code",
+    "plain2code_arguments",
+    "plain2code_console",
+    "plain2code_events",
+    "plain2code_exceptions",
+    "plain2code_nodes",
+    "plain2code_read_config",
+    "plain2code_state",
+    "plain2code_tui",
+    "plain2code_utils",
+    "plain_file",
+    "plain_spec",
+    "codeplain_constants",
+    "codeplain_local_api",
+    "codeplain_models",
+    "codeplain_REST_api",
+    "codeplain_types",
+    "codeplain_utils",
+    "codeplain",
+    "code_complexity",
+    "config",
+    "content_extractor",
+    "event_bus",
+    "file_utils",
+    "git_utils",
+    "hash_key",
+    "llm_exceptions",
+    "llm_handler",
+    "llm_selector",
+    "llm",
+    "render_cache",
+    "spinner",
+    "system_config",
+    "tui_components",
+    "concept_utils",
+    "module_renderer",
+    "plain_modules",
+    "plain2code_logger",
 ]
 
+[tool.setuptools.packages.find]
+include = ["config*", "patch*", "prompt_templates*", "render_machine*", "repositories*", "services*", "standard_template_library*", "tui*"]
+
+[tool.setuptools.package-data]
+"*" = ["*.yaml", "*.css", "*.plain"]
+
 [tool.black]
 line-length = 120
 target-version = ['py311']

codeplain-0.2.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

codeplain-0.2.1/.flake8

@@ -1,28 +0,0 @@
-[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.1/.github/workflows/lint-and-test.yml

@@ -1,126 +0,0 @@
-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.1/.github/workflows/nofity-slack-on-main-merge.yml

@@ -1,22 +0,0 @@
-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 }}