Metadata-Version: 2.1
Name: uscodekit
Version: 2024.0.0
Summary: A Python package for US codes validation, extraction, formatting, cleaning, and more.
Home-page: https://github.com/rk4bir/USCodeKit
License: MIT
Author: Raihan Kabir
Author-email: r.kabir01@proton.me
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: cryptography (>=43.0.3,<44.0.0)
Project-URL: Repository, https://github.com/rk4bir/USCodeKit
Description-Content-Type: text/markdown

<p align="center">
  <img src="./docs/logo.png" alt="USCodeKit_logo" width="200"/>
</p>

<h1 align="center">USCodeKit</h1>

<p align="center">
  <img src="./docs/coverage.svg" alt="Coverage"/>
</p>

# USCodeKit

> A comprehensive package that includes all the essential tools commonly used for US phone, zip code info, NAICS (2022), (upcoming more...)

## Docs

> [Hosted Docs](https://rk4bir.github.io/USCodeKit/)

- [Installation](#installation)
- [Getting Started](./docs/README.md)
- **Modules**
  - [phone](./docs/phone/README.md)
  - [zip_code](./docs/zip_code/README.md)
  - [NAICS (2022)](./docs//naics/README.md)

## Installation

Using `pip`

```bash
pip install uscodekit
```

Using `poetry`

```bash
poetry add uscodekit
```

