Merge pull request #18 from lukbrew25/feat/command-line-interface

feat: add Command Line Interface

Author: ankitgadling

README.md

@@ -1,4 +1,3 @@
-
 # Postal Regex 📨
 
 [![PyPI version](https://img.shields.io/pypi/v/postal-regex.svg)](https://pypi.org/project/postal-regex/)
@@ -111,6 +110,58 @@ print(df_validated)
 
 ---
 
+## Command-Line Usage
+
+You can validate postal codes directly from the command line without writing any code.
+
+### Validate Postal Codes
+
+To validate one or more postal codes for a specific country:
+
+```sh
+python -m postal_regex.cli validate <postal_code1> <postal_code2> ... <country>
+```
+
+**Examples:**
+
+Validate a single code for India:
+```
+python -m postal_regex.cli validate 110001 IN
+```
+Output:
+```
+110001: Valid
+```
+
+Validate multiple codes for the United States:
+```
+python -m postal_regex.cli validate 12345 90210 US
+```
+Output:
+```
+12345: Valid
+90210: Valid
+```
+
+You can also use country names:
+```
+python -m postal_regex.cli validate 110001 India
+```
+
+### View Validation Statistics
+
+To view local validation statistics:
+```
+python -m postal_regex.cli stats
+```
+
+To reset statistics:
+```
+python -m postal_regex.cli stats --reset
+```
+
+---
+
 ## Contributing
 
 We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

src/postal_regex/cli.py

@@ -1,5 +1,6 @@
 import argparse
 from . import analytics
+from .core import validate
 
 
 def main():
@@ -15,13 +16,29 @@ def main():
         "--reset", action="store_true", help="Reset all recorded statistics."
     )
 
+    # The 'validate' command
+    validate_parser = subparsers.add_parser(
+        "validate", help="Validate postal codes for a given country."
+    )
+    validate_parser.add_argument(
+        "postal_codes", nargs="+", help="Postal code(s) to validate."
+    )
+    validate_parser.add_argument(
+        "country", help="Country code or name to validate against."
+    )
+
     args = parser.parse_args()
 
     if args.command == "stats":
         if args.reset:
             analytics.reset_stats()
         else:
             analytics.show_stats()
+    elif args.command == "validate":
+        for code in args.postal_codes:
+            is_valid = validate(args.country, code)
+            result = "Valid" if is_valid else "Invalid"
+            print(f"{code}: {result}")
     else:
         parser.print_help()