Skip to content

ZIP-0: renames the pypi project package name to ziptax-sdk #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericlakich merged 1 commit into from
Jan 28, 2026
Merged

ZIP-0: renames the pypi project package name to ziptax-sdk #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/project/ziptax/
url: https://pypi.org/project/ziptax-sdk/
permissions:
id-token: write

Expand Down
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ZipTax Python SDK
# Ziptax Python SDK

Official Python SDK for the [ZipTax API](https://zip-tax.com) - Get accurate sales and use tax rates for any US or Canadian address.
Official Python SDK for the [Ziptax API](https://zip-tax.com) - Get accurate sales and use tax rates for any US or Canadian address.

[![Python Version](https://img.shields.io/pypi/pyversions/ziptax)](https://pypi.org/project/ziptax/)
[![Python Version](https://img.shields.io/pypi/pyversions/ziptax-sdk)](https://pypi.org/project/ziptax-sdk/)
[![License](https://img.shields.io/github/license/ziptax/ziptax-python)](LICENSE)

## Features
Expand All @@ -19,16 +19,16 @@ Official Python SDK for the [ZipTax API](https://zip-tax.com) - Get accurate sal
## Installation

```bash
pip install ziptax
pip install ziptax-sdk
```

## Quick Start

```python
from ziptax import ZipTaxClient
from ziptax import ZiptaxClient

# Initialize the client with your API key
client = ZipTaxClient.api_key("your-api-key-here")
client = ZiptaxClient.api_key("your-api-key-here")

# Get sales tax by address
response = client.request.GetSalesTaxByAddress(
Expand All @@ -49,21 +49,21 @@ client.close()
### Initialize the Client

```python
from ziptax import ZipTaxClient
from ziptax import ZiptaxClient

# Basic initialization
client = ZipTaxClient.api_key("your-api-key-here")
client = ZiptaxClient.api_key("your-api-key-here")

# With custom configuration
client = ZipTaxClient.api_key(
client = ZiptaxClient.api_key(
"your-api-key-here",
timeout=60, # Request timeout in seconds
max_retries=5, # Maximum retry attempts
retry_delay=2.0, # Base delay between retries
)

# Using as a context manager (recommended)
with ZipTaxClient.api_key("your-api-key-here") as client:
with ZiptaxClient.api_key("your-api-key-here") as client:
response = client.request.GetSalesTaxByAddress("123 Main St")
```

Expand Down Expand Up @@ -132,7 +132,7 @@ print(f"Account Active: {metrics.is_active}")
You can configure the client using dict-style access:

```python
client = ZipTaxClient.api_key("your-api-key-here")
client = ZiptaxClient.api_key("your-api-key-here")

# Set configuration options
client.config["format"] = "json"
Expand Down Expand Up @@ -180,8 +180,8 @@ except ZipTaxServerError as e:
print(f"Server error: {e.message}")

except ZipTaxError as e:
# General ZipTax errors
print(f"ZipTax error: {e.message}")
# General Ziptax errors
print(f"Ziptax error: {e.message}")
```

### Exception Hierarchy
Expand Down Expand Up @@ -343,7 +343,7 @@ See the [examples/](examples/) directory for complete examples:

### ZipTaxClient

Main client for interacting with the ZipTax API.
Main client for interacting with the Ziptax API.

#### Methods

Expand Down Expand Up @@ -397,4 +397,4 @@ See [CHANGELOG.md](CHANGELOG.md) for version history and changes.

---

Made with ❤️ by the ZipTax Team
Made with ❤️ by the Ziptax Team
10 changes: 5 additions & 5 deletions docs/spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# =============================================================================
# SDK Generation Template for ZipTax API
# SDK Generation Template for Ziptax API
# =============================================================================
# This template provides a comprehensive spec for codegen agents

# -----------------------------------------------------------------------------
# Project Metadata
# -----------------------------------------------------------------------------
project:
name: "ziptax-python"
name: "ziptax-sdk"
language: "python"
version: "1.0.0"
description: "Official Python SDK for the ZipTax API"
description: "Official Python SDK for the Ziptax API"

# Repository information
repository:
Expand All @@ -22,15 +22,15 @@ project:

# Maintainer information
maintainers:
- name: "ZipTax Team"
- name: "Ziptax Team"
email: "support@zip.tax"

# -----------------------------------------------------------------------------
# API Configuration
# -----------------------------------------------------------------------------
api:
# Base API details
name: "ZipTax API"
name: "Ziptax API"
version: "v60"
base_url: "https://api.zip-tax.com/"

Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "ziptax"
version = "1.0.0"
description = "Official Python SDK for the ZipTax API"
name = "ziptax-sdk"
version = "0.1.0-beta"
description = "Official Python SDK for the Ziptax API"
readme = "README.md"
requires-python = ">=3.8"
license = {text = "MIT"}
authors = [
{name = "ZipTax Team", email = "support@zip.tax"}
{name = "Ziptax Team", email = "support@zip.tax"}
]
keywords = ["tax", "ziptax", "api", "sdk", "sales tax"]
classifiers = [
Expand Down
Loading