From 6a8f727faf17985d62341cc0a8b80f5653465705 Mon Sep 17 00:00:00 2001 From: Jakub Miazek Date: Mon, 21 Aug 2023 10:45:45 +0200 Subject: [PATCH] links --- README.md | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8bd78dc..0ed33bd 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,22 @@
  • Getting Started
  • -
  • Usage
  • -
  • Roadmap
  • -
  • Contributing
  • -
  • License
  • -
  • Contact
  • + +[//]: # (
  • Usage
  • ) + +[//]: # (
  • Roadmap
  • ) + +[//]: # (
  • Contributing
  • ) + +[//]: # (
  • License
  • ) + +[//]: # (
  • Contact
  • )
  • Acknowledgments
  • @@ -63,7 +70,9 @@ as the fifth official annual Python Developers Survey, conducted as a collaborat

    (back to top)

    -### How to Setup +## Getting Started + +### Make will help you To build , run and test and more ... use magic of make help to play with this project. ```shell make help @@ -86,6 +95,7 @@ test Run project tests up Run project with compose ``` +

    (back to top)

    ### How to feed database @@ -95,6 +105,8 @@ Data set is coming form https://github.com/catherinedevlin/opensourceshakespeare Next models were generated with https://github.com/agronholm/sqlacodegen And after some tweaking I got desired result +

    (back to top)

    + ### Rainbow logs with rich :rainbow: To deliver better user(developer) experience when watching logs with tons of information @@ -116,9 +128,12 @@ Below steps were done to integrate [rich](https://github.com/Textualize/rich) in ![sample-logs-with-rich](/static/logz.png) -### User authentication with JWT and Redis as token storage :lock: :key: +

    (back to top)

    -#### Generate Fernet key for storing password in db +### Setup User Auth :lock: :key: + +Setup user authentication with JWT and Redis as token storage +Generate Fernet key for storing password in db ```python In [1]: from cryptography.fernet import Fernet @@ -129,7 +144,7 @@ Out[2]: b'Ms1HSn513x0_4WWFBQ3hYPDGAHpKH_pIseC5WwqyO7M=' Save the key in .secrets as FERNET_KEY -## Local development with poetry +### Local development with poetry ```shell pyenv install 3.11 && pyenv local 3.11