/python-flask-heroku-ps5-notifier

A Python Flask application that can searches and notifies through Twillio when a PS5 console/digital is available.

Primary LanguagePython

Build Status Maintainability Coverage Status

Python Flask Heroku PS5 Notifier

A Python Flask application that can searches and notifies through Twillio when a PS5 console/digital is available.

Article written on Dev.to detailing project purpose, setup, and execution:
Message bot to find a PS5 on sale

Prerequisites

  • Python 3x
  • MongoDB

Recommendations

  • PyCharm
  • MongoDB Compass
  • Docker

Environment Variables

Copy the contents of .env.local into a new file named .env

cp .env.local .env

Running Locally

  1. Setup MongoDb

docker run -d -p 27017:27017 --name ps5-notifier mongo

  1. Install Python Dependencies
~ python3 -m venv python-flask-heroku-ps5-notifier
~ source python-flask-heroku-ps5-notifier/bin/activate
(python-flask-heroku-ps5-notifier) ~ python setup.py develop
  1. Run Tests

(python-flask-heroku-ps5-notifier) ~ pytest

  1. Run Application for Development

(python-flask-heroku-ps5-notifier) ~ python app.py runserver

PyCharm

Dependency management and interactive debugging are available using PyCharm.

The Configure a virtual environment can help with questions on how to do this.

Components

Flask

MongoDb

Logging

logs directory - Rotating 10mb

Swagger

http://localhost:5000/swagger

Scripts