Giter VIP home page Giter VIP logo

flask-tutorial's Introduction

Flaskr

This a repo that use originally Flask tutorial with example code from Flask-SQLAlchemy project, adding Flask Migrate to use migrations, PostgreSQL as database. Can use a virtualenv or a container environment with Docker an Docker-Composer.

Features -------

This project has additional features that apply in my learned:

  • Profile page with profile description
  • An option to change top banner color.
  • A cookie based of logged user to identify what's the color banner must to show.
  • Auto-instrumentation by OpenTelemetry

The original tutorial is here.

Install

You can follow original tutorial and create a virtualenv, but this version use containers to development and test. Before to use this repo, install Docker and Docker-Compose

# clone the repository
$ git clone https://github.com/fike/flask-tutorial

Run

For every change of model, run make migrate before to start this project to update Alembic migrations.

$ make up-db
$ make migrate

To start just use `make up`:

$ make up

Instrumentation

To start see how instrumentation is working here, it changes OTELE_TRACE value to "False" in the Docker Compose file:

deployments/docker-compose.yaml

[...]

OTELE_TRACE=False

[...]

And the terminal run:

$ make up-all

Open http://127.0.0.1:5000 in a browser to access application, go yo http://localhost:16686/ to access Jaeger UI.

Test

To run pytest and to know what's the test coverage runs:

$ make test

The coverage test report will generate in htmlcov directory

TODO

  • Add remote container development
  • Add Helm chart installation
  • Add track based user id
  • Add char limit for title post

flask-tutorial's People

Contributors

fike avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

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.