Skip to content

Commit

Permalink
[hotfix] updated setup.py and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick Wiener committed Aug 10, 2020
1 parent 86dbbde commit b618b85
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 18 deletions.
52 changes: 37 additions & 15 deletions streampipes-wrapper-python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,37 @@
~ limitations under the License.
~
-->
# [WIP] Apache StreamPipes Wrapper for Python

[![Github Actions](https://img.shields.io/github/workflow/status/apache/incubator-streampipes/build-and-deploy-docker-dev)](https://github.com/apache/incubator-streampipes/actions/)
[![Docker pulls](https://img.shields.io/docker/pulls/apachestreampipes/backend.svg)](https://hub.docker.com/r/apachestreampipes/backend/)
[![Maven central](https://img.shields.io/maven-central/v/org.apache.streampipes/streampipes-backend.svg)](https://img.shields.io/maven-central/v/org.apache.streampipes/streampipes-backend.svg)
[![License](https://img.shields.io/github/license/apache/incubator-streampipes.svg)](http://www.apache.org/licenses/LICENSE-2.0)
[![Last commit](https://img.shields.io/github/last-commit/apache/incubator-streampipes.svg)]()
[![Twitter](https://img.shields.io/twitter/follow/StreamPipes.svg?label=Follow&style=social)](https://twitter.com/StreamPipes)

## Apache StreamPipes Wrapper for Python [WIP]
**NOTE**:

> The python wrapper is currently under development. Thus, it only works in combination when having Java processor for describing, registration and talking to the backend.
> The StreamPipes wrapper for python is currently under development. Thus, the processor model description still needs to be implemented externally in Java.
## Apache StreamPipes
Apache StreamPipes (incubating) enables flexible modeling of stream processing pipelines by providing a graphical
modeling editor on top of existing stream processing frameworks.

It leverages non-technical users to quickly define and execute processing pipelines based on an easily extensible
toolbox of data sources, data processors and data sinks. StreamPipes has an exchangeable runtime execution layer and executes pipelines using one of the provided wrappers, e.g., for Apache Flink or Apache Kafka Streams.

Pipeline elements in StreamPipes can be installed at runtime - the built-in SDK allows to easily implement new
pipeline elements according to your needs. Pipeline elements are standalone microservices that can run anywhere - centrally on your server, in a large-scale cluster or close at the edge.


### A minimal example
#### Define a processor
```
## A Speudocode Example
**NOTE**:
Only works in combination with Java!
````
from streampipes.core import StandaloneModelSubmitter
from streampipes.manager import Declarer
from streampipes.model.pipeline_element_config import Config
from streampipes.core import EventProcessor
Expand All @@ -38,15 +60,6 @@ class HelloWorldProcessor(EventProcessor):
def on_detach(self):
pass
```
This processor received an event `dict` and adds a new `greeting` field including the message `hello world` to it.
#### Add to processor dict
````
from streampipes.core import StandaloneModelSubmitter
from streampipes.manager import Declarer
from streampipes.model.pipeline_element_config import Config
from helloworld import HelloWorldProcessor
def main():
Expand Down Expand Up @@ -85,4 +98,13 @@ def main():
if __name__ == '__main__':
main()
````
Add the newly defined `HelloWorldProcessor` to the processors dictionary including a unique id `org.apache.streampipes.processors.python.helloworld`.

### DISCLAIMER (WIP)
Apache StreamPipes is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache
Incubator. Incubation is required of all newly accepted projects until a further review indicates that the
infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Some of the incubating project’s releases may not be fully compliant with ASF policy. For example, releases may have incomplete or un-reviewed licensing conditions. What follows is a list of known issues the project is currently aware of (note that this list, by definition, is likely to be incomplete):
(currently no issues are known)

If you are planning to incorporate this work into your product/project, please be aware that you will need to conduct a thorough licensing review to determine the overall implications of including this work. For the current status of this project through the Apache Incubator visit: https://incubator.apache.org/projects/streampipes.html
4 changes: 2 additions & 2 deletions streampipes-wrapper-python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
long_description = f.read()

setup(
name='apache-streampipes-python',
version='0.67.0-SNAPSHOT',
name='apache-streampipes',
version='0.67.0.dev1',
packages=find_packages(),
package_data={'streampipes': ['api/templates/*']},
url='https://github.com/apache/incubator-streampipes',
Expand Down
2 changes: 1 addition & 1 deletion streampipes-wrapper-python/streampipes/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@


class EventProcessor(object):
__metaclass__ = abc.ABC
__metaclass__ = abc.ABC0

_DEFAULT_KAFKA_CONSUMER_CONFIG = {
'bootstrap.servers': 'kafka:9092',
Expand Down

0 comments on commit b618b85

Please sign in to comment.