add-scripts-folder

Author: aminalaee

.github/workflows/tests.yaml

@@ -1,6 +1,10 @@
-name: Python package
+name: Test Suite
 
-on: [push]
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
 
 jobs:
     linters:
@@ -20,10 +24,8 @@ jobs:
                   python -m pip install --upgrade pip
                   pip install -r requirements.txt
                   pip install -r tests/test-requirements.txt
-            - name: Mypy
-              run: mypy piccolo tests
-            - name: Flake8
-              run: flake8 piccolo tests
+            - name: Lint
+              run: ./scripts/lint.sh
 
     postgres:
         runs-on: ubuntu-latest
@@ -70,7 +72,7 @@ jobs:
                   psql -h localhost -c "CREATE EXTENSION IF NOT EXISTS \"uuid-ossp\";" -d piccolo -U postgres
 
             - name: Test with pytest, Postgres
-              run: cd tests && ./test-postgres.sh
+              run: ./scripts/test-postgres.sh
               env:
                   PG_HOST: localhost
                   PG_DATABASE: piccolo
@@ -94,4 +96,4 @@ jobs:
                   pip install -r requirements.txt
                   pip install -r tests/test-requirements.txt
             - name: Test with pytest, SQLite
-              run: cd tests && ./test-sqlite.sh
+              run: ./scripts/test-sqlite.sh

scripts/README.md

@@ -0,0 +1,9 @@
+# Development Scripts
+
+The scripts follow GitHub's ["Scripts to Rule Them All"](https://github.com/github/scripts-to-rule-them-all).
+
+* `scripts/coverage-report.sh` - Generate coverage report.
+* `scripts/lint.sh` - Run the automated code linting/formatting tools.
+* `scripts/release.sh` - Publish package to PYPI.
+* `scripts/test-postgres.sh` - Run the test suite with Postgres.
+* `scripts/test-sqlite.sh` - Run the test suite with Sqlite.

tests/coverage-report.sh scripts/coverage-report.shtests/coverage-report.sh renamed to scripts/coverage-report.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+mypy piccolo tests
+flake8 piccolo tests

scripts/lint.sh

@@ -4,7 +4,5 @@
 # To run all in a class tests/test_foo.py::TestFoo
 # To run a single test tests/test_foo.py::TestFoo::test_foo
 
-cd ..
-
 export PICCOLO_CONF="tests.postgres_conf"
 python -m pytest --cov=piccolo -s $@

release.sh scripts/release.shrelease.sh renamed to scripts/release.sh

@@ -4,7 +4,5 @@
 # To run all in a class tests/test_foo.py::TestFoo
 # To run a single test tests/test_foo.py::TestFoo::test_foo
 
-cd ..
-
 export PICCOLO_CONF="tests.sqlite_conf"
 python -m pytest --cov=piccolo -s $@