Skip to main content

A shared utility library for event management system based on microservices architecture.

Project description

Shared Library Approach in Microservices

Why Use a Shared Library?

In a microservices architecture, multiple services often need common functionalities such as logging, error handling, authentication, and utility functions. Instead of duplicating code across services, we use a shared library to:

Reduce Code Duplication : Avoid repeating the same logic in every service.
Ensure Consistency : Standardized utilities across all services.
Simplify Maintenance : Fix issues or update features in one place.
Improve Scalability : Microservices remain lightweight and focused.
Enhance Deployment : Easier to manage updates and dependencies.

Installation

To install the shared library in your microservices, run:

pip install shared-utils

Or specify it in your requirements.txt:

shared-utils>=1.0.0

Usage

Inside any microservice, import and use the shared utilities:

from shared_utils.logging import setup_logger

logger = setup_logger(__name__)
logger.info("Shared utilities are working!")

Updating shared_utils

If a new feature or bug fix is added to shared_utils, follow these steps:

  1. Modify the code: Implement your changes in shared_utils.

  2. Update version: Change the version in setup.py (e.g., 1.0.1 to 1.0.2).

  3. Build the package:

    python setup.py sdist bdist_wheel
    
  4. Publish to PyPI:

    twine upload dist/*
    
  5. Upgrade in services:

    pip install --upgrade shared-utils
    

Versioning

We follow Semantic Versioning (SemVer):

  • MAJOR – Breaking changes.
  • MINOR – New features (backward compatible).
  • PATCH – Bug fixes and improvements.

release history

pypi

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shared_utils_ems-4.2.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shared_utils_ems-4.2.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file shared_utils_ems-4.2.0.tar.gz.

File metadata

  • Download URL: shared_utils_ems-4.2.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for shared_utils_ems-4.2.0.tar.gz
Algorithm Hash digest
SHA256 0046ad1e2b667c4034b4a03e237e5696f58ba18d7d26c01fdae7bca5b9b6cf7d
MD5 4ed8953e147f4d5944ad5be168c1bee3
BLAKE2b-256 4d309e44c7683a1be9e0a0667ca2fca31a51920f0a72ec08bcb494aa19aa97a6

See more details on using hashes here.

File details

Details for the file shared_utils_ems-4.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for shared_utils_ems-4.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 691f4711bd8d8c44f9703ff4bc97c2a50da846bef05ce0c38d889ad4aed6ad81
MD5 b5cd94d998dbe0c9e32b3275fd157f93
BLAKE2b-256 1036658dd3237e6ed77e384b64f98804451342c57d0716e5a2327d6808049802

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page