Metadata-Version: 2.4
Name: parcel-tracker-sdk
Version: 0.2.0
Summary: Python SDK for the ParcelTracker API
Author-email: Parcel Tracker Dev Team <support@parceltracker.com>
Maintainer-email: Parcel Tracker Dev Team <support@parceltracker.com>
License-Expression: MIT
Project-URL: Homepage, https://parceltracker.com
Keywords: parceltracker,sdk,api
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
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: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.25.0
Requires-Dist: pydantic>=1.8.0
Requires-Dist: typing-extensions>=3.7.4
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
Requires-Dist: mypy>=0.900; extra == "dev"
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: isort>=5.10.0; extra == "dev"
Requires-Dist: flake8>=4.0.0; extra == "dev"
Requires-Dist: pre-commit>=2.0.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=5.0.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
Requires-Dist: myst-parser>=0.18.0; extra == "docs"
Dynamic: license-file

# 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

```bash
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:

```bash
./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

```bash
source .venv/bin/activate
```



## 🛠️ Development Commands

### Run Tests

```bash
pytest tests/ -v
```

### Run Type Checking

```bash
mypy src/parcel_tracker_sdk/
```

### Format Code

```bash
black src/parcel_tracker_sdk/
isort src/parcel_tracker_sdk/
```

### Lint Code

```bash
flake8 src/parcel_tracker_sdk/
```

### Run Pre-commit Hooks

```bash
pre-commit run --all-files
```

## 📦 Building and Packaging

### Install in Development Mode

```bash
pip install -e ".[dev]"
```

### Build Distribution Packages

```bash
python -m build
```

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

### Install from Built Package

```bash
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
