# GenKit
**GenKit** is a versatile Python package designed to generate random data such as phone numbers and email addresses, and to retrieve and filter zip code information. Whether you're developing, testing, or just need random data generation utilities, **GenKit** is the tool for you.
## Features
- **Zip Code Information**
- Retrieve zip code information based on country, city, and state.
- List all zip codes for a country or find specific zip code details.
- **Phone Number Generation**
- Generate random phone numbers for different countries.
- Supports output in string, list, and dictionary formats.
- Option to save generated phone numbers to a file.
- **Email Address Generation**
- Generate random email addresses with customizable domains and username lengths.
- Multiple output formats: string, list, and dictionary.
- Option to save generated email addresses to a file.
## Installation
You can easily install genkit using pip. Run the following command to install it:
```
pip install genkit
```
## Usage
### Zip Code Information
The `zipkit` method provides a simple way to retrieve zip code information based on your filters. You can find specific details about a zip code or get a list of zip codes filtered by country, state, and city.
#### Features
- **Find Zip Code Details**
Get detailed information about a specific zip code.
- **Filter Zip Codes**
Retrieve a list of zip codes based on country, state, or city filters, or a combination of these.
##### **Parameters**
| Parameters | Default | Description |
| ------------------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| **country** (str) | IN(India) | The country for which you want to retrieve zip code information |
| **state** (str) | optional | The state within the country to filter zip codes. |
| **city** (str) | optional | The city within the state to filter zip codes. |
| **find** (str) | | A specific zip code to look up. If provided, this overrides other filters and returns the details for the specified zip<br /> code. |
#### Examples
```
from genkit import GenKit
gk = GenKit()
zipcode_info = gk.zipkit(country="US", state="CA", city="San Francisco")
print(zipcode_info)
# Example of finding a specific zip code
zipcode_details = gk.zipkit(find="682301")
print(zipcode_details)
```
#### **Example Output:**
```python
print(zipcode_details)
{
"Country": "IN",
"Zip Code": "682301",
"City": "ERNAKULAM",
"State": "Kerala",
"Circle name": "Kerala Circle",
"Region name": "Kochi Region",
"Office name": "Tripunithura SO",
"Office type": "SO",
"Delivery status": "Delivery"
}
```
#### Supported Countries
Currently, **GenKit** supports zip code information for:
- **India (IN)**
- **United States (US)**
More countries will be added in future updates.
### Phone Number Generation
The `phonenumber` method in **GenKit** allows you to generate random phone numbers. You can specify the country, the number of phone numbers to generate, the output format, and whether the numbers should be saved to a file.
#### Features
- **Generate Random Phone Numbers**
Generate one or more random phone numbers based on the specified country. The numbers can be returned in various formats and saved to a file if needed.
- **Output Formats**
- **String** : A phone number as a string.
- **List** : A list of phone numbers.
- **Dictionary** : A dictionary with the data as the key and a list of phone numbers as the value.
#### **Parameters**
| Parameters | Default | Description |
| ------------------------ | --------- | -------------------------------------------------------------------------------- |
| **country** (str) | IN(India) | The country code (e.g., "IN" for India, "US" for the United States). |
| **n** (int) | 1 | The state within the country to filter zip codes. |
| **type** (str) | string | The format of the generated phone number(s). Can be "string", "list", or "dict". |
| **save** (bool) | True | Whether to save the generated phone numbers to a text file. |
Use 2-digit ISO codes to generate
#### Examples
#### Generating a Single Phone Number
```
from genkit import GenKit
# Generate a phone number for India (default)
print(GenKit.phonenumber())
# Generate a phone number for the US
print(GenKit.phonenumber("US"))
```
#### Generating Multiple Phone Numbers
To generate multiple phone numbers, use the `n` parameter to specify the quantity. You can also specify the output format using the `type` parameter.
```
from genkit import GenKit
# Generate 5 phone numbers for India and return as a list
print(GenKit.phonenumber("IN", n=5, type="list"))
# Generate 3 phone numbers for the US and return as a dictionary
print(GenKit.phonenumber("US", n=3, type="dict"))
```
#### Saving to a File
You can save the generated phone numbers to a text file. The file will be named `genkit_TIMESTAMP.txt`, where `TIMESTAMP` is the current timestamp.
```
from genkit import GenKit
# Generate 5 phone numbers for India and save to a file
GenKit.phonenumber("IN", n=5, save=True)
# Generate 3 phone numbers for the US in dictionary format and save to a file
GenKit.phonenumber("US", n=3, type="dict", save=True)
```
### Email Address Generation
The `email` method in **GenKit** helps you generate random email addresses. You can customize the domain, the length of the emails, the output format, and whether the emails should be saved to a file.
#### Features
- **Generate Random Email Addresses**
Generate one or more random email addresses with customizable domains and username lengths.
- **Output Formats**
- **String** : A email address as a string.
- **List** : A list of email addresses.
- **Dictionary** : A dictionary with the data as the key and a list of email as the value.
#### Parameters
| Parameters | Default | Description |
| ------------------------ | ----------- | ------------------------------------------------------------------------- |
| **domain** (str) | example.com | The email domain to use (e.g., "example.com"). |
| **length** (int) | 8 | The length of the generated email username. |
| **type** (str) | string | The format of the generated email(s). Can be "string", "list", or "dict". |
| **n** (int) | 1 | The number of email addresses to generate. |
| **save** (bool) | True | Whether to save the generated email addresses to a text file. |
#### Examples
#### Generating a Single Email Address
```
from genkit import GenKit
# Generate a random email address
print(GenKit.emailkit())
# Generate a random email address with a custom domain
print(GenKit.emailkit(domain="customdomain.com"))
```
#### Generating Multiple Email Addresses
To generate multiple email addresses, use the `n` parameter to specify the quantity. You can also specify the output format using the `type` parameter.
```
from genkit import GenKit
# Generate 5 random email addresses and return as a list
print(GenKit.emailkit(n=5, type="list"))
# Generate 3 random email addresses with a custom domain and return as a dictionary
print(GenKit.emailkit(domain="customdomain.com", n=3, type="dict"))
```
#### Saving to a File
You can save the generated email addresses to a text file. The file will be named `genkit_TIMESTAMP.txt`, where `TIMESTAMP` is the current timestamp.
```
from genkit import GenKit
# Generate 5 random email addresses and save to a file
GenKit.emailkit(n=5, save=True)
# Generate 3 random email addresses with a custom domain in dictionary format and save to a file
GenKit.emailkit(domain="customdomain.com", n=3, length=10, type="dict", save=True)
```
## Authors
For any questions or issues, please contact:
- **Author** : [Suhail Shaji](https://github.com/suhailshaji)
- **Email** : [suhailshaji@gmail.com]()
## Feedback
If you have any feedback, please reach out to us at
suhailshaji@gmail.com
## License
[MIT](https://choosealicense.com/licenses/mit/)
## 🔗 Connect
[](https://www.linkedin.com/in/suhailshaji)
Raw data
{
"_id": null,
"home_page": null,
"name": "genkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "random phone number generator, genkit, generate random phone number with country code",
"author": "Suhail Shaji",
"author_email": "suhailshaji@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/29/f4/606342108871f787ea0ccf8ce5e6a99560f8001bf1f36d6466b7c9689840/genkit-0.2.0.tar.gz",
"platform": null,
"description": "# GenKit\n\n**GenKit** is a versatile Python package designed to generate random data such as phone numbers and email addresses, and to retrieve and filter zip code information. Whether you're developing, testing, or just need random data generation utilities, **GenKit** is the tool for you.\n\n## Features\n\n- **Zip Code Information**\n - Retrieve zip code information based on country, city, and state.\n - List all zip codes for a country or find specific zip code details.\n- **Phone Number Generation**\n - Generate random phone numbers for different countries.\n - Supports output in string, list, and dictionary formats.\n - Option to save generated phone numbers to a file.\n- **Email Address Generation**\n - Generate random email addresses with customizable domains and username lengths.\n - Multiple output formats: string, list, and dictionary.\n - Option to save generated email addresses to a file.\n\n## Installation\n\nYou can easily install genkit using pip. Run the following command to install it:\n\n```\n\npip install genkit\n\n```\n\n## Usage\n\n### Zip Code Information\n\nThe `zipkit` method provides a simple way to retrieve zip code information based on your filters. You can find specific details about a zip code or get a list of zip codes filtered by country, state, and city.\n\n#### Features\n\n- **Find Zip Code Details**\n Get detailed information about a specific zip code.\n- **Filter Zip Codes**\n Retrieve a list of zip codes based on country, state, or city filters, or a combination of these.\n ##### **Parameters**\n\n | Parameters | Default | Description |\n | ------------------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n | **country**\u00a0(str) | IN(India) | The country for which you want to retrieve zip code information |\n | **state**\u00a0 (str) | optional | The state within the country to filter zip codes. |\n | **city**\u00a0 (str) | optional | The city within the state to filter zip codes. |\n | **find** (str) | | A specific zip code to look up. If provided, this overrides other filters and returns the details for the specified zip<br /> code. |\n\n#### Examples\n\n```\nfrom genkit import GenKit\n\ngk = GenKit()\nzipcode_info = gk.zipkit(country=\"US\", state=\"CA\", city=\"San Francisco\")\nprint(zipcode_info)\n\n# Example of finding a specific zip code\nzipcode_details = gk.zipkit(find=\"682301\")\nprint(zipcode_details)\n```\n\n#### **Example Output:**\n\n```python\nprint(zipcode_details)\n{\n \"Country\": \"IN\",\n \"Zip Code\": \"682301\",\n \"City\": \"ERNAKULAM\",\n \"State\": \"Kerala\",\n \"Circle name\": \"Kerala Circle\",\n \"Region name\": \"Kochi Region\",\n \"Office name\": \"Tripunithura SO\",\n \"Office type\": \"SO\",\n \"Delivery status\": \"Delivery\"\n}\n```\n\n#### Supported Countries\n\nCurrently, **GenKit** supports zip code information for:\n\n- **India (IN)**\n- **United States (US)**\n\nMore countries will be added in future updates.\n\n### Phone Number Generation\n\nThe `phonenumber` method in **GenKit** allows you to generate random phone numbers. You can specify the country, the number of phone numbers to generate, the output format, and whether the numbers should be saved to a file.\n\n#### Features\n\n- **Generate Random Phone Numbers**\n Generate one or more random phone numbers based on the specified country. The numbers can be returned in various formats and saved to a file if needed. \n- **Output Formats**\n - **String** : A phone number as a string.\n - **List** : A list of phone numbers.\n - **Dictionary** : A dictionary with the data as the key and a list of phone numbers as the value.\n\n#### **Parameters**\n\n| Parameters | Default | Description |\n| ------------------------ | --------- | -------------------------------------------------------------------------------- |\n| **country**\u00a0(str) | IN(India) | The country code (e.g., \"IN\" for India, \"US\" for the United States). |\n| **n**\u00a0 (int) | 1 | The state within the country to filter zip codes. |\n| **type**\u00a0 (str) | string | The format of the generated phone number(s). Can be \"string\", \"list\", or \"dict\". |\n| **save**\u00a0 (bool) | True | Whether to save the generated phone numbers to a text file. |\n\nUse 2-digit ISO codes to generate\n\n#### Examples\n\n#### Generating a Single Phone Number\n\n```\nfrom genkit import GenKit\n\n# Generate a phone number for India (default)\nprint(GenKit.phonenumber())\n\n# Generate a phone number for the US\nprint(GenKit.phonenumber(\"US\"))\n\n\n```\n\n#### Generating Multiple Phone Numbers\n\nTo generate multiple phone numbers, use the `n` parameter to specify the quantity. You can also specify the output format using the `type` parameter.\n\n```\nfrom genkit import GenKit\n\n# Generate 5 phone numbers for India and return as a list\nprint(GenKit.phonenumber(\"IN\", n=5, type=\"list\"))\n\n# Generate 3 phone numbers for the US and return as a dictionary\nprint(GenKit.phonenumber(\"US\", n=3, type=\"dict\"))\n\n```\n\n#### Saving to a File\n\nYou can save the generated phone numbers to a text file. The file will be named `genkit_TIMESTAMP.txt`, where `TIMESTAMP` is the current timestamp.\n\n```\nfrom genkit import GenKit\n\n# Generate 5 phone numbers for India and save to a file\nGenKit.phonenumber(\"IN\", n=5, save=True)\n\n# Generate 3 phone numbers for the US in dictionary format and save to a file\nGenKit.phonenumber(\"US\", n=3, type=\"dict\", save=True)\n\n\n```\n\n### Email Address Generation\n\nThe `email` method in **GenKit** helps you generate random email addresses. You can customize the domain, the length of the emails, the output format, and whether the emails should be saved to a file.\n\n#### Features\n\n- **Generate Random Email Addresses**\n Generate one or more random email addresses with customizable domains and username lengths.\n- **Output Formats**\n - **String** : A email address as a string.\n - **List** : A list of email addresses.\n - **Dictionary** : A dictionary with the data as the key and a list of email as the value.\n\n#### Parameters\n\n| Parameters | Default | Description |\n| ------------------------ | ----------- | ------------------------------------------------------------------------- |\n| **domain** (str) | example.com | The email domain to use (e.g., \"example.com\"). |\n| **length**\u00a0 (int) | 8 | The length of the generated email username. |\n| **type**\u00a0 (str) | string | The format of the generated email(s). Can be \"string\", \"list\", or \"dict\". |\n| **n** (int) | 1 | The number of email addresses to generate. |\n| **save**\u00a0 (bool) | True | Whether to save the generated email addresses to a text file. |\n\n#### Examples\n\n#### Generating a Single Email Address\n\n```\nfrom genkit import GenKit\n\n# Generate a random email address\nprint(GenKit.emailkit())\n\n# Generate a random email address with a custom domain\nprint(GenKit.emailkit(domain=\"customdomain.com\"))\n```\n\n#### Generating Multiple Email Addresses\n\nTo generate multiple email addresses, use the `n` parameter to specify the quantity. You can also specify the output format using the `type` parameter.\n\n```\nfrom genkit import GenKit\n\n# Generate 5 random email addresses and return as a list\nprint(GenKit.emailkit(n=5, type=\"list\"))\n\n# Generate 3 random email addresses with a custom domain and return as a dictionary\nprint(GenKit.emailkit(domain=\"customdomain.com\", n=3, type=\"dict\"))\n```\n\n#### Saving to a File\n\nYou can save the generated email addresses to a text file. The file will be named `genkit_TIMESTAMP.txt`, where `TIMESTAMP` is the current timestamp.\n\n```\nfrom genkit import GenKit\n\n# Generate 5 random email addresses and save to a file\nGenKit.emailkit(n=5, save=True)\n\n# Generate 3 random email addresses with a custom domain in dictionary format and save to a file\nGenKit.emailkit(domain=\"customdomain.com\", n=3, length=10, type=\"dict\", save=True)\n```\n\n## Authors\n\nFor any questions or issues, please contact:\n\n- **Author** : [Suhail Shaji](https://github.com/suhailshaji)\n- **Email** : [suhailshaji@gmail.com]()\n\n## Feedback\n\nIf you have any feedback, please reach out to us at\nsuhailshaji@gmail.com\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n## \ud83d\udd17 Connect\n\n[](https://www.linkedin.com/in/suhailshaji)\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for generating random data like phone numbers .",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [
"random phone number generator",
" genkit",
" generate random phone number with country code"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ade7167da0ad9fc589cfb5eb77c3acb7d5c9f759bca5f345846e0150d989372",
"md5": "adf2c9333d0a4ba8d1a56e9d7e09c998",
"sha256": "e1d60b36b494a6566c453202832c87049ab94b1f3864a834c2a8c6ca61d369b1"
},
"downloads": -1,
"filename": "genkit-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adf2c9333d0a4ba8d1a56e9d7e09c998",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 274930,
"upload_time": "2024-08-18T09:49:16",
"upload_time_iso_8601": "2024-08-18T09:49:16.231483Z",
"url": "https://files.pythonhosted.org/packages/5a/de/7167da0ad9fc589cfb5eb77c3acb7d5c9f759bca5f345846e0150d989372/genkit-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29f4606342108871f787ea0ccf8ce5e6a99560f8001bf1f36d6466b7c9689840",
"md5": "de264e7b70dee3d2b0137f19c43faa6d",
"sha256": "536eb6018c73a87ce58b93900c71a541a1ea08985c74c4ea327d5cb50349b4d8"
},
"downloads": -1,
"filename": "genkit-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "de264e7b70dee3d2b0137f19c43faa6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 254212,
"upload_time": "2024-08-18T09:49:17",
"upload_time_iso_8601": "2024-08-18T09:49:17.790007Z",
"url": "https://files.pythonhosted.org/packages/29/f4/606342108871f787ea0ccf8ce5e6a99560f8001bf1f36d6466b7c9689840/genkit-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 09:49:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "genkit"
}
JSON