.. image:: https://img.shields.io/pypi/v/kser-crypto.svg
:target: https://pypi.python.org/pypi/kser-crypto/
:alt: Latest Version
.. image:: https://travis-ci.org/cdumay/kser-crypto.svg?branch=master
:target: https://travis-ci.org/cdumay/kser-crypto
:alt: Latest version
.. image:: https://readthedocs.org/projects/kser-crypto/badge/?version=latest
:target: http://kser-crypto.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/cdumay/kser-crypto/blob/master/LICENSE
.. image:: https://github.com/cdumay/kser-crypto/blob/reports/junit/tests-badge.svg?raw=true
:target: https://htmlpreview.github.io/?https://github.com/cdumay/kser-crypto/blob/reports/junit/report.html
:alt: Tests
.. image:: https://github.com/cdumay/kser-crypto/blob/reports/flake8/flake8-badge.svg?raw=true
:target: https://htmlpreview.github.io/?https://github.com/cdumay/kser-crypto/blob/reports/flake8/index.html
:alt: Lint
.. image:: https://github.com/cdumay/kser-crypto/blob/reports/coverage/coverage-badge.svg?raw=true
:target: https://htmlpreview.github.io/?https://github.com/cdumay/kser-crypto/blob/reports/coverage/html/index.html
:alt: Coverage badge
***********
kser-crypto
***********
`Kser <https://github.com/cdumay/kser>`_ module allow you to encrypt and decrypt messages in kafka using `libsodium <https://libsodium.org>`_.
----------
Quickstart
----------
First, install kser-crypto using
`pip <https://pip.pypa.io/en/stable/>`_:
$ pip install kser-crypto[pykafka]
.. note::
Only kafka-python is implemented at the moment.
--------
Examples
--------
Make sure to have the environment variable **KSER_SECRETBOX_KEY** definded.
Consumer
********
.. code-block:: python
from kser_crypto.python_kafka.consumer import CryptoConsumer
consumer = CryptoConsumer(config=dict(...), topics=[...])
consumer.run()
Producer
********
.. code-block:: python
import time
from uuid import uuid4
from kser.schemas import Message
from kser_crypto.python_kafka.producer import CryptoProducer
producer = CryptoProducer(config=dict(...))
producer.send("test", Message(uuid=str(uuid4()), entrypoint="myTest"))
time.sleep(1)
------------
Requirements
------------
- Python 3.x
- Libsodium
--------------
Documentations
--------------
- Project: http://kser.readthedocs.io/
- Libsodium: https://download.libsodium.org/doc/
- confluent-kafka-python: http://docs.confluent.io/current/clients/confluent-kafka-python
- kafka-python: http://kafka-python.readthedocs.io/en/master/
-----------
Other links
-----------
- PyPI: https://pypi.python.org/pypi/kser-crypto
- Project issues: https://github.com/cdumay/kser-crypto/issues
-------
License
-------
Licensed under MIT license (`LICENSE <./LICENSE>`_ or http://opensource.org/licenses/MIT)
Raw data
{
"_id": null,
"home_page": "https://github.com/cdumay/kser-crypto",
"name": "kser-crypto",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Cedric DUMAY",
"author_email": "cedric.dumay@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/37/26/7620aacc5022285bf395dcbacb993a223084fc823069aba01ad7f1e7c84d/kser-crypto-0.1.11.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/v/kser-crypto.svg\n :target: https://pypi.python.org/pypi/kser-crypto/\n :alt: Latest Version\n\n.. image:: https://travis-ci.org/cdumay/kser-crypto.svg?branch=master\n :target: https://travis-ci.org/cdumay/kser-crypto\n :alt: Latest version\n\n\n.. image:: https://readthedocs.org/projects/kser-crypto/badge/?version=latest\n :target: http://kser-crypto.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/cdumay/kser-crypto/blob/master/LICENSE\n\n.. image:: https://github.com/cdumay/kser-crypto/blob/reports/junit/tests-badge.svg?raw=true\n :target: https://htmlpreview.github.io/?https://github.com/cdumay/kser-crypto/blob/reports/junit/report.html\n :alt: Tests\n\n.. image:: https://github.com/cdumay/kser-crypto/blob/reports/flake8/flake8-badge.svg?raw=true\n :target: https://htmlpreview.github.io/?https://github.com/cdumay/kser-crypto/blob/reports/flake8/index.html\n :alt: Lint\n\n.. image:: https://github.com/cdumay/kser-crypto/blob/reports/coverage/coverage-badge.svg?raw=true\n :target: https://htmlpreview.github.io/?https://github.com/cdumay/kser-crypto/blob/reports/coverage/html/index.html\n :alt: Coverage badge\n\n***********\nkser-crypto\n***********\n\n`Kser <https://github.com/cdumay/kser>`_ module allow you to encrypt and decrypt messages in kafka using `libsodium <https://libsodium.org>`_.\n\n----------\nQuickstart\n----------\n\nFirst, install kser-crypto using\n`pip <https://pip.pypa.io/en/stable/>`_:\n\n $ pip install kser-crypto[pykafka]\n\n.. note::\n\n Only kafka-python is implemented at the moment.\n\n--------\nExamples\n--------\n\nMake sure to have the environment variable **KSER_SECRETBOX_KEY** definded.\n\nConsumer\n********\n\n.. code-block:: python\n\n from kser_crypto.python_kafka.consumer import CryptoConsumer\n\n consumer = CryptoConsumer(config=dict(...), topics=[...])\n consumer.run()\n\nProducer\n********\n\n.. code-block:: python\n\n import time\n from uuid import uuid4\n from kser.schemas import Message\n from kser_crypto.python_kafka.producer import CryptoProducer\n\n producer = CryptoProducer(config=dict(...))\n producer.send(\"test\", Message(uuid=str(uuid4()), entrypoint=\"myTest\"))\n time.sleep(1)\n\n------------\nRequirements\n------------\n\n- Python 3.x\n- Libsodium\n\n--------------\nDocumentations\n--------------\n\n- Project: http://kser.readthedocs.io/\n- Libsodium: https://download.libsodium.org/doc/\n- confluent-kafka-python: http://docs.confluent.io/current/clients/confluent-kafka-python\n- kafka-python: http://kafka-python.readthedocs.io/en/master/\n\n-----------\nOther links\n-----------\n\n- PyPI: https://pypi.python.org/pypi/kser-crypto\n- Project issues: https://github.com/cdumay/kser-crypto/issues\n\n-------\nLicense\n-------\n\nLicensed under MIT license (`LICENSE <./LICENSE>`_ or http://opensource.org/licenses/MIT)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Crypto Kafka serialize python library",
"version": "0.1.11",
"project_urls": {
"Homepage": "https://github.com/cdumay/kser-crypto"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "37267620aacc5022285bf395dcbacb993a223084fc823069aba01ad7f1e7c84d",
"md5": "8551ca040f23e1ed1d32514de672066d",
"sha256": "4def6b020b4cbb74cc61e30ff8519f786fac4b1d8be52283c2393e570f5aa6b6"
},
"downloads": -1,
"filename": "kser-crypto-0.1.11.tar.gz",
"has_sig": false,
"md5_digest": "8551ca040f23e1ed1d32514de672066d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6116,
"upload_time": "2023-10-02T15:07:44",
"upload_time_iso_8601": "2023-10-02T15:07:44.008188Z",
"url": "https://files.pythonhosted.org/packages/37/26/7620aacc5022285bf395dcbacb993a223084fc823069aba01ad7f1e7c84d/kser-crypto-0.1.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-02 15:07:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cdumay",
"github_project": "kser-crypto",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "cdumay-error",
"specs": [
[
">=",
"0.1.14"
]
]
},
{
"name": "cdumay-result",
"specs": [
[
">=",
"0.1.12"
]
]
},
{
"name": "kser",
"specs": [
[
">=",
"0.8.22"
]
]
},
{
"name": "pysodium",
"specs": [
[
">=",
"0.7.5"
]
]
}
],
"lcname": "kser-crypto"
}
JSON
