mrkutil
This is a Python package containing common functions for Python service-based architecture.
Base Handler
BaseHandler is an abstract class used for implementing function/class level factory pattern.
data = ["method"] = "my_defined_method"
handler = BaseHandler.process_data(data)
Where my_defined_method is the name of the child handler name static method.
Base Redis
Simple class with utility functions for working with redis. Key is the prefix for all redis objects, and timeout is how long redis keeps the object in cache. Example usage:
cache = RedisBase(key="key", timeout=300)
res = cache.get("this_key")
Communication
Communication package is a wrapper arround RabbitMQPubSub library that provides a simple interface for publishing and subscribing to messages.
call_service is a function that can be used to call a service with a message and await its response.
call_service(request_data=data, destination="some_exchange", source="self_exchange")
listen is a function that can be used to listen to a queue and call a function when a message is received. Commonly implemented in microservices in main.py as a long living process.
listen(exchange="some_exchange", exchange_type="direct", queue="some_queue")
trigger_service triggers a service with a message but does not wait for a response. Useful for fire and forget scenarios.
trigger_service(request_data=data, destination="some_exchange", source="self_exchange")
Logging Configuration
The get_logging_config function in mrkutil/logging/logging_config.py generates a logging configuration dictionary based on the provided parameters. It supports both JSON and default formatters.
config = get_logging_config(log_level="DEBUG", json_format=False, api=True)
Pagination
The paginate function in mongoengine.py and sqlalchemy.py is a utility function that paginates a list of items based on the provided page and page size.
It is useful in microservices where there is no accessible web framework pagination method, and to avoid code duplication.
There is also a dependency.py which contains pagination_params function that are usually used in fastapi dependency injection.
paginate(items, page_number=1, page_size=10, direction="asc", sort_by="id")
Responses
ServiceResponse class is a utility class for creating a standard response object that can be used in all services. It is useful for standardizing the response format across all services.
ServiceResponse(code=400, message="Validation Error", errors=[{"field": "name", "message": "Name is required"}])
Authors
Deployment to PyPI
To deploy this package to PyPI, use the following commands:
flit build
flit publish
Contributing
Contributions are always welcome! If you have any suggestions or improvements, feel free to submit a pull request or open an issue.
Release files for mrkutil 2.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mrkutil-2.1.1.tar.gz | 76.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mrkutil-2.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 102.8 kB
Release files / mrkutil-2.1.1.tar.gz
| Download URL | mrkutil-2.1.1.tar.gz |
|---|---|
| Size | 76.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8dfcedbc3f0a0f206ab8633901023a6642b40c29fca1c9e146e73a01e1977cc9
|
|
BLAKE2b-256 checksum How to use checksums |
18562d1f125975955e379d9fc35fec1d05ddbe5c4626ba1b88796e3684c152d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.3
|
Release files / mrkutil-2.1.1-py3-none-any.whl
| Download URL | mrkutil-2.1.1-py3-none-any.whl |
|---|---|
| Size | 25.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
83bdad9c1000ac7e84dcf939a943bed968553429a86518f7d9f994280a27ec53
|
|
BLAKE2b-256 checksum How to use checksums |
8e60164bf0a9eedb99a3429f03cb043c632ad16894e45fc73b67f01e9250f5a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.3
|
