Metadata-Version: 2.4
Name: icakad
Version: 0.1.0
Summary: Utilities and tools for my apis and other life hacks.
Author: icakad
License: MIT License
        
        Copyright (c) 2024 icakad
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://linkove.icu/
Project-URL: Repository, https://github.com/icakad97/icakad
Keywords: icakad,shorturl,url-shortener,encoding
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# icakad

Lightweight utilities for encoding integers into short, URL-friendly tokens.

## Installation

```bash
pip install icakad
```

## Quickstart

```python
from icakad import ShortURL, encode, decode, ShortURLConfig

token = encode(12345)
assert decode(token) == 12345

custom = ShortURL(ShortURLConfig(alphabet="abcd", min_length=6))
assert custom.encode(5) == "aaaabd"
```

## Features

- Zero-dependency implementation with a configurable alphabet
- Encode and decode helpers plus a reusable `ShortURL` codec
- Optional minimum length padding for consistent token sizes

## Development

To build the package locally:

```bash
python -m build
```

Run tests (if you add them) with:

```bash
python -m pytest
```
