simon-datavalidator 0.11

A simple data validation package

data-validator-simon-dickson

simon-datavalidator is a Python package that uses Object-Oriented Programming (OOP) to validate various data types, including emails, phone numbers, dates, and URLs, using regular expressions. It also includes comprehensive unit tests to ensure accuracy and reliability.

Features

• Validate email addresses with robust pattern matching.
• Validate phone numbers supporting international formats.
• Validate dates in formats YYYY-MM-DD and YYYY/MM/DD.
• Validate URLs for both HTTP and FTP protocols.
• Comprehensive unit testing with pytest.

---

Project Structure

File Breakdown

validator.py

Defines the DataValidator class with the following methods:

• validate_email(): Validates email addresses using a regular expression.
• validate_phone(): Validates phone numbers with support for international formats.
• validate_date(): Validates date strings in both YYYY-MM-DD and YYYY/MM/DD formats.
• validate_url(): Validates URLs supporting both HTTP and FTP protocols.

test_validator.py

Contains unit tests for each validation method using pytest. The tests cover:

• Valid and invalid email addresses.
• Valid and invalid phone numbers.
• Valid and invalid date formats.
• Valid and invalid URLs.

setup.py

Handles the package setup and metadata, including author information and version.

---

Prerequisites

Ensure you have Python 3.7 or later installed.

Install Dependencies

No external libraries are required, as the project only uses Python’s built-in modules.

To install pytest for testing, run:

pip install pytest

Cloning the Project

To get started, clone the repository:

git clone https://github.com/Data-Epic/data-validator-simon-dickson.git

---

Running Tests with Pytest

This project includes unit tests to validate its functionality. To run the tests, execute:

pytest -v

---

Installation

To install the package locally, run:

pip install simon-datavalidator

---

Instructions for use

Step 1: Creating A Virtual Environment

To create and activate a virtual environment, follow these steps: On Windows:

python -m venv simon-env
simon-env\Scripts\activate

On macOS/Linux:

python3 -m venv simon-env
source simon-env/bin/activate

Step 2: Installing the Package

After creating and activating the virtual environment, install the package as follows:

pip install simon-datavalidator

Step 3: Importing and Using the Package in Your Project

Create a Python file (e.g., main.py) and import the package as follows:

from datavalidator import DataValidator

# Example usage with verbose mode enabled
validator = DataValidator(verbose=True)

# Email validation
validator.data = "[e-mail]"
print(validator.validate_email())

# Phone validation
validator.data = "[phone]"
print(validator.validate_phone())

# Date validation
validator.data = "2024-02-29"
print(validator.validate_date())

# URL validation
validator.data = "https://example.com"
print(validator.validate_url())

Step 4: Running the Script

python main.py

---

Author

Name: Simon Dickson Email: [e-mail]