# Random Real Address Generator
Generate random, realistic addresses from a curated list. This Python library allows you to obtain random addresses or addresses specific to any U.S. state. It includes a collection of actual addresses that provide realistic data points for testing or demonstration purposes.
## Features
- Generate random addresses across the U.S.
- Generate random addresses specific to a U.S. state
- Provides structured data (street, city, state, zipcode)
- Incorporates official state abbreviations
## Installation
You can install the package via pip:
```bash
pip install random-address-generator
```
## Usage
### Generating a Random Address
```py
from from random_address import generate_random_address
print(generate_random_address())
```
Output:
```bash
208 Northwind Dr
Goodlettsville, Tennessee 37072
```
### Generating an Address in a Specific State
```py
from random_address import generate_random_address_in_state, State
print(generate_random_address_in_state(State.CA))
print(generate_random_address_in_state(State.ME))
```
Output:
```bash
1839 Arbor Way
Turlock, California 95380
10 Bass Ln
Winterport, Maine 04496
```
## Learn More
For more details, visit the project page on PyPI: [Random Real Address on PyPI](https://pypi.org/project/random-real-address/)
## Development
To develop on this repository use `bin/install` to set up your environment. And run `bin/test` to run tests.
## Contributing
Feel free to contribute by submitting pull requests or reporting issues.
1. Fork the project.
2. Make your feature addition or bug fix.
3. Add tests for your changes.
4. Ensure all tests are passing.
5. Submit a pull request.
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "random-real-address",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "address, random address, US",
"author": null,
"author_email": "Naren Thiagarajan <narenst@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0c/33/c9ba6efc10b689a47e48457f21eb058da34fd333de9161737aebd9c2c920/random_real_address-0.1.2.tar.gz",
"platform": null,
"description": "# Random Real Address Generator\n\n\n\nGenerate random, realistic addresses from a curated list. This Python library allows you to obtain random addresses or addresses specific to any U.S. state. It includes a collection of actual addresses that provide realistic data points for testing or demonstration purposes.\n\n## Features\n\n- Generate random addresses across the U.S.\n- Generate random addresses specific to a U.S. state\n- Provides structured data (street, city, state, zipcode)\n- Incorporates official state abbreviations\n\n## Installation\n\nYou can install the package via pip:\n\n```bash\npip install random-address-generator\n```\n\n## Usage\n\n### Generating a Random Address\n\n```py\nfrom from random_address import generate_random_address\nprint(generate_random_address())\n```\n\nOutput:\n\n```bash\n208 Northwind Dr\nGoodlettsville, Tennessee 37072\n```\n\n### Generating an Address in a Specific State\n\n```py\nfrom random_address import generate_random_address_in_state, State\nprint(generate_random_address_in_state(State.CA))\nprint(generate_random_address_in_state(State.ME))\n```\n\nOutput:\n\n```bash\n1839 Arbor Way\nTurlock, California 95380\n\n10 Bass Ln\nWinterport, Maine 04496\n```\n\n## Learn More\n\nFor more details, visit the project page on PyPI: [Random Real Address on PyPI](https://pypi.org/project/random-real-address/)\n\n## Development\n\nTo develop on this repository use `bin/install` to set up your environment. And run `bin/test` to run tests.\n\n## Contributing\n\nFeel free to contribute by submitting pull requests or reporting issues.\n\n1. Fork the project.\n2. Make your feature addition or bug fix.\n3. Add tests for your changes.\n4. Ensure all tests are passing.\n5. Submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License.\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A Python package to generate real addresses in the US.",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [
"address",
" random address",
" us"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b90f387cc332fef970e4cfd04e0a7efff4493042d82d11c6d797c9c713869299",
"md5": "a2172ac57be637b554b180c0ec9f6472",
"sha256": "91e98f88b1b176b868a78d347036a76feb03e4940b21764d5ee14322c59b7ce2"
},
"downloads": -1,
"filename": "random_real_address-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2172ac57be637b554b180c0ec9f6472",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2967,
"upload_time": "2024-05-10T18:43:26",
"upload_time_iso_8601": "2024-05-10T18:43:26.078993Z",
"url": "https://files.pythonhosted.org/packages/b9/0f/387cc332fef970e4cfd04e0a7efff4493042d82d11c6d797c9c713869299/random_real_address-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c33c9ba6efc10b689a47e48457f21eb058da34fd333de9161737aebd9c2c920",
"md5": "d99783529c2e04c487135514eae093f0",
"sha256": "3b7afe84c358f42f2380463ef162ca626e83c67792ddf7eff0f1696fa5fa98fe"
},
"downloads": -1,
"filename": "random_real_address-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "d99783529c2e04c487135514eae093f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3381,
"upload_time": "2024-05-10T18:43:27",
"upload_time_iso_8601": "2024-05-10T18:43:27.573178Z",
"url": "https://files.pythonhosted.org/packages/0c/33/c9ba6efc10b689a47e48457f21eb058da34fd333de9161737aebd9c2c920/random_real_address-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 18:43:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "random-real-address"
}
JSON