wintoncode / winton-kafka-streams

A Python implementation of Apache Kafka Streams
Apache License 2.0
313 stars 55 forks source link

Add read the docs configuration #46

Closed llawall closed 6 years ago

llawall commented 6 years ago

A few warnings in the output that ought to be cleaned up but nothing too serious. Can be done as part of pull request to actually write some reasonable documentation - currently this just outputs an API reference section.

llawall commented 6 years ago

This pull request addresses issues #13

ah- commented 6 years ago

Nice! Is this visible already somewhere?

That travis error on nighly python 3.7

../../../virtualenv/python3.7-dev/lib/python3.7/site-packages/_pytest/python.py:403: in _importtestmodule
    mod = self.fspath.pyimport(ensuresyspath=importmode)
../../../virtualenv/python3.7-dev/lib/python3.7/site-packages/py/_path/local.py:668: in pyimport
    __import__(modname)
<frozen importlib._bootstrap>:971: in _find_and_load
    ???
<frozen importlib._bootstrap>:955: in _find_and_load_unlocked
    ???
<frozen importlib._bootstrap>:656: in _load_unlocked
    ???
<frozen importlib._bootstrap>:626: in _load_backward_compatible
    ???
../../../virtualenv/python3.7-dev/lib/python3.7/site-packages/_pytest/assertion/rewrite.py:213: in load_module
    py.builtin.exec_(co, mod.__dict__)
tests/processor/serde/test_serialisation.py:1: in <module>
    from winton_kafka_streams.processor.serialization.serdes import *
winton_kafka_streams/processor/__init__.py:10: in <module>
    from ._stream_thread import StreamThread
winton_kafka_streams/processor/_stream_thread.py:14: in <module>
    from ._stream_task import StreamTask
E     File "/home/travis/build/wintoncode/winton-kafka-streams/winton_kafka_streams/processor/_stream_task.py", line 162
E       self.consumer.commit(offsets=offsets_to_commit, async=False)
E                                                           ^
E   SyntaxError: invalid syntax

might be because async is becoming a keyword? Looks more like a confluent kafka python bug.

Edit: See more here: https://github.com/confluentinc/confluent-kafka-python/pull/21

llawall commented 6 years ago

I'll merge this now. As noted by @ah- on confluentinc/confluent-kafka-python#21 the Python nightly failure is due to a planned Python language change in 3.7. We will move to using asynchronous keyword arg when available in confluent kafka Python release.

PEP 492 transition plan for await/async to become full keywords: https://www.python.org/dev/peps/pep-0492/#deprecation-plans

Recent CPython pull request implementing this: python/cpython#1669

llawall commented 6 years ago

Documentation for latest (i.e. master) build now available here: http://winton-kafka-streams.readthedocs.io/en/latest/