py-canada-post 1.0.0

Python wrapper to interact with Canada Post API.

Py-canada-post

Python written wrapper to interact with Canada Post API.

Table of contents

• Why was it created?
• How to use?
  • Essential steps
  • Quick start
    • Install from PyPi
    • Install from source
    • Getting started
• CLI
• Roadmap

Why was it created?

There is no public Python library/wrapper to interact with Canada Post API, so an idea was born and brought to life.

How to use?

Essential steps:

Before you start using this wrapper, you should perform these essential steps:

1. Create a virtual environment:

   • Using python:

     python -m venv .venv
     source .venv/bin/activate
     

   • Using uv:

     uv python pin 3.11
     uv init
     uv sync
     

2. Create .env and put your customer number, contract id and api key in there as followed:

   CUSTOMER_NUMBER=12345667
   CONTRACT_ID=12344556
   API_KEY=ewfghui34hto34ghui34g:ewghui234h23oih34uigh423
   

   To test this app, you will need some test credentials. You can get them here.

   If you would like to obtain your own, you can register your business and join the Developer Program.

Quick start

To use this wrapper, you will need 3.11+ python version and pip.

Install from PyPi

pip install py-canada-post

or

uv add py-canada-post

Install from source

1. Clone the repository:

   git clone https://github.com/joludyaster/py-canada-post.git
   

2. Run:

   pip install .
   

   or

   uv pip install .
   

Getting started

You could define the client object yourself:

import os

from py_canada_post.client import PyCanadaPost
from py_canada_post.services.rating import Destination, DomesticDestination
from dotenv import load_dotenv

load_dotenv()

customer_number = os.getenv("CUSTOMER_NUMBER", 0)
api_key = os.getenv("API_KEY", "")
contract_id = os.getenv("CONTRACT_ID", 0)

def main():
    py_canada_post_client = PyCanadaPost(
        customer_number=customer_number,
        api_key=api_key,
        contract_id=contract_id
    )
    rates = py_canada_post_client.rating.rates.get_rates(
        "E4M8S3",
        Destination(
            domestic=DomesticDestination("T3Z1C8")
        )
    )
    print(rates)

if __name__ == "__main__":
    main()

Or you could use a shortcut:

from py_canada_post.client import PyCanadaPost
from py_canada_post.services.rating import Destination, DomesticDestination

def main():
    py_canada_post_client = PyCanadaPost.from_env()
    rates = py_canada_post_client.rating.rates.get_rates(
        "E4M8S3",
        Destination(
            domestic=DomesticDestination("T3Z1C8")
        )
    )
    print(rates)

if __name__ == "__main__":
    main()

See the documentation to learn more.

CLI

Usage:
    py-canada-post [-v] [-h]
    py-canada-post rating get-rates ORIGIN-POSTAL-CODE [ARGS]
    py-canada-post rating discover-services COUNTRY-CODE [ARGS]
    
    more to come...
    
Options:
    rating          Command to contain all rating-related commands (e.g. get_rates, discover_services etc.).                                                                                                                     │
    --help (-h)     Display this message and exit.                                                                                                                                                                               │
    --version (-v)  Display application version.

See the CLI documentation to learn more.

Roadmap

• Rating

  • Get rates
  • Discover services
  • Get service
  • Get option

• Contract shipping

  • Shipping service

    • Create shipment
    • Get shipment
    • Get artifact
    • Get shipment price
    • Get shipment receipt
    • Get shipment details
    • Get shipment public key info
    • Get groups
    • Get shipments
    • Void shipment
    • Request shipment refund

  • Manifest service

    • Transmit shipments
    • Get manifest
    • Get artifact
    • Get manifest details
    • Get manifests

  • Customer information services

    • Get customer information
    • Get MOBO customer information

• Non-contract shipping

  • Create non-contract shipping
  • Get artifact
  • Get non-contract shipment receipt
  • Get non-contract shipment details
  • Get non-contract shipment public key info
  • Get non-contract shipments
  • Get non-contract shipment
  • Request non-contract shipment refund

• Tracking

  • Get tracking summary
  • Get tracking details
  • Get signature image no longer available
  • Get delivery confirmation certificate

• Find a post office

  • Get nearest post office
  • Get post office detail

• Pickup

  • Get pickup availability
  • Get pickup price
  • Create pickup request
  • Get pickup request details
  • Update pickup request
  • Cancel pickup request
  • Get pickup requests

• Returns

  • Authorized returns

    • Create authorized return
    • Get artifact

  • Open returns

    • Create open return template
    • Retrieve next open return artifact
    • Get open return template
    • Get open return template details
    • Get open return template
    • Delete open return template
    • Get open return templates