A Simple Python API for 17track.net
Project description
📦 py17track: A Simple Python API for 17track.net
py17track
is a simple Python library to track packages in
17track.net accounts.
Since this is uses an unofficial API, there's no guarantee that 17track.net will provide every field for every package, all the time. Additionally, this API may stop working at any moment.
Python Versions
py17track
is currently supported on:
- Python 3.5
- Python 3.6
- Python 3.7
However, running the test suite currently requires Python 3.6 or higher; tests run on Python 3.5 will fail.
Installation
pip install py17track
Usage
py17track
starts within an
aiohttp ClientSession
:
import asyncio
from aiohttp import ClientSession
from py17track import Client
async def main() -> None:
"""Create the aiohttp session and run the example."""
async with ClientSession() as websession:
# YOUR CODE HERE
asyncio.get_event_loop().run_until_complete(main())
Create a client then get to it:
import asyncio
from aiohttp import ClientSession
from py17track import Client
async def main() -> None:
"""Create the aiohttp session and run the example."""
async with ClientSession() as websession:
client = Client(websession)
# Login to 17track.net:
await client.profile.login('<EMAIL>', '<PASSWORD>')
# Get the account ID:
client.profile.account_id
# >>> 1234567890987654321
# Get a summary of the user's packages:
summary = await client.profile.summary()
# >>> {'In Transit': 3, 'Expired': 3, ... }
# Get all packages associated with a user's account:
packages = await client.profile.packages()
# >>> [py17track.package.Package(..), ...]
asyncio.get_event_loop().run_until_complete(main())
Each Package
object has the following info:
destination_country
: the country the package was shipped toinfo
: a text description of the latest statuslocation
: the current location (if known)origin_country
: the country the package was shipped frompackage_type
: the type of package (if known)status
: the overall package status ("In Transit", "Delivered", etc.)tracking_info_language
: the language of the tracking infotracking_number
: the all-important tracking number
Contributing
- Check for open features/bugs or initiate a discussion on one.
- Fork the repository.
- Install the dev environment:
make init
. - Enter the virtual environment:
pipenv shell
- Code your new feature or bug fix.
- Write a test that covers your new functionality.
- Update
README.md
with any new documentation. - Run tests and ensure 100% code coverage:
make coverage
- Ensure you have no linting errors:
make lint
- Ensure you have no typed your code correctly:
make typing
- Add yourself to
AUTHORS.md
. - Submit a pull request!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
py17track-2.0.1.tar.gz
(9.2 kB
view hashes)
Built Distribution
py17track-2.0.1-py3-none-any.whl
(11.0 kB
view hashes)
Close
Hashes for py17track-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b61b1434933866ce559ddd643b549f39296c84b045f9337677e62746b6b91a3 |
|
MD5 | 655a73d71c3d7a8f3cdd44f8e61872f6 |
|
BLAKE2b-256 | 7f976506100f0c9670398927959a15a38d6c4fbde45db38e5b969c46b053f72c |