@devkong/cli-nx 0.0.18-0 → 0.0.18

package/src/generators/preset/files/python/README.md

@@ -1,115 +0,0 @@
-# Kong Extension
-
-Welcome to the Kong extension development workspace!
-
-### Prerequisites
-
-Before you start, make sure you have the following installed:
-
-- [Node.js](https://nodejs.org/en/download/prebuilt-installer). Version >= 20.0
-- [Python](https://www.python.org/downloads/). Version >= 3.10
-- [Docker](https://docs.docker.com/desktop/). If using Docker Desktop, start it
-- Mac M2 users, see [Troubleshooting](#Troubleshooting)
-
-To verify the installation and check the versions, run the following commands:
-
-```shell script
-node --version
-python --version # or python3 --version
-docker info
-```
-
-### Getting Started
-
-1. Add your username to the `ownership` field in the `kong.json` file (e.g., "kong-dev", "kong-qa")
-2. Make sure you're in the terminal and inside the extension folder you generated
-3. Run the following commands in your terminal:
-
-```shell script
-# configure the base Kong URL (e.g., https://kong.dev.app-dts.net)
-kong configure
-
-# install Python dependencies from requirements.txt
-kong install --verbose
-```
-
-That's it! Now, modify [main.py](./src/main.py), tag it by publishing a new version, and assign aliases for use in the workflow.
-
-### Publish a New Version
-
-To automatically tag your code with an incremented version number (e.g., 1, 2, 3), run:
-
-```shell script
-kong publish-version --verbose
-```
-
-### List Available Versions
-
-To see all available versions of your extension, run:
-
-```shell script
-kong list-versions
-```
-
-### Assign an Alias to a Version
-
-You can assign an alias (e.g., stable, beta) to a specific version. This alias will appear in the UI as a separate step in the workflow. For example, to assign the alias stable to version 1, use:
-
-```shell script
-kong set-alias stable 1
-```
-
-### Running and Debugging Tests
-
-To run the tests, execute the following command:
-
-```shell script
-pytest ./src
-```
-
-This will run the tests located in the `src` directory.
-The debugging process depends on the IDE you're using. For example, in [VSCode](https://code.visualstudio.com/), follow these steps:
-
-1. Open the Run and Debug panel from the left sidebar
-2. In the top combobox (dropdown), select "test" to configure the test environment
-3. Click the green play button to start debugging the tests
-
-This will allow you to set breakpoints and step through your tests.
-
-### Update Python Dependencies
-
-If you modify requirements.txt or requirements-dev.txt, run the following to apply the changes:
-
-```shell script
-kong install --verbose
-```
-
-### Using a Custom Profile
-
-If you're developing an extension that will be used in different regions (or need to work with a specific profile), you can create a new profile using `kong configure`. Then, include the `--profile <name>` parameter when running the publish-version and set-alias commands to use the desired profile.
-
-### Update CLI
-
-To install the latest version of the CLI, run:
-
-```shell script
-npm i -g @devkong/cli@latest
-```
-
-### Troubleshooting
-
-#### Mac M2 Users
-
-To emulate a Linux platform, you need to install Rosetta:
-
-```shell script
-softwareupdate --install-rosetta
-```
-
-#### Using a Different Python Version
-
-To change the Python version, update the `FROM` statement in the `Dockerfile` to the desired version from [Docker Hub](https://hub.docker.com/_/python/):
-
-```docker
-FROM --platform=linux/amd64 python:3.13.1-slim-bullseye
-```

package/src/generators/preset/files/python/kong.json

@@ -1,7 +0,0 @@
-{
-  "id": "<%=id%>",
-  "name": "<%=name%>",
-  "sdk": "<%=platform%>",
-  "ownership": [],
-  "alias": {}
-}

package/src/generators/preset/files/python/project.json.template

@@ -1,8 +0,0 @@
-{
-  "name": "<%=name%>",
-  "$schema": "./node_modules/nx/schemas/project-schema.json",
-  "projectType": "application",
-  "sourceRoot": "./src",
-  "targets": {},
-  "tags": []
-}

package/src/generators/preset/files/python/pyproject.toml

@@ -1,3 +0,0 @@
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-asyncio_default_fixture_loop_scope = "function"

package/src/generators/preset/files/python/requirements-dev.txt

@@ -1,10 +0,0 @@
-black==24.10.0
-flake8==7.1.1
-isort==5.13.2
-pylint==3.3.2
-pylint-pydantic==0.3.4
-pytest==8.3.4
-pytest-asyncio==0.25.0
-pytest-cov==6.0.0
-pytest-html==4.1.1
-pytest-sugar==1.0.0

package/src/generators/preset/files/python/requirements.txt

@@ -1,4 +0,0 @@
---extra-index-url https://nexus.shared.app-dts.net/repository/python-hosted/simple
-pydantic==2.10.3
-kong-sdk==0.0.31
-email-validator==2.2.0

package/src/generators/preset/files/python/src/main.py

@@ -1,67 +0,0 @@
-import sys
-from typing import Optional
-
-from kong.sdk.app import App
-from kong.sdk.kong_function import KongFunction
-from pydantic import BaseModel, Field
-
-# This script is for developing an extension for Kong.
-# For more details, please refer to the README.md file.
-
-
-class InputData(BaseModel):
-    # Define the structure of the input data that your extension will accept.
-    # Be sure to include example values for each field. These examples help generate
-    # sample objects in the UI, making it easier to work with the models.
-    # For more standard types, refer to: https://docs.pydantic.dev/latest/concepts/types/
-
-    # REPLACE BELLOW WITH YOUR FIELDS
-
-    a: int = Field(
-        examples=[1],
-        description="An integer number",
-    )
-
-    b: int = Field(
-        examples=[2],
-        description="An integer number",
-    )
-
-
-class OutputData(BaseModel):
-    # Define the structure of the output data that your extension will return.
-
-    # REPLACE BELLOW WITH YOUR FIELDS
-
-    sum_of: int = Field(
-        examples=[3],
-        description="Result of a + b",
-    )
-
-    comment: Optional[str] = Field(
-        examples=["This example extension returns sum of a and b"],
-        description="A string field",
-    )
-
-
-class MyExtension(KongFunction):
-    # This is where you implement the logic to handle the input data
-    # and produce the output.
-
-    # OVERRIDE BELLOW TO CUSTOMIZE THE PROCESSING.
-
-    async def handle(self, data: InputData) -> OutputData:
-        return OutputData(
-            sum_of=data.a + data.b,
-            comment=f"sum of {data.a} and {data.b}",
-        )
-
-
-app = App(
-    InputData,
-    OutputData,
-    MyExtension,
-)
-
-if __name__ == "__main__":
-    app.run(sys.argv)

package/src/generators/preset/files/python/src/main_test.py

@@ -1,18 +0,0 @@
-from kong.sdk.conftest import ExtensionFixture
-from src.main import InputData, MyExtension
-
-
-# The test function to validate the behavior of the extension
-async def test_should_return_value_from_string_field_when_input_is_provided(
-    create_extension: ExtensionFixture,
-):
-    extension = create_extension(MyExtension, InputData)
-
-    # Prepare the input data
-    input_data = InputData(
-        a=1,
-        b=2,
-    )
-
-    output = await extension.handle(input_data)
-    assert output.sum_of == 3

package/src/generators/preset/schema.d.ts

@@ -1,5 +0,0 @@
-export interface PresetGeneratorSchema {
-  name: string;
-  os: string;
-  platform: "python" | "kotlin";
-}

package/src/generators/preset/schema.json

@@ -1,27 +0,0 @@
-{
-  "$schema": "http://json-schema.org/schema",
-  "$id": "Preset",
-  "title": "",
-  "type": "object",
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "",
-      "$default": {
-        "$source": "argv",
-        "index": 0
-      },
-      "x-prompt": "What name would you like to use?"
-    },
-    "platform": {
-      "type": "string",
-      "description": "",
-      "$default": {
-        "$source": "argv",
-        "index": 1
-      },
-      "x-prompt": "What platform would you like to use?"
-    }
-  },
-  "required": ["name"]
-}