Scripts

Makefile

@@ -42,16 +42,8 @@ format:
 	black .
 
 docs:
-	bash -c "cd ./docs; make html"
-	open ./docs/build/html/index.html
+	@bash -c "./scripts/build_docs.sh"
 
 clean:
-	python3 -c "import pathlib; [p.unlink() for p in pathlib.Path('.').rglob('*.py[co]')]"
-	python3 -c "import pathlib; [p.rmdir() for p in pathlib.Path('.').rglob('pytest_cache')]"
-	rm -rdf ./docs/build
-	rm -rdf ./dist
-	rm -rdf ./build
-	rm -rdf ./htmlcov
-	rm -rdf  pyairtable.egg-info
-	rm -rdf  .pytest_cache
+	@bash -c "./scripts/clean.sh"
 

pyairtable/utils.py

@@ -54,8 +54,6 @@ def attachment(url: str, filename="") -> dict:
     Airtable will download the file at the given url and keep its own copy of it.
     All other attachment object properties will be generated server-side soon afterward.
 
-    ..note ::
-        test
     Note:
         Attachment field values muest be **an array of objects**.
 

scripts/build_docs.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+sourceDir="docs/source"
+buildDir="docs/build"
+
+source ./scripts/console.sh
+
+info 'Building Docs 📚'
+
+python -m sphinx -a -W -E "$sourceDir" "$buildDir"

scripts/bump.sh

@@ -1,12 +1,15 @@
 #!/bin/bash
 
+source ./scripts/console.sh
+
+
 function bump {
     previousVersion=$( grep '^__version__' pyairtable/__init__.py | sed 's/__version__ = \"\(.*\)\"/\1/' )
     previousVersion=$(echo -n "${previousVersion}")
-    echo "Enter Version [current is ${previousVersion}]:"
+    info "Enter Version [current is ${previousVersion}]:"
     read version
     if [ -z "$version" ]; then
-        echo "Empty version string - using existing"
+        info "Empty version string - using existing"
         version="$previousVersion"
         return
     fi
@@ -15,8 +18,8 @@ function bump {
 }
 
 function confirmEval {
-    echo "CMD > $1"
-    echo "ENTER to confirm"
+    info "CMD > $1"
+    info "ENTER to confirm"
     read foo
     eval $1
 }

scripts/clean.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+source ./scripts/console.sh
+
+info "Cleanning up files 🧹"
+
+python3 -c "import pathlib; [p.unlink() for p in pathlib.Path('.').rglob('*.py[co]')]"
+python3 -c "import pathlib; [p.rmdir() for p in pathlib.Path('.').rglob('pytest_cache')]"
+rm -rdf ./docs/build
+rm -rdf ./dist
+rm -rdf ./build
+rm -rdf ./htmlcov
+rm -rdf  pyairtable.egg-info
+rm -rdf  .pytest_cache

scripts/console.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+RED='\033[1;31m'
+L_GREEN='\033[1;32m'
+L_BLUE='\033[1;34m'
+L_GREY='\033[0;37m'
+WHITE='\033[1;37m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+console() {
+  local color=$1
+  local msg=$2
+  printf "${!color}${msg}${NC}\n"
+}
+
+error() {
+  local msg=$1
+  console 'RED' "==> $msg"
+}
+
+info() {
+  local msg=$1
+  console 'L_GREEN' "==> ${msg}"
+}
+warn() {
+  local msg=$1
+  console 'L_BLUE' "==> ${msg}"
+}

scripts/format.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -e
+
+source ./scripts/console.sh
+
+info 'Formatting'
+
+flake8 .
+black --diff .

scripts/githooks/pre-commit

@@ -1,16 +1,20 @@
 #!/bin/bash
 
-echo "> Checking for breakpoints"
+source ./scripts/console.sh
+
+info 'Pre-Commit Hook'
+
+info "Checking for breakpoints"
 
 breakpoint=$(git grep breakpoint -- '*.py')
 if [ -n "$breakpoint" ]
 then
-    echo "COMMIT REJECTED: Please remove breakpoint before commiting."
-    echo $breakpoint
+    error "COMMIT REJECTED: Please remove breakpoint before commiting."
+    error $breakpoint
     exit 1
 fi
 
 set -e
 
-echo "> Linting"
 make lint
+make docs