use pyproject project code skeleton

.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
       # Label used to access the service container
       postgres:
         # Docker Hub image
-        image: postgres:10.6-alpine # docker run --rm --name test-psql-db -p 43347:5432 -e POSTGRES_PASSWORD=password -d postgres:10.6-alpine
+        image: postgres:15.7-alpine # docker run --rm --name test-psql-db -p 43347:5432 -e POSTGRES_PASSWORD=password -d postgres:10.6-alpine
         # Provide the password for postgres
         env:
           POSTGRES_PASSWORD: password
@@ -33,12 +33,12 @@ jobs:
           # Maps tcp port 5432 on service container to the host 43347
           - 40311:5432
     env: # define environment variables
-      USING_COVERAGE: "3.7,3.8,3.9,3.10"
+      USING_COVERAGE: "3.8,3.9,3.10,3.11"
     strategy:
       matrix:
         os: ["ubuntu-latest"]
 #        os: ["ubuntu-latest"] # for temp testing only
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 #        python-version: ["3.6"] # for temp testing only
     steps:
       - uses: "actions/checkout@v2" # https://github.com/marketplace/actions/checkout
@@ -68,12 +68,12 @@ jobs:
     name: "${{ matrix.os }} Python ${{ matrix.python-version }}"
     runs-on: "${{ matrix.os }}" # for all available VM runtime, see this: https://docs.github.com/en/free-pro-team@latest/actions/reference/specifications-for-github-hosted-runners
     env: # define environment variables
-      USING_COVERAGE: "3.6,3.7,3.8,3.9"
+      USING_COVERAGE: "3.8,3.9,3.10,3.11"
     strategy:
       matrix:
         os: ["windows-latest"]
 #        os: ["ubuntu-latest"] # for temp testing only
-        python-version: ["3.6", "3.7", "3.8", "3.9"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 #        python-version: ["3.6"] # for temp testing only
         exclude:
           - os: windows-latest # this is a useless exclude rules for demonstration use only
@@ -99,4 +99,6 @@ jobs:
         if: "contains(env.USING_COVERAGE, matrix.python-version)"
         uses: "codecov/codecov-action@v3" # https://github.com/marketplace/actions/codecov-action
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: MacHu-GWU/sqlalchemy_mate-project
           fail_ci_if_error: true

.gitignore

@@ -2,6 +2,7 @@
 sqlalchemy_mate_venv/
 sqlalchemy_mate.egg-info/
 sqlalchemy_mate-*/
+tmp/
 .db.json
 
 
@@ -71,7 +72,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs/build/
 
 # PyBuilder
 target/
@@ -147,4 +148,4 @@ $RECYCLE.BIN/
 *.msp
 
 # Windows shortcuts
-*.lnk
+*.lnk

.readthedocs.yml

@@ -0,0 +1,18 @@
+# Ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+  - method: pip
+    path: .
+  - requirements: requirements.txt
+  - requirements: requirements-doc.txt
+  - requirements: requirements-furo-sphinx-search.txt

AUTHORS.rst

@@ -2,13 +2,14 @@
 
 About the Author
 ------------------------------------------------------------------------------
-
 ::
 
    (\ (\
-   ( -.-)o    I am a lovely Rabbit!
+   ( -.-)o
    o_(")(")
 
-**Sanhe Hu** is a very active **Python Developer** Since 2010. Research area includes **Machine Learning, Big Data Infrastructure, Block Chain, Business Intelligent, AWS, Distributive System**. Love photography, outdoor, arts, game, and also the best `Python <https://www.python.org/>`_.
+**Sanhe Hu** is a seasoned software engineer with a deep passion for Python development since 2010. As an author and maintainer of 20+ open-source projects, I bring a wealth of experience to the table. As a Senior Solution Architect and Subject Matter Expert in Amazon Web Services, Cloud Engineering, DevOps, Big Data, and Machine Learning, I thrive on helping clients with platform design, enterprise architecture, and strategic roadmaps.
+
+Talk is cheap, show me the code:
 
 - My Github: https://github.com/MacHu-GWU

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright 2018 Sanhe Hu <https://github.com/MacHu-GWU/sqlalchemy_mate-project>
+Copyright 2023 Sanhe Hu <https://github.com/MacHu-GWU/sqlalchemy_mate-project>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

MANIFEST.in

@@ -3,8 +3,9 @@
 #
 # For more info: https://docs.python.org/2/distutils/sourcedist.html#manifest-related-options
 
+recursive-include sqlalchemy_mate
 include *.txt
 include *.rst
-recursive-include sqlalchemy_mate *.*
-recursive-exclude *.pyc
-recursive-exclude *.pyo
+exclude *.pyc
+exclude *.pyo
+exclude sqlalchemy_mate/tests/**