Skip to main content

Async Python wrapper for the AfterShip API.

Project description

pyaftership

codecov python version PyPI Actions

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 make black
  5. Ensure all tests passes with make test
  6. Ensure 100% coverage with make coverage
  7. Commit your work, and push it to GitHub
  8. Create a PR against the main branch

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyaftership-21.11.0.tar.gz (4.4 kB view hashes)

Uploaded Source

Built Distribution

pyaftership-21.11.0-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page