FDC Shared Kernel
Shared Kernel is a lightweight, modular Python library designed to facilitate rapid development of microservices. It provides essential utilities for data manipulation, logging, configuration management, and database connectivity, making it an ideal foundation for building scalable and maintainable microservices.
Table of Contents
Getting Started
Prerequisites
- Python 3.6+
- Pip
Installation
To install Shared Kernel, clone the repository and install it using pip:
pip install fdc-shared-kernel
Usage
Importing Modules
Import the required modules from Shared Kernel into your project:
from shared_kernel.logger import Logger
from shared_kernel.config import Config
from dotenv import find_dotenv
def main():
logger = Logger(name="my_app")
logger.configure_logger()
# Specify the path to the .env file if it's not in the current directory
config_manager = Config(env_path=find_dotenv())
# Access environment variables
api_key = config_manager.get("KEY", "default_api_key")
# Example usage
logger.logger.info("This is an info message.")
logger.logger.error("This is an error message.")
logger.logger.info(api_key)
if __name__ == "__main__":
main()
Initializing Database Connection
Use the DB class to initialize a database connection:
from shared_kernel.DB import DB
db_instance = DB("postgresql://user:password@localhost/dbname")
engine, SessionLocal = db_instance.init_db_connection()
Initializing NATS Connection
Use the NATSClient class to initialize:
from shared_kernel.messaging import NATSClient
import asyncio
def run():
nats_instance = NATSClient("nats://localhost:4222")
await nc_interface.connect()
async def message_callback(data):
print(f"Received a message: {data}")
await nc_interface.subscribe("example_subject", message_callback)
await nc_interface.publish("example_subject", "Hello NATS!")
if __name__ == '__main__':
asyncio.run(run())
Using Keyvault Manager
Use the KeyVaultManager class to initialize:
from shared_kernel.security import KeyVaultManager
def run():
aws_vault = KeyVaultManager.create_key_vault('aws', {
'region_name': 'us-east-1',
'AWS_SERVER_PUBLIC_KEY': '<key here>',
'AWS_SERVER_SECRET_KEY': '<secret here>'
})
# AWS Secrets Manager operations
aws_vault.store_secret("fdc_api_key", "123456")
print(aws_vault.retrieve_secret("fdc_api_key")) # Output: 123456
print(aws_vault.list_secrets()) # Output: ['fdc_api_key']
aws_vault.delete_secret("api_key")
print(aws_vault.list_secrets()) # Output: []
if __name__ == '__main__':
run()
Using JWT Token handler
Use the JWTTokenHandler class to initialize:
from shared_kernel.security import JWTTokenHandler
def run():
secret_key = 'your-secret-key'
token_handler = JWTTokenHandler(secret_key)
payload = token_handler.decode_token('your-jwt-token')
if __name__ == '__main__':
run()
Using JWTTokenHandler
Use the JWTTokenHandler class to initialize:
from shared_kernel.auth import JWTTokenHandler
def run():
secret_key = 'your-secret-key'
token_handler = JWTTokenHandler(secret_key)
payload = token_handler.decode_token('your-jwt-token')
if __name__ == '__main__':
run()
In routes
from shared_kernel.auth import token_required
@app.route('/')
@token_required
def user(current_user):
return jsonify(current_user)
Using HTTP Client
Use the HttpClient class to initialize:
from shared_kernel.http import HttpClient
def run():
client = HttpClient()
response_data = client.get("https://api.example.com/data")
print(response_data)
if __name__ == '__main__':
run()
6 maintainers
Metadata
6 maintainers
Release files for fdc-shared-kernel 0.0.196
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fdc_shared_kernel-0.0.196.tar.gz | 113.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fdc_shared_kernel-0.0.196-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 310.5 kB
