Metadata-Version: 2.1
Name: sinetstream
Version: 1.1.0
Summary: Library for operating messaging systems such as Apache Kafka and MQTT with the same API.
Home-page: https://github.com/nii-gakunin-cloud/sinetstream
License: Apache License, Version 2.0
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: Japanese
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >= 3.6
Description-Content-Type: text/markdown
Requires-Dist: pyyaml
Requires-Dist: pycryptodome
Requires-Dist: avro-python3

<!--
Copyright (C) 2019 National Institute of Informatics

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

[English](README.en.md)

# SINETStream python

## ファイル構成

* src/
    * Python版SINETStreamの実装
* tests/
    * ユニットテスト
* sample/
    * サンプルプログラム
* plugins/
    * broker/
        * kafka/
            * SINETStreamのKafkaプラグイン
        * mqtt
            * SINETStreamのMQTTプラグイン
    * value_type/
        * image/
            * 画像をメッセージとして扱うためのプラグイン
* README.md

## ビルド手順

次のコマンドを実行するとSINETStreamのTARファイルがビルドされる。

```
$ python3 setup.py bdist_wheel
$ cd plugins/broker/kafka
$ python3 setup.py bdist_wheel
$ cd ../mqtt
$ python3 setup.py bdist_wheel
$ cd ../../value_type/image
$ python3 setup.py bdist_wheel
```

ビルドが成功すると以下のwheel ファイルが作成される。

```
./dist/sinetstream-1.1.0-py3-none-any.whl
./plugins/broker/kafka/dist/sinetstream_kafka-1.1.0-py3-none-any.whl
./plugins/broker/mqtt/dist/sinetstream_mqtt-1.1.0-py3-none-any.whl
./plugins/value_type/image/dist/sinetstream_type_image-1.1.0-py3-none-any.whl
```

## インストール

pypiに登録してあるパッケージを利用することもできる。

```
pip3 install --user sinetstream-kafka sinetstream-mqtt
```

画像タイプのメッセージを扱いたい場合は、imageプラグインをインストールする。
```
pip3 install --user sinetstream-type-image
```

## 依存関係にあるライブラリ

* [kafka-python](https://kafka-python.readthedocs.io/en/master/)
* [mqtt client](https://www.eclipse.org/paho/clients/python/docs/)



