pyaftership

pyaftership

Async Python wrapper for the AfterShip API

Installation

python3 -m pip install pyaftership

Example usage

Here is an example of what you can do, more examples can be found in the tests directory.

import asyncio
import aiohttp
from pyaftership import AfterShip

API_KEY = 'XXXXXXXX0000000000XXXXXXXX0000000XXXXX000'


async def example():
    """Get trackings."""
    async with aiohttp.ClientSession() as session:
        aftership = AfterShip(API_KEY, session)
        trackings = await aftership.trackings.list()
        print("Pending trackings:", trackings["trackings"])

asyncio.get_event_loop().run_until_complete(example())

Contribute

All contributions are welcome!

1. Fork the repository
2. Clone the repository locally and open the devcontainer or use GitHub codespaces
3. Do your changes
4. Lint the files with scripts/lint
5. Ensure all tests passes with scripts/test
6. Ensure 100% coverage with scripts/coverage
7. Commit your work, and push it to GitHub
8. Create a PR against the main branch