# telcolib
## Overview
`telcolib` is a Python library designed for validating phone numbers across multiple countries. Utilizing regular expressions, it ensures phone numbers adhere to specific national formats.
## Features
- Validates phone numbers from a wide range of countries.
- Easily extendable to include additional countries and formats.
- Simple, straightforward API.
## Installation
To install `telcolib`, run the following command:
```bash
pip install telcolib
```
Alternatively, you can clone the repository and install it manually:
```bash
git clone https://github.com/copyleftdev/telcolib.git
cd telcolib
pip install .
```
## Usage
Here's a quick example of how to use `telcolib`:
```python
from telcolib import PhoneNumberValidator
# Create an instance of the validator
validator = PhoneNumberValidator()
# Validate a phone number
valid = validator.validate('+14445556666', 'USA')
print("Phone number is valid:", valid)
```
## Adding Custom Patterns
To add or update a country's phone number pattern:
```python
validator.add_country_pattern('CountryName', r'^\+CountryCode\d{NumberOfDigits}$')
```
## Development
### Prerequisites
- Python 3.6 or higher.
### Setting Up a Development Environment
1. Clone the repository:
```bash
git clone https://github.com/copyleftdev/telcolib.git
```
2. Navigate to the project directory:
```bash
cd telcolib
```
3. Install the dependencies:
```bash
pip install -r requirements.txt
```
## Running Tests
To run the tests, execute:
```bash
pytest tests/
```
## Contributing
Contributions to `telcolib` are welcome! Feel free to fork the repository and submit pull requests.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For questions or feedback related to `telcolib`, please open an issue in the GitHub repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/telcolib",
"name": "telcolib",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "phone number validation telecommunications",
"author": "Don Johnson",
"author_email": "dj@codetestcode.io",
"download_url": "https://files.pythonhosted.org/packages/30/eb/e94619836457f298d7de084bc572b68f3a4b36c4920fe80628618c0994d3/telcolib-0.2.tar.gz",
"platform": null,
"description": "# telcolib\r\n\r\n## Overview\r\n\r\n`telcolib` is a Python library designed for validating phone numbers across multiple countries. Utilizing regular expressions, it ensures phone numbers adhere to specific national formats.\r\n\r\n## Features\r\n\r\n- Validates phone numbers from a wide range of countries.\r\n- Easily extendable to include additional countries and formats.\r\n- Simple, straightforward API.\r\n\r\n## Installation\r\n\r\nTo install `telcolib`, run the following command:\r\n\r\n```bash\r\npip install telcolib\r\n```\r\n\r\nAlternatively, you can clone the repository and install it manually:\r\n\r\n```bash\r\ngit clone https://github.com/copyleftdev/telcolib.git\r\ncd telcolib\r\npip install .\r\n```\r\n\r\n## Usage\r\n\r\nHere's a quick example of how to use `telcolib`:\r\n\r\n```python\r\nfrom telcolib import PhoneNumberValidator\r\n\r\n# Create an instance of the validator\r\nvalidator = PhoneNumberValidator()\r\n\r\n# Validate a phone number\r\nvalid = validator.validate('+14445556666', 'USA')\r\nprint(\"Phone number is valid:\", valid)\r\n```\r\n\r\n## Adding Custom Patterns\r\n\r\nTo add or update a country's phone number pattern:\r\n\r\n```python\r\nvalidator.add_country_pattern('CountryName', r'^\\+CountryCode\\d{NumberOfDigits}$')\r\n```\r\n\r\n## Development\r\n\r\n### Prerequisites\r\n\r\n- Python 3.6 or higher.\r\n\r\n### Setting Up a Development Environment\r\n\r\n1. Clone the repository:\r\n\r\n ```bash\r\n git clone https://github.com/copyleftdev/telcolib.git\r\n ```\r\n\r\n2. Navigate to the project directory:\r\n\r\n ```bash\r\n cd telcolib\r\n ```\r\n\r\n3. Install the dependencies:\r\n\r\n ```bash\r\n pip install -r requirements.txt\r\n ```\r\n\r\n## Running Tests\r\n\r\nTo run the tests, execute:\r\n\r\n```bash\r\npytest tests/\r\n```\r\n\r\n## Contributing\r\n\r\nContributions to `telcolib` are welcome! Feel free to fork the repository and submit pull requests.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Contact\r\n\r\nFor questions or feedback related to `telcolib`, please open an issue in the GitHub repository.\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A phone number validation library for multiple countries",
"version": "0.2",
"project_urls": {
"Homepage": "https://github.com/yourusername/telcolib"
},
"split_keywords": [
"phone",
"number",
"validation",
"telecommunications"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8d8f7440c0c43b5e4348b6c9243b7a16e15d5690e887d79513711d106e53b6e",
"md5": "5d49102b9f017ab50324e08fbdbec528",
"sha256": "b3a0b771c7a99282ffb6c1597401c9a28e9115c0fc7a05807fec298286cddb6f"
},
"downloads": -1,
"filename": "telcolib-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d49102b9f017ab50324e08fbdbec528",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17105,
"upload_time": "2023-12-07T05:50:00",
"upload_time_iso_8601": "2023-12-07T05:50:00.083514Z",
"url": "https://files.pythonhosted.org/packages/a8/d8/f7440c0c43b5e4348b6c9243b7a16e15d5690e887d79513711d106e53b6e/telcolib-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30ebe94619836457f298d7de084bc572b68f3a4b36c4920fe80628618c0994d3",
"md5": "07eac74a27752c49ff4cce47659c71fe",
"sha256": "ec184db91e10f59fa2a367d9884cca71d7b7b2e1f121cf7617ec7a9c122ce745"
},
"downloads": -1,
"filename": "telcolib-0.2.tar.gz",
"has_sig": false,
"md5_digest": "07eac74a27752c49ff4cce47659c71fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16488,
"upload_time": "2023-12-07T05:50:02",
"upload_time_iso_8601": "2023-12-07T05:50:02.508716Z",
"url": "https://files.pythonhosted.org/packages/30/eb/e94619836457f298d7de084bc572b68f3a4b36c4920fe80628618c0994d3/telcolib-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-07 05:50:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "telcolib",
"github_not_found": true,
"lcname": "telcolib"
}
JSON
