You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tz...@apache.org on 2020/03/26 07:10:34 UTC
[flink-statefun] branch master updated (d3ed448 -> 091ebf3)
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git.
from d3ed448 [FLINK-16785] Add README.md for the Python SDK
new 613b90f [hotfix] Improve main README
new 091ebf3 [FLINK-16785] [py] Add descriptions to Python SDK setup.py
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.md | 11 +++++++----
statefun-python-sdk/README.md | 1 +
statefun-python-sdk/setup.py | 11 ++++++++++-
3 files changed, 18 insertions(+), 5 deletions(-)
[flink-statefun] 01/02: [hotfix] Improve main README
Posted by tz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit 613b90f6acd6bc0096c8145e5fa2d3f6f55aa1fa
Author: Tzu-Li (Gordon) Tai <tz...@apache.org>
AuthorDate: Thu Mar 26 15:01:09 2020 +0800
[hotfix] Improve main README
- Intro should mention that this is an Apache Flink library
- Change docs link from https://statefun.io to the official
Apache-hosted docs.
---
README.md | 11 +++++++----
statefun-python-sdk/README.md | 1 +
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index e15dc2d..978d9be 100755
--- a/README.md
+++ b/README.md
@@ -1,16 +1,19 @@
<img alt="Stateful Functions" src="statefun-docs/images/stateful_functions_logo.png" width=400px/>
-Stateful Functions is a library for distributed applications and services, based on, well, you guessed it: stateful functions.
+Stateful Functions is an [Apache Flink](https://flink.apache.org/) library for distributed applications and services, based on, well, you guessed it: stateful functions.
The project aims to simplify the development of distributed stateful applications by solving some of the common
challenges in those applications: scaling, consistent state management, reliable interaction between distributed
services, and resource management.
-Stateful Functions uses [Apache Flink](https://flink.apache.org/) for distributed coordination, state, and communication.
+Stateful Functions uses Apache Flink for distributed coordination, state, and communication.
This README is meant as a brief walkthrough on the core concepts and how to set things up
-to get yourself started with Stateful Functions. For a fully detailed documentation, please
-see [https://statefun.io](https://statefun.io).
+to get yourself started with Stateful Functions.
+
+For a fully detailed documentation, please visit the [official docs](https://ci.apache.org/projects/flink/flink-statefun-docs-master).
+
+For code examples, please take a look at the [examples](statefun-examples/).
[](https://travis-ci.org/apache/flink-statefun)
diff --git a/statefun-python-sdk/README.md b/statefun-python-sdk/README.md
index a661749..a7dee5b 100755
--- a/statefun-python-sdk/README.md
+++ b/statefun-python-sdk/README.md
@@ -12,6 +12,7 @@ This description is meant as a brief walkthrough on the core concepts and how to
to get yourself started with Stateful Functions.
For a fully detailed documentation, please visit the [official docs](https://ci.apache.org/projects/flink/flink-statefun-docs-release-stable).
+
For code examples, please visit the examples in the [Github repo](https://github.com/apache/flink-statefun/tree/master/statefun-examples).
## Table of Contents
[flink-statefun] 02/02: [FLINK-16785] [py] Add descriptions to
Python SDK setup.py
Posted by tz...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit 091ebf39535afe672498d9fabd7f01d3b63c56de
Author: Tzu-Li (Gordon) Tai <tz...@apache.org>
AuthorDate: Thu Mar 26 15:09:13 2020 +0800
[FLINK-16785] [py] Add descriptions to Python SDK setup.py
---
statefun-python-sdk/setup.py | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/statefun-python-sdk/setup.py b/statefun-python-sdk/setup.py
index caca6ac..4858b1d 100644
--- a/statefun-python-sdk/setup.py
+++ b/statefun-python-sdk/setup.py
@@ -18,6 +18,13 @@
from setuptools import setup
+import io
+import os
+
+this_directory = os.path.abspath(os.path.dirname(__file__))
+with io.open(os.path.join(this_directory, 'README.md'), 'r', encoding='utf-8') as f:
+ long_description = f.read()
+
setup(
name='apache-flink-statefun',
version='2.1-SNAPSHOT',
@@ -26,7 +33,9 @@ setup(
license='https://www.apache.org/licenses/LICENSE-2.0',
author='Apache Software Foundation',
author_email='dev@flink.apache.org',
- description='Python SDK for Flink Stateful functions',
+ description='Python SDK for Apache Flink Stateful functions',
+ long_description=long_description,
+ long_description_content_type='text/markdown',
install_requires=['protobuf>=3.11.3,<4.0.0'],
tests_require=['pytest'],
python_requires='>=3.5',