Metadata-Version: 2.4
Name: shipaw
Version: 0.3.44
Summary: Shipping client
Author: pawrequest
Author-email: pawrequest <shipaw+pawrequest@users.noreply.github.com>
License-Expression: MIT
Requires-Dist: apc-hypaship>=0.1.10
Requires-Dist: pawdf>=0.1.0
Requires-Dist: royal-mail-combined>=0.0.9
Requires-Dist: pawlogger>=0.1.4
Requires-Dist: httpx>=0.28.1
Requires-Dist: pygments>=2.19.2
Requires-Dist: pydantic[email]>=2.11.9
Requires-Dist: pytest>=8.4.2
Requires-Dist: fastapi[standard]>=0.117.1
Requires-Dist: jinja2>=3.1.6
Requires-Dist: hatchling>=1.27.0
Requires-Dist: loguru>=0.7.3
Requires-Dist: thefuzz>=0.22.1
Requires-Dist: pydantic-extra-types>=2.10.5
Requires-Dist: pydantic-settings>=2.11.0
Requires-Dist: phonenumbers>=9.0.15
Requires-Dist: pywin32>=311
Requires-Dist: uvicorn>=0.37.0
Requires-Python: >=3.13
Project-URL: Homepage, https://github.com/pawrequest/shipaw
Description-Content-Type: text/markdown

# Setup

## Index env file

set environment variable 'ENV_INDEX' to an index of environment files:

- SHIPAW_ENV = Shipaw settings env file
- APC_ENV = APC settings env file

## Shipaw env file
### switches 
- SHIPPER_LIVE - set to 'true' for live mode, 'false' for test mode
- LOG_LEVEL - set to 'DEBUG', 'INFO', 'WARNING', 'ERROR' or 'CRITICAL'

### paths
- LABEL_DIR - absolute path to label download root directory
- LOG_DIR - absolute path to log file directory
- UI_DIR - absolute path to UI root directory (templates and static)

### derived paths to overwrite if necessary
- [STATIC_DIR] = UI_DIR / 'static'
- [TEMPLATE_DIR] = UI_DIR / 'templates'

### sender details
- ADDRESS_LINE1
- [ADDRESS_LINE2]
- [ADDRESS_LINE3]
- TOWN
- POSTCODE
- [COUNTRY] = 'GB'
- BUSINESS_NAME
- CONTACT_NAME
- EMAIL
- [PHONE] = MOBILE_PHONE
- MOBILE_PHONE

## APC env file

- APC_EMAIL
- APC_PASSWORD
- BASE_URL
