https://github.com/fazatholomew/send-the-raven

Working with US Address made easier.
https://github.com/fazatholomew/send-the-raven

address-validation geospatial usps

Last synced: over 1 year ago
JSON representation

Working with US Address made easier.

• Host: GitHub
• URL: https://github.com/fazatholomew/send-the-raven
• Owner: Fazatholomew
• License: mit
• Created: 2023-09-15T17:20:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-26T12:00:32.000Z (over 2 years ago)
• Last Synced: 2025-01-21T15:23:46.853Z (over 1 year ago)
• Topics: address-validation, geospatial, usps
• Language: Python
• Homepage: http://send-the-raven.jimmyganteng.com/
• Size: 7.54 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
.. |.`~send_the_raven.address.Address`| replace:: ``Address``

.. _.`~send_the_raven.address.Address`: https://send-the-raven.jimmtganteng.com/_autosummary/send_the_raven.address.Address.html#send_the_raven.address.Address

Send The Raven

===============

Send the Raven is a Python library that provides a comprehensive collection of toolkits and algorithms for handling US addresses. It aims to simplify the process of working with US addresses, offering functionalities such as parsing, validation, formatting, and more.

.. image:: https://raw.githubusercontent.com/Fazatholomew/send-the-raven/ed0e3a63bc8d4602fe06d33f3af75b8a38ec568b/source/_static/d782276f-b708-4c7d-a077-5354d19f06fe.gif

   :alt: Game of Thrones Send the Ravens GIF

   :align: center

Checkout the official `documentation `_.

Features

---------

- **Address Parsing**: Extract structured information from US addresses, including street names, house numbers, city, state, and ZIP codes.

- **Address Validation**: Validate US addresses to ensure accuracy and compliance with USPS standards.  

- **Address Formatting**: Format US addresses in a consistent and standardized manner for various purposes.

- **Address Geocoding**: Convert US addresses into Longitude and Latitude.

- **Additional Utilities**: Additional utilities to enhance address handling, such as address comparison, address normalization, and more.

Installation

-------------

send_the_raven can be installed from PyPI:

.. code-block:: bash

   pip install send-the-raven

Usage

------

Here is a quick example of using send_the_raven to validate addresses into USPS Database:

.. code-block:: python

   from send_the_raven import Validator

   

   addresses = [

      {"street": "123 Main St", "city": "Anytown", "state": "CA", "zip_code": "12345"},

      {"street": "456 Oak Rd", "city": "Forest", "state": "VT", "zip_code": "67890"}

   ]

   

   validator = Validator(addresses, usps_id="MY_ID")

   valid_addresses = validator()

   

send_the_raven handles parsing the address data, constructing the validation requests, and returning the corrected addresses.

The :py|.`~send_the_raven.address.Address`|_ class also provides methods for normalizing, geocoding, and working with addresses.

Acknowledgments

----------------

send_the_raven uses the following open source libraries:

- `usaddress-scourgify `_ for parsing addresses.

- `xmltodict `_ for working with XML. 

- `aiohttp `_ for asynchronous HTTP requests.

- `geopy `_ for geocoding.

- `h3-py `_ for geospatial indexing.

We thank the developers of these libraries for their contributions.

* `Examples `_

* `API Reference `_

* `Contributing `_