Merge pull request #33 from Codeplain-ai/feat/10-17-release

Migrate to new API keys

Author: tjazerzen

README.md

@@ -31,29 +31,22 @@ 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.
 
-#### Anthropic API Key
+#### Authorization - Codeplain API Key
 
-For now you need to bring your own Anthropic API key to use Codeplain API. If you don't have Anthropic API key, you can create a free developer account at [console.anthropic.com](https://console.anthropic.com/). To experiment with Codeplain you need to top up your Anthropic account with $5-10.
+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 [email protected].
 
-With Anthropic API Key ready, please contact Codeplain.ai support at [email protected] to have the hash of your Anthropic API key added to the list of authorized API keys.
-
-To have the hash generated use the following command:
-
-`python hash_key.py $CLAUDE_API_KEY`
-
-To set up your API key run:
+In order to generate code, you need to export the following environment variable:
 
 ```bash
-# Export API key directly
-export CLAUDE_API_KEY="your_actual_api_key_here"
+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 CLAUDE_API_KEY=your_api_key_here
+   export CODEPLAIN_API_KEY=your_api_key_here
    ```
 3. (Recommended) Create and activate a virtual environment:
    ```bash

codeplain_REST_api.py

@@ -135,7 +135,7 @@ def post_request(self, endpoint_url, headers, payload, run_state: Optional[RunSt
                         f"Connection error: Unable to reach the Codeplain API at {self.api_url}. Please try again or contact support."
                     )
 
-    def get_plain_source_tree(self, plain_source, loaded_templates):
+    def get_plain_source_tree(self, plain_source, loaded_templates, run_state: RunState):
         """
         Builds plain source tree from the given plain text source in Markdown format.
 
@@ -154,7 +154,7 @@ def get_plain_source_tree(self, plain_source, loaded_templates):
 
         payload = {"plain_source": plain_source, "loaded_templates": loaded_templates}
 
-        return self.post_request(endpoint_url, headers, payload, None)
+        return self.post_request(endpoint_url, headers, payload, run_state)
 
     def render_functional_requirement(
         self,
@@ -370,3 +370,13 @@ def analyze_rendering(
         }
 
         return self.post_request(endpoint_url, headers, payload, run_state)
+
+    def finish_functional_requirement(self, frid, run_state: RunState):
+        endpoint_url = f"{self.api_url}/finish_functional_requirement"
+        headers = {"X-API-Key": self.api_key, "Content-Type": "application/json"}
+
+        payload = {
+            "frid": frid,
+        }
+
+        return self.post_request(endpoint_url, headers, payload, run_state)

examples/example_hello_world_python/hello_world_python.plain

@@ -8,7 +8,7 @@
 
   ***Acceptance Tests:***
 
-  - The App shouldn't show logging output in the console output (neither in stdout nor stderr).
   - The App should exit with status code 0 indicating successful execution.
+
   - The App should complete execution in under 1 second.
 

hash_key.py

@@ -1,5 +1,6 @@
-import sys
 import hashlib
+import sys
+
 
 def hash_api_key(api_key):
     """Hash the provided API key using SHA-256 and return the hash as a hex string."""
@@ -11,17 +12,18 @@ def hash_api_key(api_key):
         error_message = f"An error occurred while hashing the API key: {str(e)}"
         raise Exception(error_message)
 
+
 if __name__ == "__main__":
     if len(sys.argv) != 2:
         print("Error: Exactly one argument must be provided for the API key.")
         print(f"Usage: python {sys.argv[0]} <api_key>")
         sys.exit(1)
-    
+
     api_key = sys.argv[1]
-    
+
     try:
         hashed_key = hash_api_key(api_key)
         print(f"Hashed API Key: {hashed_key}")
     except Exception as e:
         print(f"Error: {str(e)}")
-        sys.exit(1)
+        sys.exit(1)

plain2code.py

@@ -19,6 +19,7 @@
 from plain2code_arguments import parse_arguments
 from plain2code_console import console
 from plain2code_state import CONFORMANCE_TESTS_DEFINITION_FILE_NAME, ConformanceTestsUtils, ExecutionState, RunState
+# from plain2code_utils import AMBIGUITY_CAUSES, RetryOnlyFilter
 from plain2code_utils import RetryOnlyFilter
 from system_config import system_config
 
@@ -33,7 +34,7 @@
 MAX_REFACTORING_ITERATIONS = 5
 MAX_UNIT_TEST_RENDER_RETRIES = 2
 
-MAX_ISSUE_LENGTH = 15000  # Characters.
+MAX_ISSUE_LENGTH = 10000  # Characters.
 
 UNRECOVERABLE_ERROR_EXIT_CODES = [69]
 TIMEOUT_ERROR_EXIT_CODE = 124
@@ -1041,6 +1042,41 @@ def render_functional_requirement(  # noqa: C901
                 run_state.render_id,
             )
 
+            # fixed_implementation_code_diff = git_utils.get_fixed_implementation_code_diff(args.build_folder, frid)
+            # if fixed_implementation_code_diff is None:
+            #     raise Exception(
+            #         "Fixes to the implementation code found during conformance testing are not committed to git."
+            #     )
+
+            # git_utils.checkout_commit_with_frid(args.build_folder, previous_frid)
+            # existing_files = file_utils.list_all_text_files(args.build_folder)
+            # existing_files_content = file_utils.get_existing_files_content(args.build_folder, existing_files)
+            # git_utils.checkout_previous_branch(args.build_folder)
+
+            # implementation_code_diff = git_utils.get_implementation_code_diff(args.build_folder, frid, previous_frid)
+
+            # rendering_analysis = codeplainAPI.analyze_rendering(
+            #     frid,
+            #     plain_source_tree,
+            #     linked_resources,
+            #     existing_files_content,
+            #     implementation_code_diff,
+            #     fixed_implementation_code_diff,
+            #     run_state,
+            # )
+
+            # if rendering_analysis:
+            #     # TODO: Before this output is exposed to the user, we should check the 'guidance' field using LLM in the same way as we do conflicting requirements.
+            #     console.info(
+            #         f"Specification ambiguity detected! {AMBIGUITY_CAUSES[rendering_analysis['cause']]} of the functional requirement {frid}."
+            #     )
+            #     console.info(rendering_analysis["guidance"])
+            #     run_state.add_rendering_analysis_for_frid(frid, rendering_analysis)
+            # else:
+            #     console.warning(
+            #         f"During conformance testing, the implementation code of the functional requirement {frid} was fixed, but the cause of the issue was not identified."
+            #     )
+
         conformance_tests_utils.dump_conformance_tests_json(conformance_tests)
         git_utils.add_all_files_and_commit(
             args.conformance_tests_folder,
@@ -1055,6 +1091,15 @@ def render_functional_requirement(  # noqa: C901
         None,
         run_state.render_id,
     )
+
+    # Copy build and conformance tests folders to output folders if specified
+    if args.copy_build:
+        file_utils.copy_folder_to_output(args.build_folder, args.build_dest)
+    if args.copy_conformance_tests:
+        file_utils.copy_folder_to_output(args.conformance_tests_folder, args.conformance_tests_dest)
+
+    codeplainAPI.finish_functional_requirement(frid, run_state)
+
     return
 
 
@@ -1069,6 +1114,7 @@ def render(args, run_state: RunState):  # noqa: C901
         logging.getLogger("langsmith").setLevel(logging.WARNING)
         logging.getLogger("git").setLevel(logging.WARNING)
         logging.getLogger("anthropic._base_client").setLevel(logging.DEBUG)
+        logging.getLogger("services.langsmith.langsmith_service").setLevel(logging.INFO)
 
         # Try to load logging configuration from YAML file
         if os.path.exists(LOGGING_CONFIG_PATH):
@@ -1123,7 +1169,7 @@ def render(args, run_state: RunState):  # noqa: C901
 
     console.info(f"Rendering {args.filename} to target code.")
 
-    plain_source_tree = codeplainAPI.get_plain_source_tree(plain_source, loaded_templates)
+    plain_source_tree = codeplainAPI.get_plain_source_tree(plain_source, loaded_templates, run_state)
 
     if args.render_range is not None:
         args.render_range = get_render_range(args.render_range, plain_source_tree)
@@ -1146,6 +1192,17 @@ def render(args, run_state: RunState):  # noqa: C901
         )
         frid = plain_spec.get_next_frid(plain_source_tree, frid)
 
+    # if args.verbose and len(run_state.frid_render_anaysis.items()) > 0:
+    #     console.warning("\nWhile generating the code following ambiguities in the specs were identified:\n")
+    #     for frid, render_analysis in run_state.frid_render_anaysis.items():
+    #         specifications, _ = plain_spec.get_specifications_for_frid(plain_source_tree, frid)
+    #         functional_requirement_text = specifications[plain_spec.FUNCTIONAL_REQUIREMENTS][-1]
+    #         console.info("\n-------------------------------------")
+    #         console.info(f"Functional requirement {frid}:")
+    #         console.output(f"{functional_requirement_text}")
+    #         console.info(f"Guidance: {render_analysis['guidance']}")
+    #         console.info("-------------------------------------\n")
+
     # Copy build and conformance tests folders to output folders if specified
     if args.copy_build:
         file_utils.copy_folder_to_output(args.build_folder, args.build_dest)
@@ -1225,10 +1282,6 @@ def exit_with_error(message, last_successful_frid=None, render_id=None):
 
         codeplain_api = importlib.import_module(codeplain_api_module_name)
 
-    if not args.api_key or args.api_key == "":
-        exit_with_error(
-            "Error: API key is not provided. Please provide an API key using the --api-key flag or by setting the CLAUDE_API_KEY environment variable."
-        )
     run_state = RunState(replay_with=args.replay_with)
     console.debug(f"Render ID: {run_state.render_id}")
 

plain2code_arguments.py

@@ -4,7 +4,13 @@
 
 from plain2code_read_config import get_args_from_config
 
-CLAUDE_API_KEY = os.getenv("CLAUDE_API_KEY")
+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 = "build"
 DEFAULT_CONFORMANCE_TESTS_FOLDER = "conformance_tests"
 DEFAULT_BUILD_DEST = "dist"
@@ -179,8 +185,8 @@ def create_parser():
     parser.add_argument(
         "--api-key",
         type=str,
-        default=CLAUDE_API_KEY,
-        help="API key used to access the API. If not provided, the CLAUDE_API_KEY environment variable is used.",
+        default=CODEPLAIN_API_KEY,
+        help="API key used to access the API. If not provided, the CODEPLAIN_API_KEY environment variable is used.",
     )
     parser.add_argument(
         "--full-plain",

plain2code_nodes.py

@@ -92,7 +92,7 @@ def load(
         source, full_name, uptodate, matter = self.get_source(env, name, context=context, **kwargs)
         whitespaces = kwargs.get("whitespaces", 0)
         assert isinstance(whitespaces, int)
-        source = source.replace("\n", "\n" + " " * whitespaces)
+        source = source.rstrip().replace("\n", "\n" + " " * whitespaces)
 
         path = Path(full_name)