From d2ec68cf57e2cf41c42b93f485d538a6f453b4e4 Mon Sep 17 00:00:00 2001 From: dreamcoin1998 Date: Mon, 30 Dec 2024 15:23:42 +0800 Subject: [PATCH 1/7] chore: bump version to 0.2.53 and update project metadata in setup.py - Updated the version number in setup.py from 0.2.52 to 0.2.53. - Added project URLs for documentation, source code, and issue tracking to enhance accessibility for users. --- setup.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 8b9a049..2d24e5b 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ setup( name='tapflow', - version='0.2.52', + version='0.2.53', packages=find_packages(), install_requires=required, include_package_data=True, @@ -24,4 +24,10 @@ python_requires='>=3.6', long_description=open("README.md").read(), long_description_content_type="text/markdown", + url="https://tapdata.io/", + project_urls={ + "Documentation": "https://docs.tapdata.net/tapflow/introduction", + "Source": "https://github.com/tapdata/tapflow", + "Tracker": "https://github.com/tapdata/tapdata/issues", + }, ) From 509fa83c4ad7a3a7a40f237f95e9acbbb28e7761 Mon Sep 17 00:00:00 2001 From: dreamcoin1998 Date: Mon, 30 Dec 2024 15:24:01 +0800 Subject: [PATCH 2/7] fix: update project URL in setup.py from tapdata.io to tapdata.net --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 2d24e5b..e5b28e6 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ python_requires='>=3.6', long_description=open("README.md").read(), long_description_content_type="text/markdown", - url="https://tapdata.io/", + url="https://tapdata.net/", project_urls={ "Documentation": "https://docs.tapdata.net/tapflow/introduction", "Source": "https://github.com/tapdata/tapflow", From bf6e631f9346b2149d202491691e4b79cff39a9d Mon Sep 17 00:00:00 2001 From: dreamcoin1998 Date: Mon, 30 Dec 2024 15:25:26 +0800 Subject: [PATCH 3/7] docs: add GitHub release badge to README for improved visibility --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3072ab4..b3ecdbb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![Release](https://img.shields.io/github/v/tag/tapdata/tapflow.svg?sort=semver)](https://github.com/tapdata/tapflow/releases) [![PyPI Downloads](https://static.pepy.tech/badge/tapflow)](https://pepy.tech/projects/tapflow) ## What is TapFlow From e5fb00319d1b49012cff5d471c14a184b4dc3d02 Mon Sep 17 00:00:00 2001 From: dreamcoin1998 Date: Mon, 30 Dec 2024 15:26:25 +0800 Subject: [PATCH 4/7] docs: enhance README with centered banner and improved layout - Added a centered banner image to the README for better visual appeal. - Updated the layout to improve readability and presentation of project information. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index b3ecdbb..3e27d97 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ +
+ + + +

+ [![Release](https://img.shields.io/github/v/tag/tapdata/tapflow.svg?sort=semver)](https://github.com/tapdata/tapflow/releases) [![PyPI Downloads](https://static.pepy.tech/badge/tapflow)](https://pepy.tech/projects/tapflow) +
+ ## What is TapFlow TapFlow is a newly launched programming API framework for the TapData Live Data Platform. It allows developers and data engineers to build data pipelines and models using a simple powerful programming language. From 541b6c30f58774a19ff7490f1e39e780dcd51809 Mon Sep 17 00:00:00 2001 From: dreamcoin1998 Date: Mon, 30 Dec 2024 15:27:00 +0800 Subject: [PATCH 5/7] docs: remove banner image from README for cleaner presentation - Eliminated the centered banner image to streamline the README layout. - Adjusted the content for improved readability and focus on project information. --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 3e27d97..906307c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,4 @@
- - - -

[![Release](https://img.shields.io/github/v/tag/tapdata/tapflow.svg?sort=semver)](https://github.com/tapdata/tapflow/releases) [![PyPI Downloads](https://static.pepy.tech/badge/tapflow)](https://pepy.tech/projects/tapflow) From d54c63685715d8aa845021b0651b5e83959b32d1 Mon Sep 17 00:00:00 2001 From: dreamcoin1998 Date: Mon, 30 Dec 2024 15:27:40 +0800 Subject: [PATCH 6/7] docs: add table of contents to README for improved navigation - Introduced a table of contents at the beginning of the README to enhance user navigation and accessibility of information. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 906307c..6a69614 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@
+[toc] + ## What is TapFlow TapFlow is a newly launched programming API framework for the TapData Live Data Platform. It allows developers and data engineers to build data pipelines and models using a simple powerful programming language. From bc67867500a4d525a848f481b8cfe88fbc1aaabf Mon Sep 17 00:00:00 2001 From: dreamcoin1998 Date: Mon, 30 Dec 2024 15:29:22 +0800 Subject: [PATCH 7/7] docs: expand table of contents in README for comprehensive navigation - Added detailed sections to the table of contents, improving navigation and accessibility for users seeking specific information about TapFlow features and usage. --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a69614..176abc3 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,24 @@ -[toc] +## Table of Contents +- [What is TapFlow](#what-is-tapflow) +- [Why is a Programmatic Approach Needed ?](#why-is-a-programmatic-approach-needed-) +- [TapFlow Usage Example](#tapflow-usage-example) + - [Installing TapFlow](#installing-tapflow) + - [Create Source and Target Database Connections](#create-source-and-target-database-connections) + - [Create a Simple Order Table Replication Task (Data Flow)](#create-a-simple-order-table-replication-task-data-flow) + - [Exclude Fields](#exclude-fields) + - [Field Rename](#field-rename) + - [Perform Complex Custom Processing with Python Script](#perform-complex-custom-processing-with-python-script) + - [Use Lookup to Enrich Customer Information in the Order Table](#use-lookup-to-enrich-customer-information-in-the-order-table) + - [Final Result In Monogdb](#final-result-in-monogdb) + - [Run Python Code using TapFlow command](#run-python-code-using-tapflow-command) +- [Known Issue](#known-issue) +- [TapFlow Roadmap](#tapflow-roadmap) +- [About TapData Live Data Platform](#about-tapdata-live-data-platform) +- [Common Use Cases of TapData](#common-use-cases-of-tapdata) +- [Join Our Community](#join-our-community) ## What is TapFlow