Merge pull request #246 from joe733/workshop

maint: moving docs from `.rst` to `.md`

Author: yozachar

.github/workflows/main.yml

@@ -2,10 +2,10 @@ name: PyCodeQualityAnalysis
 
 on:
   workflow_dispatch:
-  pull_request:
-    branches: [master]
   push:
     branches: [master]
+  pull_request:
+    branches: [master]
 
 jobs:
   DevOps:
@@ -20,7 +20,7 @@ jobs:
       #----------------------------------------------
       - name: Checkout repository
         uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Setup Python v${{ matrix.python-version }}
         # id: setup-python
         uses: actions/setup-python@v4
         with:
@@ -46,13 +46,13 @@ jobs:
       #----------------------------------------------
       # install dependencies if cache does not exist
       #----------------------------------------------
-      - name: Install dependencies
+      - name: Install test dependencies
         # if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
         run: poetry install --no-interaction --no-root --no-ansi --only tests
       #----------------------------------------------
       #              run test suite
       #----------------------------------------------
-      - name: Test
+      - name: Run tests
         run: |
           source .venv/bin/activate
           pytest tests/

.github/workflows/pages.yml

@@ -0,0 +1,49 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Documentation
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.3.2
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+      - name: Install docs dependencies
+        run: poetry install --no-interaction --no-root --no-ansi --only docs
+      - name: Build documentation
+        run: |
+          source .venv/bin/activate
+          mkdocs build
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: "./site/"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -136,7 +136,7 @@ venv.bak/
 .ropeproject
 
 # mkdocs documentation
-/site
+site/
 
 # mypy
 .mypy_cache/

README.md

@@ -1,13 +1,13 @@
 # validators - Python Data Validation for Humans™
 
-[![Build Status][bs-badge]][bs-link] [![Version Status][vs-badge]][vs-link] [![Downloads][dw-badge]][dw-link]
+[![Tests][tests-badge]][tests-link] [![Bandit][bandit-badge]][bandit-link] [![Version Status][vs-badge]][vs-link] [![Downloads][dw-badge]][dw-link]
 
 Python has all kinds of data validation tools, but every one of them seems to
 require defining a schema or form. I wanted to create a simple validation
 library where validating a simple value does not require defining a form or a
 schema.
 
-```py
+```python
 >>> import validators
 
 >>> validators.email('[email protected]')
@@ -16,12 +16,17 @@ True
 
 ## Resources
 
-- [Documentation](https://validators.readthedocs.io/)
-- [Issue Tracker](http://github.com/kvesteri/validators/issues)
-- [Code](http://github.com/kvesteri/validators/)
+- [Documentation](https://python-validators.github.io/)
+- [Issue Tracker](https://github.com/python-validators/validators/issues)
+- [Security](https://github.com/python-validators/validators/blob/master/SECURITY.md)
+- [Code](https://github.com/python-validators/validators/)
 
-[bs-badge]: https://github.com/python-validators/validators/actions/workflows/main.yml/badge.svg
-[bs-link]: https://github.com/python-validators/validators/actions/workflows/main.yml
+[//]: #(Links)
+
+[bandit-badge]: https://github.com/python-validators/validators/actions/workflows/bandit.yml/badge.svg
+[bandit-link]: https://github.com/python-validators/validators/actions/workflows/bandit.yml
+[tests-badge]: https://github.com/python-validators/validators/actions/workflows/main.yml/badge.svg
+[tests-link]: https://github.com/python-validators/validators/actions/workflows/main.yml
 [vs-badge]: https://img.shields.io/pypi/v/validators.svg
 [vs-link]: https://pypi.python.org/pypi/validators/
 [dw-badge]: https://img.shields.io/pypi/dm/validators.svg