Skip to content

lucianlorens/api-python-weather

Repository files navigation

api-python-weather

Weather API made with Python, Django Rest Framework and ClimaCell API.

Prerequisites

  • Python installed;
  • PostgreSQL 13 installed; (optional) Docker installed.

[wip]

Getting Started

You need to get to the root folder of the project.

From the folder base run the following commands. python -m venv env_django

Linux: source activate env_django

Windows: env_django\Scripts\activate

then install the dependencies using pip install -r requirements.txt

To run the application use: python manage.py runserver

If you made any changes to the application you can use: python manage.py makemigrations to make database migrations and use python manage.py migrate --run-syncdb to execute your database migrations.

Alternative way: Using docker do a docker-compose up in the root folder of the project.

[wip]

Architecture

architecture_image

Installing

[wip]

Running the tests

[wip]

Break down into end to end tests

[wip]

And coding style tests

[wip]

Deployment

You can deploy with Heroku as it is using Heroku Deployment pipelines

[wip]

Built With

  • Heroku - is a platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud.
  • Django Rest Framework - Django REST framework is a powerful and flexible toolkit for building Web APIs.
  • ClimaCell Weather API - The world's best hyperlocal weather API — real-time and historical weather data, customizable for every use case and business model. ** For additional information checkout the official documentation from Climacell API at https://developer.climacell.co/v3/docs/historical
  • PostgreSQL - is a powerful, open source object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

Contributing

[wip]

Versioning

Branches

  • Production: main
  • Development: dev

Commit Pattern:

Using https://gitmoji.dev/ emoji pattern to easy find commits topics

Authors

License

🚧 [wip] 🚧

Acknowledgments

To my Family, ever helping, ever supporting.

About

weather API made with Python

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published