-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
105 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: Test Pull Request | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.x | ||
|
||
- name: Install dependencies | ||
run: pip3 install --disable-pip-version-check '.[dev]' | ||
|
||
- name: Run pytest | ||
run: pytest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ on: | |
- main | ||
|
||
jobs: | ||
build: | ||
build-and-publish: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,78 @@ | ||
# random-real-address | ||
Python library to generate real address in the US. | ||
# Random Real Address Generator | ||
|
||
![PyPI Version](https://img.shields.io/pypi/v/random-real-address) | ||
|
||
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. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" | |
|
||
[project] | ||
name = "random-real-address" | ||
version = "0.1.0" | ||
version = "0.1.1" | ||
description = "A Python package to generate real addresses in the US." | ||
authors = [{name = "Naren Thiagarajan", email = "[email protected]"}] | ||
license = {text = "MIT License"} | ||
|