Skip to content

Commit

Permalink
docs: Fix badges and other cookiecutter-created repo/package referenc…
Browse files Browse the repository at this point in the history
…es (#22)
  • Loading branch information
timmc-edx authored and whuang1202 committed Aug 10, 2022
1 parent ccab679 commit be8514f
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 14 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Unreleased

*

[0.3.0] - 2022-08-10
~~~~~~~~~~~~~~~~~~~~

Updated
_______

* Moved configuration onto separate file.

[0.2.0] - 2022-08-09
~~~~~~~~~~~~~~~~~~~~

Expand Down
26 changes: 13 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ One Time Setup
.. code-block::
# Clone the repository
git clone [email protected]:edx/event-bus-kafka.git
git clone [email protected]:openedx/event-bus-kafka.git
cd event-bus-kafka
# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
Expand Down Expand Up @@ -131,26 +131,26 @@ For more information about these options, see the `Getting Help`_ page.
.. _community Slack workspace: https://openedx.slack.com/
.. _Getting Help: https://openedx.org/getting-help

.. |pypi-badge| image:: https://img.shields.io/pypi/v/event-bus-kafka.svg
:target: https://pypi.python.org/pypi/event-bus-kafka/
.. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-event-bus-kafka.svg
:target: https://pypi.python.org/pypi/edx-event-bus-kafka/
:alt: PyPI

.. |ci-badge| image:: https://github.com/edx/event-bus-kafka/workflows/Python%20CI/badge.svg?branch=main
:target: https://github.com/edx/event-bus-kafka/actions
.. |ci-badge| image:: https://github.com/openedx/event-bus-kafka/workflows/Python%20CI/badge.svg?branch=main
:target: https://github.com/openedx/event-bus-kafka/actions
:alt: CI

.. |codecov-badge| image:: https://codecov.io/github/edx/event-bus-kafka/coverage.svg?branch=main
:target: https://codecov.io/github/edx/event-bus-kafka?branch=main
.. |codecov-badge| image:: https://codecov.io/github/openedx/event-bus-kafka/coverage.svg?branch=main
:target: https://codecov.io/github/openedx/event-bus-kafka?branch=main
:alt: Codecov

.. |doc-badge| image:: https://readthedocs.org/projects/event-bus-kafka/badge/?version=latest
:target: https://event-bus-kafka.readthedocs.io/en/latest/
.. |doc-badge| image:: https://readthedocs.org/projects/edx-event-bus-kafka/badge/?version=latest
:target: https://edx-event-bus-kafka.readthedocs.io/en/latest/
:alt: Documentation

.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/event-bus-kafka.svg
:target: https://pypi.python.org/pypi/event-bus-kafka/
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-event-bus-kafka.svg
:target: https://pypi.python.org/pypi/edx-event-bus-kafka/
:alt: Supported Python versions

.. |license-badge| image:: https://img.shields.io/github/license/edx/event-bus-kafka.svg
:target: https://github.com/edx/event-bus-kafka/blob/main/LICENSE.txt
.. |license-badge| image:: https://img.shields.io/github/license/openedx/event-bus-kafka.svg
:target: https://github.com/openedx/event-bus-kafka/blob/main/LICENSE.txt
:alt: License
2 changes: 1 addition & 1 deletion edx_event_bus_kafka/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
Kafka implementation for Open edX event bus.
"""

__version__ = '0.2.0'
__version__ = '0.3.0'
1 change: 1 addition & 0 deletions edx_event_bus_kafka/publishing/event_producer.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ def get_producer_for_signal(signal: OpenEdxPublicSignal, event_key_field: str) -
return None

signal_serializer = get_serializer(signal)

def inner_to_dict(event_data, ctx=None): # pylint: disable=unused-argument
"""Tells Avro how to turn objects into dictionaries."""
return signal_serializer.to_dict(event_data)
Expand Down

0 comments on commit be8514f

Please sign in to comment.