Merge pull request #6 from codeperfectplus/features/dev

Features/dev

.readthedocs.yaml

@@ -9,27 +9,16 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
-    # You can also specify other tool versions:
-    # nodejs: "20"
-    # rust: "1.70"
-    # golang: "1.20"
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/conf.py
-  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
-  # builder: "dirhtml"
-  # Fail on all warnings to avoid broken references
-  # fail_on_warning: true
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:
   - pdf
   - epub
 
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
     - requirements: docs/requirements.txt

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## First Release 
+## First Release Version 1.0.0 - 31-May-2024
 
--  initial features release with encoding and decoding
+- Initial release of the project.
+
+## Second Release Version 1.1.0
+
+-  added new functionality
+   -  Function added to check if a given EAN-13 barcode is valid or not
+   -  Array validation multiple functions added
+
+-  documentation added
+-  code refactored and code quality improved
+-  test cases and test coverage added
+-  bug fixes

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to Validator.py
+# Contributing to Sanatio
 
 We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
 
@@ -21,7 +21,7 @@ We love your input! We want to make contributing to this project as easy and tra
 - Add a upstream link to main branch in your cloned repo
 
     ```sh
-    git remote add upstream https://github.com/Py-Contributors/validator.py/
+    git remote add upstream https://github.com/codeperfectplus/Sanatio/
     ```
 
 - Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)

ROADMAP.MD

@@ -1,4 +1,4 @@
-Validator.py is simple python tool to validate Document/String/Number/Date/Email/Username/Password.
+Sanatio is simple python tool to validate Document/String/Number/Date/Email/Username/Password.
 
 Currently it supports following Document validation: Few countries added in initial release. More countries will be added in future release.
 

docs/conf.py

@@ -2,7 +2,7 @@
 
 project = 'Sanatio'
 author = 'Deeapk Raj'
-release = '1.0.0'
+release = '1.1.0'
 
 extensions = [
     'sphinx.ext.autodoc',

docs/date/date.rst

@@ -5,9 +5,9 @@ The following functions are used to validate dates.  They return a boolean value
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`IsDate()` Returns true if the value is a valid date.
     args: value

docs/document/aadhar_card.rst

@@ -7,9 +7,9 @@ aadhar card is 12 digit number.
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isAadharCard(value)` - check if the value is a valid aadhar card number.
     >>> val.isAadharCard('9284 9436 2499')

docs/document/card.rst

@@ -7,9 +7,9 @@ boolean value.
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isCreditCard(value)` - Checks if the value is a valid credit card number.
 

docs/document/licenseplate.rst

@@ -5,9 +5,9 @@ Check if a license plate is valid or not.
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isLicensePlate()` - Check if a license plate is valid or not.
     args: value

docs/document/mobilenumber.rst

@@ -6,9 +6,9 @@ mobile number ranges published by the ITU-T E.164. The list is updated
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isMobilePhone(value, locale)` - checks if the string is a valid mobile phone number.
 

docs/document/passport.rst

@@ -5,9 +5,9 @@ This module provides a validation for passport numbers.
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isPassportNumber(value, locale):` - Return True if the string is a valid passport number.
     Args: value, locale

docs/document/postalcode.rst

@@ -5,9 +5,9 @@ The following functions are used to validate postal codes.
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isPostalCode(value, locale)` - return true if the postal code is valid for the country
     args: value, locale

docs/email/email.rst

@@ -5,9 +5,9 @@ The following functions are used to validate email addresses.
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isEmail()` - Returns true if the email address is valid, false otherwise.
     args: value, checkDNS

docs/index.rst

@@ -1,6 +1,6 @@
 .. rst-class:: hide-header
 
-Welcome to Validator.py's documentation!
+Welcome to Sanatio's documentation!
 =====================================
 
 

docs/introduction.rst

@@ -8,27 +8,26 @@ This library is written in pure python and is very easy to use.
 It is a simple library that can be used to validate strings, documents, emails, dates, urls, domain names, etc.
 
 Installation
-============
+------------
 
 To install the library, you can use pip: 
 
-```bash
-pip install sanatio
-```
+:code:` pip install sanatio`
+
+Usage-Examples
+--------------
 
-Usage
-=====
+.. code:: python
 
-```python
-from sanatio import Validator
-val = Validator()
+from sanatio import Sanatio
+val = Sanatio()
 
 
 # Check if the string is equal to the given value
 
-```python
+.. code:: python
+
 val.equals("abc", "abc") # True
-```
 
 
 

docs/number/number_validation.rst

@@ -5,9 +5,9 @@ The following functions are used to validate numbers.
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isDecimal(value)`
     Returns true if the value is a decimal number.

docs/other/index.rst

@@ -0,0 +1,9 @@
+Number Validation
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+   other.rst
+
+

docs/other/other.rst

@@ -0,0 +1,17 @@
+Number Validation functions
+===========================
+
+The following functions are used to 
+
+.. code:: python
+    
+    from sanatio import Sanatio
+
+    val = Sanatio()
+
+:code:`isEan13` - Check if the value is a valid EAN13 number
+    Returns true if the value is a valid EAN13 number
+
+    >>> val.isEan13('0067238891190')
+    True
+

docs/password/password.rst

@@ -5,9 +5,9 @@ The password validation is done by the function isStrongPassword().
 
 .. code:: python
     
-    from sanatio import Validator
+    from sanatio import Sanatio
 
-    val = Validator()
+    val = Sanatio()
 
 :code:`isStrongPassword(value)`
     Returns true if the password is strong enough, false otherwise.