From 4002b1c8c3dd5a4cf956e6102d52a286961daeeb Mon Sep 17 00:00:00 2001 From: Hana Hanova Date: Fri, 28 Feb 2025 10:58:19 +0100 Subject: [PATCH 1/5] Update README.md --- README.md | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 42ee609..bb5b8b9 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,38 @@ Custom Python Application ============= -Description **Table of contents:** [TOC] -Functionality notes +Functionality Notes =================== Prerequisites ============= -Get the API token, register application, etc. +- Obtain the API token +- Register the application +- Any other necessary setup steps Features ======== | **Feature** | **Note** | |-------------------------|-----------------------------------------------| -| Generic UI form | Dynamic UI form | -| Row Based configuration | Allows structuring the configuration in rows. | -| oAuth | oAuth authentication enabled | -| Incremental loading | Allows fetching data in new increments. | -| Backfill mode | Support for seamless backfill setup. | -| Date range filter | Specify date range. | - -Supported endpoints +| Generic UI form | Provides a dynamic UI form. | +| Row-based configuration | Enables structured configuration using rows. | +| OAuth | OAuth authentication is enabled. | +| Incremental loading | Supporst fetching data in increments. | +| Backfill mode | Allows seamless backfill setup. | +| Date range filter | Enables filtering data by a specifid date range. | + +Supported Endpoints =================== -If you need more endpoints, please submit your request to -[ideas.keboola.com](https://ideas.keboola.com/) +If you need additional endpoints, please submit a request to +[ideas.keboola.com](https://ideas.keboola.com/). Configuration ============= @@ -45,13 +46,14 @@ Param 2 Output ====== -List of tables, foreign keys, schema. +- List of tables +- Foreign keys +- Schema Development ----------- -If required, change local data folder (the `CUSTOM_FOLDER` placeholder) path to -your custom path in the `docker-compose.yml` file: +If needed, update the local data folder path by replacing the `CUSTOM_FOLDER` placeholder in the `docker-compose.yml` file: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ volumes: @@ -59,8 +61,7 @@ your custom path in the `docker-compose.yml` file: - ./CUSTOM_FOLDER:/data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Clone this repository, init the workspace and run the component with following -command: +Clone the repository, initialize the workspace, and run the component using the following commands: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ git clone git@bitbucket.org:kds_consulting_team/kds-team.app-custom-python.git kds-team.app-custom-python @@ -69,7 +70,7 @@ docker-compose build docker-compose run --rm dev ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Run the test suite and lint check using this command: +To run the test suite and perform a lint check, use: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ docker-compose run --rm test @@ -78,6 +79,6 @@ docker-compose run --rm test Integration =========== -For information about deployment and integration with KBC, please refer to the -[deployment section of developers -documentation](https://developers.keboola.com/extend/component/deployment/) +For details on deployment and integration with Keboola, refer to the +[deployment section of the developer +documentation](https://developers.keboola.com/extend/component/deployment/). From 556d736afaf252f222419f5ec295a8b68cb65f1c Mon Sep 17 00:00:00 2001 From: Hana Hanova Date: Fri, 28 Feb 2025 11:01:02 +0100 Subject: [PATCH 2/5] Update component_long_description.md --- component_config/component_long_description.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/component_config/component_long_description.md b/component_config/component_long_description.md index 4a254db..2112730 100644 --- a/component_config/component_long_description.md +++ b/component_config/component_long_description.md @@ -1 +1 @@ -Custom Python Application long description \ No newline at end of file +Custom Python Application From 3b7b077478cf7be239c04986d11de477380c57dc Mon Sep 17 00:00:00 2001 From: Hana Hanova Date: Fri, 28 Feb 2025 11:01:17 +0100 Subject: [PATCH 3/5] Update component_short_description.md --- component_config/component_short_description.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/component_config/component_short_description.md b/component_config/component_short_description.md index bf4d554..2112730 100644 --- a/component_config/component_short_description.md +++ b/component_config/component_short_description.md @@ -1 +1 @@ -Custom Python Application short description \ No newline at end of file +Custom Python Application From 53a678238f7f0d7407b1021f3fc72979b6410a3a Mon Sep 17 00:00:00 2001 From: Hana Hanova Date: Fri, 28 Feb 2025 11:07:42 +0100 Subject: [PATCH 4/5] wip --- component_config/configSchema.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/component_config/configSchema.json b/component_config/configSchema.json index 1219c0b..fcdac08 100644 --- a/component_config/configSchema.json +++ b/component_config/configSchema.json @@ -9,7 +9,7 @@ "properties": { "code": { "type": "string", - "title": "Python Code", + "title": "Python code", "format": "editor", "default": "from keboola.component import CommonInterface\nci = CommonInterface()\n# access user parameters\nprint(ci.configuration.parameters)", "options": { @@ -26,12 +26,12 @@ "items": { "type": "string" }, - "title": "Python Packages", + "title": "Python packages", "format": "select", "options": { "tags": true }, - "description": "Learn more about package installation and usage, and about the list of pre-installed packages in our documentation", + "description": "Learn more about package installation, usage, and the list of pre-installed packages in our documentation.", "uniqueItems": true, "propertyOrder": 1 }, @@ -50,7 +50,7 @@ "input_height": "100px" } }, - "description": "User parameters accessible, the result will be injected in standard data/config.json parameters property as in any other component", + "description": "User parameters are accessible, and the result will be injected into the standard data/config.json parameters property, as in any other component.", "propertyOrder": 1 } } From 95691854eefef31e5e7c31f815a1f78cf66172af Mon Sep 17 00:00:00 2001 From: Hana Hanova Date: Fri, 28 Feb 2025 12:28:06 +0100 Subject: [PATCH 5/5] wip --- component_config/configuration_description.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/component_config/configuration_description.md b/component_config/configuration_description.md index d7c1c60..fec264e 100644 --- a/component_config/configuration_description.md +++ b/component_config/configuration_description.md @@ -1,2 +1,2 @@ This component uses the latest version of our [Python Transformation backend](https://help.keboola.com/transformations/python/#environment). -It contains the same packages and the code is executed in the same environment. So any code runing in Python transformation will work here and vice-versa. \ No newline at end of file +It includes the same packages, and the code runs in the same environment. Any code runing in a Python transformation will work here and vice versa. \ No newline at end of file