Migration Guide

Migration Guide

v1.0.3 → v1.0.4

Removed constructor parameters

base_url and staging were removed from FormaTexClient.__init__().

Before (1.0.3):

client = FormaTexClient("fx_key", staging=True)
client = FormaTexClient("fx_key", base_url="https://custom.example.com")

After (1.0.4):

# Use the FORMATEX_BASE_URL environment variable for custom endpoints
import os
os.environ["FORMATEX_BASE_URL"] = "https://custom.example.com"
client = FormaTexClient("fx_key")

Action required: If you used staging=True, switch to the FORMATEX_BASE_URL env var. If you didn't use these options, no changes needed.

pip install --upgrade formatex

---

v1.0.2 → v1.0.3

Identical release — 1.0.2 had a broken wheel (packaging path issue). 1.0.3 is the correct package.

---

v1.0.0 → v1.0.2

Renamed to lowercase

Package was renamed from FormaTex (with capital T) to formatex for PEP 8 compliance.

Before:

from FormaTex import FormaTexClient

After:

from formatex import FormaTexClient

---

Future Breaking Changes Policy

• Patch (1.0.x) — bug fixes, no API changes
• Minor (1.x.0) — new methods added, backwards compatible
• Major (x.0.0) — breaking changes; migration guide published here

All breaking changes announced in CHANGELOG.md.