# pyaftership
[](https://codecov.io/gh/ludeeus/pyaftership)
[](https://pypi.org/project/pyaftership)
_Async Python wrapper for the AfterShip API_
## Installation
```bash
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.
```python
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
Raw data
{
"_id": null,
"home_page": "https://github.com/ludeeus/pyaftership",
"name": "pyaftership",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ludeeus",
"author_email": "hi@ludeeus.dev",
"download_url": "https://files.pythonhosted.org/packages/c8/27/67ef631c7fb50934dfe946aedcd75c3f2af60fe58a1e881511440fc3d94a/pyaftership-23.1.0.tar.gz",
"platform": null,
"description": "# pyaftership\n\n[](https://codecov.io/gh/ludeeus/pyaftership)\n\n[](https://pypi.org/project/pyaftership)\n\n\n_Async Python wrapper for the AfterShip API_\n\n## Installation\n\n```bash\npython3 -m pip install pyaftership\n```\n\n## Example usage\n\nHere is an example of what you can do, more examples can be found in the `tests` directory.\n\n```python\nimport asyncio\nimport aiohttp\nfrom pyaftership import AfterShip\n\nAPI_KEY = 'XXXXXXXX0000000000XXXXXXXX0000000XXXXX000'\n\n\nasync def example():\n \"\"\"Get trackings.\"\"\"\n async with aiohttp.ClientSession() as session:\n aftership = AfterShip(API_KEY, session)\n trackings = await aftership.trackings.list()\n print(\"Pending trackings:\", trackings[\"trackings\"])\n\nasyncio.get_event_loop().run_until_complete(example())\n```\n\n## Contribute\n\n**All** contributions are welcome!\n\n1. Fork the repository\n2. Clone the repository locally and open the devcontainer or use GitHub codespaces\n3. Do your changes\n4. Lint the files with `scripts/lint`\n5. Ensure all tests passes with `scripts/test`\n6. Ensure 100% coverage with `scripts/coverage`\n7. Commit your work, and push it to GitHub\n8. Create a PR against the `main` branch\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Async Python wrapper for the AfterShip API.",
"version": "23.1.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "395494cb3fabeeccc842d4dd14ccab7731dedc8528c28418eab6ac27c3eba44b",
"md5": "72b7e28097d26a8e822a18bdd1145dc4",
"sha256": "316e4331f3ac28fd6eb144f72a253352b2092d3aa73ef2179c74511cfef98d96"
},
"downloads": -1,
"filename": "pyaftership-23.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72b7e28097d26a8e822a18bdd1145dc4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5925,
"upload_time": "2023-01-28T16:41:12",
"upload_time_iso_8601": "2023-01-28T16:41:12.117522Z",
"url": "https://files.pythonhosted.org/packages/39/54/94cb3fabeeccc842d4dd14ccab7731dedc8528c28418eab6ac27c3eba44b/pyaftership-23.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c82767ef631c7fb50934dfe946aedcd75c3f2af60fe58a1e881511440fc3d94a",
"md5": "fd0ec94c660806364fa17e7fa664f180",
"sha256": "b1438bb40590c6528ef2dfaacf92e491f23efaecf119e3ecae5b0f9b4d863956"
},
"downloads": -1,
"filename": "pyaftership-23.1.0.tar.gz",
"has_sig": false,
"md5_digest": "fd0ec94c660806364fa17e7fa664f180",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4437,
"upload_time": "2023-01-28T16:41:13",
"upload_time_iso_8601": "2023-01-28T16:41:13.705725Z",
"url": "https://files.pythonhosted.org/packages/c8/27/67ef631c7fb50934dfe946aedcd75c3f2af60fe58a1e881511440fc3d94a/pyaftership-23.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-28 16:41:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ludeeus",
"github_project": "pyaftership",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "pyaftership"
}
JSON
