Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proofreading12 #2

Merged
merged 5 commits into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
=============
Expand All @@ -45,22 +46,22 @@ 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:
- ./:/code
- ./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 [email protected]:kds_consulting_team/kds-team.app-custom-python.git kds-team.app-custom-python
Expand All @@ -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
Expand All @@ -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/).
2 changes: 1 addition & 1 deletion component_config/component_long_description.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Custom Python Application long description
Custom Python Application
2 changes: 1 addition & 1 deletion component_config/component_short_description.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Custom Python Application short description
Custom Python Application
8 changes: 4 additions & 4 deletions component_config/configSchema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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 <a href=\"https://help.keboola.com/transformations/\">documentation</a>",
"description": "Learn more about package installation, usage, and the list of pre-installed packages in our <a href=\"https://help.keboola.com/transformations/\">documentation</a>.",
"uniqueItems": true,
"propertyOrder": 1
},
Expand All @@ -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
}
}
Expand Down
2 changes: 1 addition & 1 deletion component_config/configuration_description.md
Original file line number Diff line number Diff line change
@@ -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.
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.