|
1 | | -Metadata-Version: 2.1 |
| 1 | +Metadata-Version: 2.4 |
2 | 2 | Name: shipthisapi-python |
3 | | -Version: 0.1.1 |
4 | | -Summary: ShipthisAPI utility package |
| 3 | +Version: 3.0.2 |
| 4 | +Summary: ShipthisAPI async utility package |
5 | 5 | Home-page: https://github.com/shipthisco/shipthisapi-python |
6 | 6 | Author: Mayur Rawte |
7 | 7 | Author-email: mayur@shipthis.co |
8 | | -License: UNKNOWN |
9 | | -Platform: UNKNOWN |
10 | 8 | Classifier: Programming Language :: Python :: 3 |
11 | 9 | Classifier: License :: OSI Approved :: MIT License |
12 | 10 | Classifier: Operating System :: OS Independent |
13 | 11 | Description-Content-Type: text/markdown |
| 12 | +Requires-Dist: httpx>=0.24.0 |
| 13 | +Dynamic: author |
| 14 | +Dynamic: author-email |
| 15 | +Dynamic: classifier |
| 16 | +Dynamic: description |
| 17 | +Dynamic: description-content-type |
| 18 | +Dynamic: home-page |
| 19 | +Dynamic: requires-dist |
| 20 | +Dynamic: summary |
| 21 | + |
| 22 | +# ShipthisAPI Python |
| 23 | + |
| 24 | +[](https://badge.fury.io/py/shipthisapi-python) |
| 25 | + |
| 26 | +A Python wrapper package for ShipthisAPI for making api calls using python. |
| 27 | + |
| 28 | + |
| 29 | +Features |
| 30 | +-------- |
| 31 | + |
| 32 | +* Demo setup with ``demo.py`` |
| 33 | +* Simple Step API calls. |
| 34 | + |
| 35 | +Quickstart |
| 36 | +---------- |
| 37 | + |
| 38 | + |
| 39 | +Install the latest `shipthisapi-python` |
| 40 | +if you haven't installed it yet. |
| 41 | + |
| 42 | + |
| 43 | + pip install shipthisapi-python |
| 44 | + |
| 45 | + |
| 46 | +[Generate a API Key For your Organisation](https://shipthis.crisp.help/en/article/how-to-generate-an-api-key-1qnsq1d/?bust=1633352029281) |
| 47 | + |
| 48 | + |
| 49 | +```python |
| 50 | +from ShipthisAPI.shipthisapi import ShipthisAPI |
| 51 | + |
| 52 | +x_api_key = '<your_api_key>' |
| 53 | +organisation = 'demo' |
| 54 | +region_id='<your_region_id>' |
| 55 | +location_id='<your_location_id>' |
| 56 | + |
| 57 | + |
| 58 | +shipthisapi = ShipthisAPI(organisation=organisation, x_api_key=x_api_key, region_id=region_id, location_id=location_id) |
| 59 | + |
| 60 | + |
| 61 | +# Get Organisation/User Info |
| 62 | + |
| 63 | +print(shipthisapi.info()) |
| 64 | + |
| 65 | + |
| 66 | +# Get Invoice Collection List |
| 67 | + |
| 68 | +print(shipthisapi.get_list(collection_name='invoice')) |
| 69 | + |
| 70 | +# Get all Sea list |
| 71 | + |
| 72 | +print(shipthisapi.get_list(collection_name="sea_shipment", params={"count": 2})) |
| 73 | + |
| 74 | + |
| 75 | +``` |
| 76 | + |
| 77 | + |
| 78 | +Documentation |
| 79 | +----------- |
| 80 | + |
| 81 | +For more details related to available fields and operations check our [developer portal](https://developer.shipthis.co) |
| 82 | + |
| 83 | + |
| 84 | + Available Operations |
| 85 | + |
| 86 | +- Get Organisation / User Information |
| 87 | +- Create New Collection Entry |
| 88 | +- Update Collection |
| 89 | +- Get Collection Items |
| 90 | +- Delete an existing collection item |
| 91 | + |
| 92 | + |
| 93 | + |
| 94 | +Support |
| 95 | +------------------ |
| 96 | + |
| 97 | +If you have any queries related to usage of the api please raise a issue [here](https://github.com/shipthisco/shipthisapi-python) |
| 98 | + |
| 99 | + |
14 | 100 |
|
15 | | -UNKNOWN |
16 | 101 |
|
0 commit comments