Bill Service

This repository contains the code for FastAPI with SQL filters (Public) (https://uselevers.notion.site/FastAPI-with-SQL-filters-Public-1bcffc3c24f042519093373b526666cd) It provides functionalities such as:

Add new bill with sub bills
Fetch bills with filter reference, total_from, total_to

Directory Structure

The repository has the following directory structure:

.
|-- Dockerfile
|-- alembic
|   |-- ....
|-- alembic.ini
|-- app
|   |-- __init__.py
|   |-- api
|   |   |-- __init__.py
|   |   `-- bills_api.py
|   |-- config.py
|   |-- database.py
|   |-- main.py
|   |-- models.py
|   |-- repositories
|   |   |-- __init__.py
|   |   `-- bill_repository.py
|   |-- schemas.py
|   |-- services
|   |   |-- __init__.py
|   |   `-- bill_service.py
|   `-- utils
|       |-- base_model.py
|       `-- base_repository.py
|-- conftest.py
|-- docker-compose.yml
|-- readme.md
|-- requirements.txt
|-- testdbconfig.py
|-- tests
|   |-- __init__.py
|   |-- factories.py
|   `-- test_apis
|       |-- test.sqlite
|       `-- test_bills.py

Installation

To install and run the app using Docker Compose, follow these steps:

Create a new file named .env from .env.example using a text editor:

cp .env.example .env

Open the .env file in a text editor and define the necessary environment variables. These variables are used to configure the application. You can use the following content

DATABASE_URL=postgresql+psycopg2://admin:password@db_service:5432/bill_db
DB_USER=admin
DB_PASSWORD=password
DB_NAME=bill_db
PGADMIN_EMAIL=admin@admin.com
PGADMIN_PASSWORD=admin

Build and start the Docker containers using Docker Compose:

docker-compose up -d

This command will build the Docker image and start the containers in detached mode.

Verify that the containers are running:

docker-compose ps

You should see the running containers listed

Now run the migrations using alembic in docker container:

docker-compose run --rm api alembic upgrade head

The app will now be accessible at http://localhost:8000.

To access API doc: http://localhost:8000/docs
To access pgadmin: http://127.0.0.1:5050/

You can use tools like cURL, Postman, or any other HTTP client to interact with the API endpoints.

Code Quality and Standards

Code Linting

Check app linting

ruff app

To fix linting issues

ruff --fix app

Run Tests

Run the tests using pytest in docker:

docker-compose run --rm api pytest

This command will discover and execute all the tests in the project.

If you want to generate a coverage report to see the test coverage, you can use the --cov option:

docker-compose run --rm api pytest --cov=app

The coverage report will show which parts of the code are covered by the tests.

Current the test coverage is 87%