parcel-tracker-sdk 0.2.0

Python SDK for the ParcelTracker API

ParcelTracker BE Python SDK - Setup Guide

This guide will help you set up and start using the ParcelTracker BE Python SDK.

🚀 Quick Start

1. Clone the Repository

git clone https://github.com/yourusername/parceltracker-be-python-sdk.git
cd parceltracker-be-python-sdk

2. Set Up Development Environment

Run the setup script to create a virtual environment and install dependencies:

./setup_dev.sh

This will:

• Create a virtual environment (.venv)
• Install all dependencies
• Set up pre-commit hooks
• Create necessary directories

3. Activate Virtual Environment

source .venv/bin/activate

🛠️ Development Commands

Run Tests

pytest tests/ -v

Run Type Checking

mypy src/parcel_tracker_sdk/

Format Code

black src/parcel_tracker_sdk/
isort src/parcel_tracker_sdk/

Lint Code

flake8 src/parcel_tracker_sdk/

Run Pre-commit Hooks

pre-commit run --all-files

📦 Building and Packaging

Install in Development Mode

pip install -e ".[dev]"

Build Distribution Packages

python -m build

This will create dist/ directory with wheel and sdist packages.

Install from Built Package

pip install dist/parceltracker_be_python_sdk-0.1.0-py3-none-any.whl

Publishing

See https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives