📦 📦 pplmyapi (Python PPL myAPI wrapper)
Czech PPL (Professional Parcel Logistic) API wrapper written in Python. Helps you to communicate with PPL myAPI without worring about fetching access tokens and constructing your own requests. All (hopefully) done for you in the background.
Install it from PyPI
pip install pplmyapiUsage
This is still a work in progress, so the API might change in the future. However, the basic usage is as follows:
- Create a
PPLinstance with your credentials - obtain a
RESTConnectorinstance from thePPLinstance. - use the
RESTConnectorinstance to communicate with the PPL REST API (myAPI2)
Send a package
# Create Package instance with all the required data and 6 packages in the set
package = Package(
reference_id="123456789",
package_product_type=Product.PPL_PARCEL_CZ_PRIVATE_COD,
note = "test",
recipient=Recipient(
name="John Doe",
city="Hradec Králové",
street="HlavnĂ 1",
zip_code="50001",
phone="123456789",
email="j.doe@example.com",
country = 'CZ'
),
sender=Sender(
name="Test s.r.o.",
street="TestovacĂ 55/36",
city="Praha",
zip_code="11000",
country="CZ",
),
payment_info=PaymentInfo(
cod_price=100,
cod_currency='CZK',
cod_vs='123456789',
insurance_price=100,
insurance_currency='CZK',
specific_symbol='123456',
bank_account='123456789',
bank_code='0300'
),
weighted_package_info=WeightedPackageInfo(
weight=10.22,
),
package_set=(
PackageSet(
total_packages = 6,
)
),
flags=[
PackageFlag(
code=Flag.CL,
value=True
)
],
)
# create packages
packages = [package]
#Â create rest_connector
rest_con = ppl.connector()
#Â create rest_action
response = rest_con.post_shipments(
packages=packages,
file_path = './out_test',
file_name = 'test_010223.pdf',
)Response from the API is a dictionary containing the following keys:
-
labels: base64 encoded labels from the API (all together) -
packages: list ofPackageinstances (initionaly passed to thepost_shipmentsfunction) with extendedshipment_numberattribute,label_base64attribute (with single label) and extendedpackage_setattribute (withrelated_packagesattribute containing list ofPackageinstances related to the current package with the samereference_idattribute but differentshipment_numberattribute)
Get label for a package
# TODODevelopment
If you're keen on contributing to this project, you can do so by forking this repository and creating a pull request. Please make sure to follow the PEP8 style guide.
