refactor app: add README + .gitignore

Author: mzabalza

.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+
+env/
+
+.env
+.vscode
+__pycache__/
+*.pyc
+
+*.csv
+*.xlsx
+*.pickle

README.md

@@ -0,0 +1,74 @@
+<h1 align="center">
+	Flask blog
+</h1>
+
+<p align="center">
+	<b><i>Development repo for blog project</i></b><br>
+	Code devoleped following tutorial from Corey Schafer
+    <a href="https://www.youtube.com/watch?v=MwZwr5Tvyxo&list=PL-osiE80TeTs4UjLw5MM6OjgkjFeUxCYH"><b>Full-Featured Web App</b></a>.
+</p>
+
+<p align="center">
+	<img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/api-mzabalza/flaskblog?color=blueviolet" />
+	<img alt="Number of lines of code" src="https://img.shields.io/tokei/lines/github/api-mzabalza/flaskblog?color=blueviolet" />
+	<img alt="Code language count" src="https://img.shields.io/github/languages/count/api-mzabalza/flaskblog?color=blue" />
+	<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/api-mzabalza/flaskblog?color=blue" />
+	<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/api-mzabalza/flaskblog?color=brightgreen" />
+</p>
+
+<p align="center"><img  src="readme/pic1.png"></p>
+
+
+<h3 align="center">
+	<a href="#%EF%B8%8F-about">About</a>
+	<span> · </span>
+	<a href="#%EF%B8%8F-usage">Usage</a>
+	<span> · </span>
+	<a href="#-testing">Testing</a>
+	<span> · </span>
+	<a href="#-useful-links">Useful Links</a>
+</h3>
+
+---
+
+## 🗣️ About
+> _In this Python Flask Tutorial, we will be learning how to structure a web app using python Flask framework as backend api._
+
+
+## 🛠️ Usage
+
+### Requirements
+
+The program is written in python language. Find all requirements in requirements.txt file at the root folder.
+
+### Instructions
+
+**2. Setup environment**
+* (optinal) create a virtual environment before installing all required dependencies:
+```shell
+virtualenv env
+source env/bin/activate
+```
+
+* Install dependecies
+```shell
+pip install -r requirements.txt
+```
+
+**2. Executing the program**
+
+To execute the program, run:
+
+```shell
+python app.py
+```
+
+## 📋 Testing
+
+(to be written)
+
+## 📌 Useful Links
+
+* [Original source code of the series](https://github.com/CoreyMSchafer/code_snippets/tree/master/Python/Flask_Blog)
+* [Youtube tutorial for the project](https://www.youtube.com/watch?v=MwZwr5Tvyxo&list=PL-osiE80TeTs4UjLw5MM6OjgkjFeUxCYH)
+* [harm-smits' 42 Docs - minishell](https://harm-smits.github.io/42docs/projects/minishell)

flaskBlog.py renamed to app.py

@@ -1,12 +1,18 @@
 # This file must be used with "source bin/activate" *from bash*
 # you cannot run it directly
 
+
+if [ "${BASH_SOURCE-}" = "$0" ]; then
+    echo "You must source this script: \$ source $0" >&2
+    exit 33
+fi
+
 deactivate () {
-    unset -f pydoc >/dev/null 2>&1
+    unset -f pydoc >/dev/null 2>&1 || true
 
     # reset old environment variables
     # ! [ -z ${VAR+_} ] returns true if VAR is declared at all
-    if ! [ -z "${_OLD_VIRTUAL_PATH+_}" ] ; then
+    if ! [ -z "${_OLD_VIRTUAL_PATH:+_}" ] ; then
         PATH="$_OLD_VIRTUAL_PATH"
         export PATH
         unset _OLD_VIRTUAL_PATH
@@ -40,7 +46,10 @@ deactivate () {
 # unset irrelevant variables
 deactivate nondestructive
 
-VIRTUAL_ENV="/Users/mzabalza/cs_zab/web/python/flask/coreySchafer/flask-blog/env"
+VIRTUAL_ENV='/Users/mzabalza/mzabalza/flask/flaskblog/env'
+if ([ "$OSTYPE" = "cygwin" ] || [ "$OSTYPE" = "msys" ]) && $(command -v cygpath &> /dev/null) ; then
+    VIRTUAL_ENV=$(cygpath -u "$VIRTUAL_ENV")
+fi
 export VIRTUAL_ENV
 
 _OLD_VIRTUAL_PATH="$PATH"
@@ -54,17 +63,17 @@ if ! [ -z "${PYTHONHOME+_}" ] ; then
 fi
 
 if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT-}" ] ; then
-    _OLD_VIRTUAL_PS1="$PS1"
+    _OLD_VIRTUAL_PS1="${PS1-}"
     if [ "x" != x ] ; then
-        PS1="$PS1"
+        PS1="${PS1-}"
     else
-        PS1="(`basename \"$VIRTUAL_ENV\"`) $PS1"
+        PS1="(`basename \"$VIRTUAL_ENV\"`) ${PS1-}"
     fi
     export PS1
 fi
 
 # Make sure to unalias pydoc if it's already there
-alias pydoc 2>/dev/null >/dev/null && unalias pydoc
+alias pydoc 2>/dev/null >/dev/null && unalias pydoc || true
 
 pydoc () {
     python -m pydoc "$@"

env/.Python

@@ -10,32 +10,45 @@ alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PA
 # Unset irrelevant variables.
 deactivate nondestructive
 
-setenv VIRTUAL_ENV "/Users/mzabalza/cs_zab/web/python/flask/coreySchafer/flask-blog/env"
+setenv VIRTUAL_ENV '/Users/mzabalza/mzabalza/flask/flaskblog/env'
 
 set _OLD_VIRTUAL_PATH="$PATH:q"
 setenv PATH "$VIRTUAL_ENV:q/bin:$PATH:q"
 
 
 
-if ("" != "") then
-    set env_name = ""
+if ('' != "") then
+    set env_name = ''
 else
-    set env_name = "$VIRTUAL_ENV:t:q"
+    set env_name = '('"$VIRTUAL_ENV:t:q"') '
 endif
 
-# Could be in a non-interactive environment,
-# in which case, $prompt is undefined and we wouldn't
-# care about the prompt anyway.
-if ( $?prompt ) then
-    set _OLD_VIRTUAL_PROMPT="$prompt:q"
-if ( "$prompt:q" =~ *"$newline:q"* ) then
-    :
+if ( $?VIRTUAL_ENV_DISABLE_PROMPT ) then
+    if ( $VIRTUAL_ENV_DISABLE_PROMPT == "" ) then
+        set do_prompt = "1"
+    else
+        set do_prompt = "0"
+    endif
 else
-    set prompt = "[$env_name:q] $prompt:q"
+    set do_prompt = "1"
 endif
+
+if ( $do_prompt == "1" ) then
+    # Could be in a non-interactive environment,
+    # in which case, $prompt is undefined and we wouldn't
+    # care about the prompt anyway.
+    if ( $?prompt ) then
+        set _OLD_VIRTUAL_PROMPT="$prompt:q"
+        if ( "$prompt:q" =~ *"$newline:q"* ) then
+            :
+        else
+            set prompt = "$env_name:q$prompt:q"
+        endif
+    endif
 endif
 
 unset env_name
+unset do_prompt
 
 alias pydoc python -m pydoc
 

env/bin/activate

@@ -1,19 +1,38 @@
 # This file must be used using `source bin/activate.fish` *within a running fish ( http://fishshell.com ) session*.
 # Do not run it directly.
 
+function _bashify_path -d "Converts a fish path to something bash can recognize"
+    set fishy_path $argv
+    set bashy_path $fishy_path[1]
+    for path_part in $fishy_path[2..-1]
+        set bashy_path "$bashy_path:$path_part"
+    end
+    echo $bashy_path
+end
+
+function _fishify_path -d "Converts a bash path to something fish can recognize"
+    echo $argv | tr ':' '\n'
+end
+
 function deactivate -d 'Exit virtualenv mode and return to the normal environment.'
     # reset old environment variables
     if test -n "$_OLD_VIRTUAL_PATH"
-        set -gx PATH $_OLD_VIRTUAL_PATH
+        # https://github.com/fish-shell/fish-shell/issues/436 altered PATH handling
+        if test (echo $FISH_VERSION | head -c 1) -lt 3
+            set -gx PATH (_fishify_path "$_OLD_VIRTUAL_PATH")
+        else
+            set -gx PATH "$_OLD_VIRTUAL_PATH"
+        end
         set -e _OLD_VIRTUAL_PATH
     end
 
     if test -n "$_OLD_VIRTUAL_PYTHONHOME"
-        set -gx PYTHONHOME $_OLD_VIRTUAL_PYTHONHOME
+        set -gx PYTHONHOME "$_OLD_VIRTUAL_PYTHONHOME"
         set -e _OLD_VIRTUAL_PYTHONHOME
     end
 
     if test -n "$_OLD_FISH_PROMPT_OVERRIDE"
+       and functions -q _old_fish_prompt
         # Set an empty local `$fish_function_path` to allow the removal of `fish_prompt` using `functions -e`.
         set -l fish_function_path
 
@@ -30,16 +49,23 @@ function deactivate -d 'Exit virtualenv mode and return to the normal environmen
         # Self-destruct!
         functions -e pydoc
         functions -e deactivate
+        functions -e _bashify_path
+        functions -e _fishify_path
     end
 end
 
 # Unset irrelevant variables.
 deactivate nondestructive
 
-set -gx VIRTUAL_ENV "/Users/mzabalza/cs_zab/web/python/flask/coreySchafer/flask-blog/env"
+set -gx VIRTUAL_ENV '/Users/mzabalza/mzabalza/flask/flaskblog/env'
 
-set -gx _OLD_VIRTUAL_PATH $PATH
-set -gx PATH "$VIRTUAL_ENV/bin" $PATH
+# https://github.com/fish-shell/fish-shell/issues/436 altered PATH handling
+if test (echo $FISH_VERSION | head -c 1) -lt 3
+   set -gx _OLD_VIRTUAL_PATH (_bashify_path $PATH)
+else
+    set -gx _OLD_VIRTUAL_PATH "$PATH"
+end
+set -gx PATH "$VIRTUAL_ENV"'/bin' $PATH
 
 # Unset `$PYTHONHOME` if set.
 if set -q PYTHONHOME
@@ -56,20 +82,18 @@ if test -z "$VIRTUAL_ENV_DISABLE_PROMPT"
     functions -c fish_prompt _old_fish_prompt
 
     function fish_prompt
-        # Save the current $status, for fish_prompts that display it.
-        set -l old_status $status
+        # Run the user's prompt first; it might depend on (pipe)status.
+        set -l prompt (_old_fish_prompt)
 
         # Prompt override provided?
         # If not, just prepend the environment name.
-        if test -n ""
-            printf '%s%s' "" (set_color normal)
+        if test -n ''
+            printf '%s%s' '' (set_color normal)
         else
             printf '%s(%s) ' (set_color normal) (basename "$VIRTUAL_ENV")
         end
 
-        # Restore the original $status
-        echo "exit $old_status" | source
-        _old_fish_prompt
+        string join -- \n $prompt # handle multi-line prompts
     end
 
     set -gx _OLD_FISH_PROMPT_OVERRIDE "$VIRTUAL_ENV"