Transactional Ruler
Lib to post user events on transactional topics
Running tests and lint
docker-compose up integration-tests
docker-compose up lint
Installation
pip install jsm-transactional-ruler
Example Usage
from jsm_transactional_ruler.enums import EventType
from jsm_transactional_ruler.events import Event
from jsm_transactional_ruler.publisher import publish_event
event = Event(
user_id="fake_id", event_type=EventType.T_EVENT_REGISTERED_USER, data={"email": "teste@juntossomosmais.com.br"}
)
publish_event(event_trigger=event)
The attribute event_type accepts only events registered in the EventType enum.
The publish_event method accepts the optional queue and publisher_parameters parameters to send to django-stomp:
event = Event(
user_id="fake_id", event_type=EventType.T_EVENT_REGISTERED_USER, data={"email": "teste@juntossomosmais.com.br"}
)
publish_event(event_trigger=event, queue="/topic/VirtualTopic.user-update-transactions", persistent=False)
Versioning
This lib follows the pypi version format with the convention of using major.minor.patch version.
When to bump a patch version?
Bump the patch version if you are doing a quick fix, nothing that changes the library functionality.
When to bump the minor version?
Bump the minor version if you are adding new functionality without breaking backwards compatibility. For example, adding support to new events.
When to bump the major version?
Bump the major version if you are breaking backwards compatibility by adding new functionality or refactoring.
Contributing
This project uses a trunk based development flow, so that we have only one long-lived branch (master).
For any development, simply create a branch from it and follow the flow described below.
How to upload lib to PyPI
It is necessary to update the lib version using the command below:
$ poetry version major|minor|patch
After generating the version:
- Create a new branch with the files updated by Poetry
- Open PR based on the
masterbranch - Merge PR into the master
- Generate a new release based on the version. Document to generate release
- After generating the new release "Github Actions" will upload the lib to PyPI using Poetry.
- Good job!
1 maintainer
Metadata
1 maintainer
Release files for jsm-transactional-ruler 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jsm_transactional_ruler-3.1.0.tar.gz | 4.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jsm_transactional_ruler-3.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.0 kB
Release files / jsm_transactional_ruler-3.1.0.tar.gz
| Download URL | jsm_transactional_ruler-3.1.0.tar.gz |
|---|---|
| Size | 4.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c68b8edf0eb386f2012d47b7c44f4a45b69072acb6da5747a242dff2c03bf28c
|
|
BLAKE2b-256 checksum How to use checksums |
65bab24b20ef5f40f6e20cba440d7cc4653f8dca09cc716fe724ca4319df96c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.13 Linux/6.17.0-1008-azure
|
Release files / jsm_transactional_ruler-3.1.0-py3-none-any.whl
| Download URL | jsm_transactional_ruler-3.1.0-py3-none-any.whl |
|---|---|
| Size | 5.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
815ddad116ceaadf61f05e8d279ba263f2f1cde619cf70c66df81feaa858d28b
|
|
BLAKE2b-256 checksum How to use checksums |
ce95a2c0943cc253978df508c1a41bdc813e9a550657786b1afcb1afbcf99a71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.13 Linux/6.17.0-1008-azure
|
