fix: packaging as well as rST & md document generation

- updates gh-action versions - moves `docs/references` to `docs/api` - ignores all `.md` files for Sphinx build - includes `rST` docs in source control and `sdist` - fixes all Sphinx doc generation warnings/errors - removes `pyaml` & `twine` from dev dependencies
python-validators · Mar 20, 2024 · 3a2c513 · 3a2c513
1 parent 245bffd
commit 3a2c513
Show file tree

Hide file tree

Showing 71 changed files with 449 additions and 669 deletions.
diff --git a/.github/workflows/docs.yaml.bkp b/.github/workflows/docs.yaml.bkp
@@ -15,10 +15,10 @@ jobs:
     steps:
       # checkout repository
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # set up specific python version
       - name: Set up Python v3.12
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.12"
       # building
@@ -30,10 +30,10 @@ jobs:
         run: python package/export docs
       # set up Pages
       - name: Set up Pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v4
       # upload static page
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ${{ env.BUILD_PATH }}/site
   deploy:
@@ -50,4 +50,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4
diff --git a/.github/workflows/package.yaml → .github/workflows/package.yaml.bkp b/.github/workflows/package.yaml → .github/workflows/package.yaml.bkp
@@ -16,10 +16,10 @@ jobs:
     steps:
       # checkout repository
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # set up specific python version
       - name: Set up Python v3.8
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.8"
       # install dependencies
@@ -38,7 +38,7 @@ jobs:
           deactivate
       # upload package as artifact
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ${{ env.BUILD_PATH }}/dist
   publish:

diff --git a/.github/workflows/pycqa.yaml b/.github/workflows/pycqa.yaml
@@ -14,10 +14,10 @@ jobs:
     steps:
       # checkout repository
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # set up specific python version
       - name: Set up Python v3.8
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.8"
       # tooling
@@ -41,10 +41,10 @@ jobs:
       # checkout repository again!
       # ref: https://github.com/actions/checkout/issues/19
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # set up specific python version
       - name: Set up Python v${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"

diff --git a/.github/workflows/sast.yaml b/.github/workflows/sast.yaml
@@ -16,7 +16,7 @@ jobs:
       actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Bandit
         uses: mdegis/bandit-action@85fcc340c3b0bf5d86029abb49b9aac916d807b2
         with:

diff --git a/.gitignore b/.gitignore
@@ -69,11 +69,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-# docs/references/
 docs/_build/
-# temporary
-docs/references/*.rst
-docs/*.rst
 docs/*.1
 
 # PyBuilder

diff --git a/CHANGES.md b/CHANGES.md
@@ -9,9 +9,26 @@ Note to self: Breaking changes must increment either
 
 -->
 
+## 0.23.2 (2024-03-20)
+
+_**Breaking**_
+
+> No breaking changes were introduced in this version.
+
+_**Features**_
+
+> No features were introduced in this version.
+
+_**Maintenance**_
+
+- maint: rectifies changelog by @yozachar in [#336](ttps://github.com/python-validators/validators/pull/336)
+- fix: packaging as well as `rST` & `md` document generation by @yozachar in [#337](ttps://github.com/python-validators/validators/pull/337)
+
+**Full Changelog**: [`0.23.1...0.23.2`](https://github.com/python-validators/validators/compare/0.23.1...0.23.2)
+
 ## 0.23.1 (2024-03-19)
 
-_**Breaking**_ ⚠️
+_**Breaking**_
 
 > No breaking changes were introduced in this version.
 
@@ -28,7 +45,7 @@ _**Maintenance**_
 
 ## 0.23.0 (2024-03-19)
 
-_**Breaking**_ ⚠️
+_**Breaking**_
 
 > No breaking changes were introduced in this version.
 
@@ -101,7 +118,7 @@ _**Maintenance**_
 
 ## 0.21.1 (2023-04-10)
 
-_**Breaking**_ ⚠️
+_**Breaking**_
 
 > No breaking changes were introduced in this version.
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,21 +1,31 @@
 # MANIFEST.in stays as long as pyproject.toml does not officially support it
 # https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
 
-include docs/*
-include .gitignore
+# include
+include CHANGES.md
+include mkdocs.yaml
+
 
 # global-include
 
+
+# recursive-include
 recursive-include tests *
+recursive-include docs *
+
 
 # graft
 
+
 # exclude
 
+
 # global-exclude
 
-recursive-exclude docs *.rst
-recursive-exclude docs/references *.md
 
+# recursive-exclude
+
+
+# prune
 prune docs/_build
 prune **/__pycache__
diff --git a/SECURITY.md b/SECURITY.md
@@ -4,7 +4,7 @@
 
 | Version    | Supported          |
 | ---------- | ------------------ |
-| `>=0.23.0` | :white_check_mark: |
+| `>=0.23.2` | :white_check_mark: |
 
 ## Reporting a Vulnerability
 

diff --git a/docs/references/between.md → docs/api/between.md b/docs/references/between.md → docs/api/between.md
diff --git a/docs/api/between.rst b/docs/api/between.rst
@@ -0,0 +1,5 @@
+between
+-------
+
+.. module:: validators.between
+.. autofunction:: between
diff --git a/docs/references/btc_address.md → docs/api/btc_address.md b/docs/references/btc_address.md → docs/api/btc_address.md
diff --git a/docs/api/btc_address.rst b/docs/api/btc_address.rst
@@ -0,0 +1,5 @@
+btc_address
+-----------
+
+.. module:: validators.btc_address
+.. autofunction:: btc_address
diff --git a/docs/references/card.md → docs/api/card.md b/docs/references/card.md → docs/api/card.md
diff --git a/docs/api/card.rst b/docs/api/card.rst
@@ -0,0 +1,12 @@
+card
+----
+
+.. module:: validators.card
+.. autofunction:: amex
+.. autofunction:: card_number
+.. autofunction:: diners
+.. autofunction:: discover
+.. autofunction:: jcb
+.. autofunction:: mastercard
+.. autofunction:: unionpay
+.. autofunction:: visa
diff --git a/docs/references/country_code.md → docs/api/country_code.md b/docs/references/country_code.md → docs/api/country_code.md
diff --git a/docs/api/country_code.rst b/docs/api/country_code.rst
@@ -0,0 +1,5 @@
+country_code
+------------
+
+.. module:: validators.country_code
+.. autofunction:: country_code
diff --git a/docs/references/domain.md → docs/api/domain.md b/docs/references/domain.md → docs/api/domain.md
diff --git a/docs/api/domain.rst b/docs/api/domain.rst
@@ -0,0 +1,5 @@
+domain
+------
+
+.. module:: validators.domain
+.. autofunction:: domain
diff --git a/docs/references/email.md → docs/api/email.md b/docs/references/email.md → docs/api/email.md
diff --git a/docs/api/email.rst b/docs/api/email.rst
@@ -0,0 +1,5 @@
+email
+-----
+
+.. module:: validators.email
+.. autofunction:: email
diff --git a/docs/references/hashes.md → docs/api/hashes.md b/docs/references/hashes.md → docs/api/hashes.md
diff --git a/docs/api/hashes.rst b/docs/api/hashes.rst
@@ -0,0 +1,9 @@
+hashes
+------
+
+.. module:: validators.hashes
+.. autofunction:: md5
+.. autofunction:: sha1
+.. autofunction:: sha224
+.. autofunction:: sha256
+.. autofunction:: sha512
diff --git a/docs/references/hostname.md → docs/api/hostname.md b/docs/references/hostname.md → docs/api/hostname.md
diff --git a/docs/api/hostname.rst b/docs/api/hostname.rst
@@ -0,0 +1,5 @@
+hostname
+--------
+
+.. module:: validators.hostname
+.. autofunction:: hostname
diff --git a/docs/references/i18n.md → docs/api/i18n.md b/docs/references/i18n.md → docs/api/i18n.md
diff --git a/docs/api/i18n.rst b/docs/api/i18n.rst
@@ -0,0 +1,12 @@
+i18n
+----
+
+.. module:: validators.i18n
+.. autofunction:: es_cif
+.. autofunction:: es_doi
+.. autofunction:: es_nie
+.. autofunction:: es_nif
+.. autofunction:: fi_business_id
+.. autofunction:: fi_ssn
+.. autofunction:: fr_department
+.. autofunction:: fr_ssn
diff --git a/docs/references/iban.md → docs/api/iban.md b/docs/references/iban.md → docs/api/iban.md
diff --git a/docs/api/iban.rst b/docs/api/iban.rst
@@ -0,0 +1,5 @@
+iban
+----
+
+.. module:: validators.iban
+.. autofunction:: iban
diff --git a/docs/references/ip_address.md → docs/api/ip_address.md b/docs/references/ip_address.md → docs/api/ip_address.md
diff --git a/docs/api/ip_address.rst b/docs/api/ip_address.rst
@@ -0,0 +1,6 @@
+ip_address
+----------
+
+.. module:: validators.ip_address
+.. autofunction:: ipv4
+.. autofunction:: ipv6
diff --git a/docs/references/length.md → docs/api/length.md b/docs/references/length.md → docs/api/length.md
diff --git a/docs/api/length.rst b/docs/api/length.rst
@@ -0,0 +1,5 @@
+length
+------
+
+.. module:: validators.length
+.. autofunction:: length
diff --git a/docs/references/mac_address.md → docs/api/mac_address.md b/docs/references/mac_address.md → docs/api/mac_address.md
diff --git a/docs/api/mac_address.rst b/docs/api/mac_address.rst
@@ -0,0 +1,5 @@
+mac_address
+-----------
+
+.. module:: validators.mac_address
+.. autofunction:: mac_address
diff --git a/docs/references/slug.md → docs/api/slug.md b/docs/references/slug.md → docs/api/slug.md
diff --git a/docs/api/slug.rst b/docs/api/slug.rst
@@ -0,0 +1,5 @@
+slug
+----
+
+.. module:: validators.slug
+.. autofunction:: slug
diff --git a/docs/references/url.md → docs/api/url.md b/docs/references/url.md → docs/api/url.md
diff --git a/docs/api/url.rst b/docs/api/url.rst
@@ -0,0 +1,5 @@
+url
+---
+
+.. module:: validators.url
+.. autofunction:: url
diff --git a/docs/references/utils.md → docs/api/utils.md b/docs/references/utils.md → docs/api/utils.md
diff --git a/docs/api/utils.rst b/docs/api/utils.rst
@@ -0,0 +1,6 @@
+utils
+-----
+
+.. module:: validators.utils
+.. autofunction:: ValidationError
+.. autofunction:: validator
diff --git a/docs/references/uuid.md → docs/api/uuid.md b/docs/references/uuid.md → docs/api/uuid.md
diff --git a/docs/api/uuid.rst b/docs/api/uuid.rst
@@ -0,0 +1,5 @@
+uuid
+----
+
+.. module:: validators.uuid
+.. autofunction:: uuid
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,7 +28,7 @@
     "sphinx.ext.napoleon",
     "myst_parser",
 ]
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "*.md"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/*.md", "*.md"]
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,69 @@
+validators - Python Data Validation for Humans™
+===============================================
+
+|PyCQA| |SAST| |Docs| |Version| |Downloads|
+
+.. raw:: html
+
+   <!-- [![Package][package-badge]][package-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.
+
+.. code:: python
+
+   >>> import validators
+   >>> 
+   >>> validators.email('someone@example.com')
+   True
+
+Resources
+---------
+
+.. raw:: html
+
+   <!-- Temporary documentation URL :  https://yozachar.github.io/pyvalidators/ -->
+
+.. raw:: html
+
+   <!-- Original documentation URL :  https://python-validators.github.io/validators/ -->
+
+-  `Documentation <https://yozachar.github.io/pyvalidators/>`__
+-  `Bugtracker <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/>`__
+
+.. raw:: html
+
+   <!-- Original docs URL will be restored, once properly versioned docs is ready. -->
+
+.. raw:: html
+
+   <!-- Links -->
+
+.. raw:: html
+
+   <!-- [package-badge]: https://github.com/python-validators/validators/actions/workflows/package.yaml/badge.svg
+   [package-link]: https://github.com/python-validators/validators/actions/workflows/package.yaml -->
+
+.. |PyCQA| image:: https://github.com/python-validators/validators/actions/workflows/pycqa.yaml/badge.svg
+   :target: https://github.com/python-validators/validators/actions/workflows/pycqa.yaml
+.. |SAST| image:: https://github.com/python-validators/validators/actions/workflows/sast.yaml/badge.svg
+   :target: https://github.com/python-validators/validators/actions/workflows/sast.yaml
+.. |Docs| image:: https://github.com/yozachar/pyvalidators/actions/workflows/pages/pages-build-deployment/badge.svg
+   :target: https://github.com/yozachar/pyvalidators/actions/workflows/pages/pages-build-deployment
+.. |Version| image:: https://img.shields.io/pypi/v/validators?logo=pypi&logoColor=white&label=version&color=blue
+   :target: https://pypi.python.org/pypi/validators/
+.. |Downloads| image:: https://img.shields.io/pypi/dm/validators?logo=pypi&logoColor=white&color=blue
+   :target: https://pypi.python.org/pypi/validators/
+
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+   :caption: Reference:
+   :glob:
+
+   api/*