send-the-raven 0.1.0

A collection of toolkit and algorithms for handling US addresses

<title>Send The Raven — Send The Raven</title> <script data-cfasync="false"> document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; </script>

<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />

<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=927b94d3fcb96560df09"></script>

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Examples" href="example.html" />

Skip to main content

Back to top

Ctrl+K

<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>

  <div class="bd-sidebar-primary bd-sidebar">

<div class="sidebar-primary-items__start sidebar-primary__section">
    <div class="sidebar-primary-item">

<img src="_static/android-chrome-512x512.png" class="logo__image only-light" alt="Logo image"/>
<script>document.write(`<img src="_static/android-chrome-512x512.png" class="logo__image only-dark" alt="Logo image"/>`);</script>

• Get Started
• Examples
• API Reference
  • send_the_raven.address
    • send_the_raven.address.compare
    • send_the_raven.address.Address
    • send_the_raven.address.Addresses
    • send_the_raven.address.Placemapper
  • send_the_raven.geoaddress
    • send_the_raven.geoaddress.GeoAddress
    • send_the_raven.geoaddress.Geocoder
  • send_the_raven.validator
    • send_the_raven.validator.Validator
  • send_the_raven.utils
    • send_the_raven.utils.generate_id
    • send_the_raven.utils.split_into_n_elements
• Contributing

</div>

  </div>
  
  <main id="main-content" class="bd-main">

      <div class="bd-content">
        <div class="bd-article-container">
          
          <div class="bd-header-article">

<div class="header-article-items__start">
  
    <div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">

</div>


<div class="header-article-items__end">
  
    <div class="header-article-item">

  <li><a href="_sources/index.rst" target="_blank"

class="btn btn-sm btn-download-source-button dropdown-item" title="Download source file" data-bs-placement="left" data-bs-toggle="tooltip"

.rst

  <li>

<button onclick="window.print()" class="btn btn-sm btn-download-pdf-button dropdown-item" title="Print to PDF" data-bs-placement="left" data-bs-toggle="tooltip"

.pdf

<button onclick="toggleFullScreen()" class="btn btn-sm btn-fullscreen-button" title="Fullscreen mode" data-bs-placement="bottom" data-bs-toggle="tooltip"

<script> document.write(` `); </script> <script> document.write(` `); </script>

<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary"title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">

</div>

Send The Raven

        <div>
            <h2> Contents </h2>
        </div>
        <nav aria-label="Page">
            <ul class="visible nav section-nav flex-column">

Features

Installation

Usage

Acknowledgments

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.

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.

• 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:

pip install send_the_raven

Usage#

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

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 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.

            </article>
          

          
          
          
          
            <footer class="prev-next-footer">
              <!-- Previous / next buttons -->

next

Examples

        </div>
        
        
          
            <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">

Contents

• Features
• Installation
• Usage
• Acknowledgments

      </div>
      <footer class="bd-footer-content">

By Jimmy Hikmatullah

  © Copyright 2023, Jimmy Hikmatullah.
  <br/>

  </main>
</div>

<script src="_static/scripts/bootstrap.js?digest=927b94d3fcb96560df09"></script> <script src="_static/scripts/pydata-sphinx-theme.js?digest=927b94d3fcb96560df09"></script>