Skip to content

A focused API microservice for calculating food voucher limits under ISR rules using current UMA values

Notifications You must be signed in to change notification settings

jcroyoaun/uma-calculator-microservice

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UMA Calculator Microservice

A focused API microservice for calculating food voucher limits under ISR rules using current UMA values.

Features

  • Automated UMA value updates from INEGI's official API
  • Food voucher limit validation according to ISR rules
  • Remaining limit calculations
  • Swagger UI documentation for all endpoints

API Endpoints

  • /api/v1/uma - Get current UMA values
  • /api/v1/vouchers/validate - Validate voucher amounts
  • /api/v1/vouchers/remaining - Check remaining limits

Requirements

  • Python 3.11+
  • PostgreSQL database
  • INEGI API key for UMA updates

Setup

  1. Set required environment variables:

    • DATABASE_URL: PostgreSQL connection string
    • INEGI_API_KEY: API key for INEGI's service
  2. Install dependencies:

    pip install -r requirements.txt
  3. Run migrations:

    flask db upgrade
  4. Start the server:

    python main.py

Documentation

API documentation is available at /swagger-ui/ when the server is running.

Commands

  • flask update-uma: Update UMA values from INEGI's API

License

MIT

About

A focused API microservice for calculating food voucher limits under ISR rules using current UMA values

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published