Giter Club home page Giter Club logo

cloudia-api's Introduction

Cloudia - API

This repository contains the API application for the Cloudia project.


Project overview: https://github.com/germainlefebvre4/cloudia-project

Documentation: https://cloudia.readthedocs.io/


Getting started

Install required packages:

sudo apt update
sudo apt install python3-pip python3-dev
pip install poetry

Setup the databases:

docker compose up -d db redis
docker compose restart redis
docker compose exec -ti redis redis-cli config set stop-writes-on-bgsave-error no

Run the app:

poetry install
poetry run alembic upgrade head
poetry run python app/initial_data.py
poetry run uvicorn app.main:app --port=8080 --reload

Troubleshooting

Some distributions might miss some packages. These are some hints if needed:

# cryptography/cffi
sudo apt install build-essential libssl-dev libffi-dev libpq-dev

Development

Setup workspace

sudo apt update
sudo apt install python3-pip python3-dev
pip install poetry
poetry install

Run locally

This section use docker database called cloudia.

docker compose up -d db redis
docker compose restart redis
poetry run alembic upgrade head
poetry run python app/initial_data.py
poetry run uvicorn app.main:app --port=8080 --reload

Run tests

This section use docker database called cloudia_test.

docker compose up -d db_test redis_test
docker compose restart redis_test
poetry run pytest -sv app/tests/

cloudia-api's People

Contributors

germainlefebvre4 avatar

Stargazers

 avatar

Watchers

 avatar

cloudia-api's Issues

Carbon Footprint overview

Project issue:

Linked PRs:

Todo list:

  • Setup Cloud Carbon Footprint application at https://github.com/cloud-carbon-footprint/cloud-carbon-footprint
    • Write documentation better than him with explicit and automated parts
    • Run the CCF app
    • Base Cloudia API data retrieving on CCF API
  • Create route to retrieve specified project for specified cloud provider billing data
    • AWS
    • GCP
    • Azure
  • Create route to retrieve specified cloud provider billing data
    • AWS
    • GCP
    • Azure
  • Create route to retrieve all cloud providers billing data

Billing overview

Project issue:

Linked PRs:

Todo list:

  • Create route to retrieve specified project for specified cloud provider billing data
    • AWS
    • GCP
    • Azure
  • Create route to retrieve specified cloud provider billing data
    • AWS
    • GCP
    • Azure
  • Create route to retrieve all cloud providers billing data

Settings page

Project issue:

Linked PRs:

Todo list:

  • List the settings writtne in the .env file
  • Create/update a database table "setting" and store/prepare desired settings
  • Update routes to get settings (one and all)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.