yalidine

Name	yalidine JSON
Version	0.0.3 JSON
	download
home_page	None
Summary	This package is to integrate Yalidine api easily.
upload_time	2024-08-13 22:46:50
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	MIT
keywords	yalidine livraison delivery
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Yalidine
[Yalidine](https://github.com/tarek-berkane/yalidine) a Python library that implement [Yalidine](https://yalidine.com/) `REST` API.

![alt text](images/yalidine-logo.png)

## Instaltion
```bash
pip install yalidine
```

## Usage
### Initialize client
```py
from yalidine import YalidineClient

app_id = "APP-ID"
app_token = "APP-TOKEN"

client = YalidineClient(app_id, app_token)

print(client.get_parcels())
```
### Check api limit
```python

response = client.get_parcels()
limit = client.last_response_headers
# last_response_headers include api limit status from last request
print(limit)
```


### Parcel
```py
parcel = Parcel(
    order_id="test_parcel",
    firstname="firstname",
    ... # Fill Fields
)

# create parcel
response = client.create_parcel([parcel])

# update parcel
response = client.update_parcel(parcel_id=parcel_id, data=parcel)

# delete parcel
response = client.delete_parcel(parcel_id="parcel_id")

# Get parcel 
response = client.get_parcel(parcel_id="parcel_id")

# Get parcel list
response = client.get_parcels()

# Get parcel list using filter
from yalidine.entity import ParcelFilter
response = client.get_parcels(filter=ParcelFilter(page=1))

```

### History
```python
from yalidine.entity import HistoryFilter

responce = client.get_histories(filter=HistoryFilter(page_size=2))

```

### Centers
```python
from yalidine.entity import CenterFilter

responce = client.get_centers(filter=CenterFilter(page_size=2))

```

### Wilayas
```python
from yalidine.entity import WilayasFilter

responce = client.get_wilayas(filter=WilayasFilter(page_size=2))
```

### Communes
```python
from yalidine.entity import CommunesFilter

responce = client.get_communes(filter=CommunesFilter(page_size=2))
```

#### Delivery Fees
```python
from yalidine.entity import DeliveryFeesFilter

responce = client.get_delivery_fees(filter=DeliveryFeesFilter(page_size=2))
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "yalidine",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "yalidine, livraison, delivery",
    "author": null,
    "author_email": "Berkane Tarek <tarekg320@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/2f/cc/c79d204bd1b2182b5afd7c30219a8ac978e9ed9fe0fa4c688384e94d306e/yalidine-0.0.3.tar.gz",
    "platform": null,
    "description": "# Yalidine\n[Yalidine](https://github.com/tarek-berkane/yalidine) a Python library that implement [Yalidine](https://yalidine.com/) `REST` API.\n\n![alt text](images/yalidine-logo.png)\n\n## Instaltion\n```bash\npip install yalidine\n```\n\n## Usage\n### Initialize client\n```py\nfrom yalidine import YalidineClient\n\napp_id = \"APP-ID\"\napp_token = \"APP-TOKEN\"\n\nclient = YalidineClient(app_id, app_token)\n\nprint(client.get_parcels())\n```\n### Check api limit\n```python\n\nresponse = client.get_parcels()\nlimit = client.last_response_headers\n# last_response_headers include api limit status from last request\nprint(limit)\n```\n\n\n### Parcel\n```py\nparcel = Parcel(\n    order_id=\"test_parcel\",\n    firstname=\"firstname\",\n    ... # Fill Fields\n)\n\n# create parcel\nresponse = client.create_parcel([parcel])\n\n# update parcel\nresponse = client.update_parcel(parcel_id=parcel_id, data=parcel)\n\n# delete parcel\nresponse = client.delete_parcel(parcel_id=\"parcel_id\")\n\n# Get parcel \nresponse = client.get_parcel(parcel_id=\"parcel_id\")\n\n# Get parcel list\nresponse = client.get_parcels()\n\n# Get parcel list using filter\nfrom yalidine.entity import ParcelFilter\nresponse = client.get_parcels(filter=ParcelFilter(page=1))\n\n```\n\n### History\n```python\nfrom yalidine.entity import HistoryFilter\n\nresponce = client.get_histories(filter=HistoryFilter(page_size=2))\n\n```\n\n### Centers\n```python\nfrom yalidine.entity import CenterFilter\n\nresponce = client.get_centers(filter=CenterFilter(page_size=2))\n\n```\n\n### Wilayas\n```python\nfrom yalidine.entity import WilayasFilter\n\nresponce = client.get_wilayas(filter=WilayasFilter(page_size=2))\n```\n\n### Communes\n```python\nfrom yalidine.entity import CommunesFilter\n\nresponce = client.get_communes(filter=CommunesFilter(page_size=2))\n```\n\n#### Delivery Fees\n```python\nfrom yalidine.entity import DeliveryFeesFilter\n\nresponce = client.get_delivery_fees(filter=DeliveryFeesFilter(page_size=2))\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "This package is to integrate Yalidine api easily.",
    "version": "0.0.3",
    "project_urls": null,
    "split_keywords": [
        "yalidine",
        " livraison",
        " delivery"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "010c14e060dd23201db1b19c8287a501600a7f1f31b420eeae147e324d746f47",
                "md5": "3f7a3b3f84a06ccd3b4c105c0f7a58a7",
                "sha256": "95b2c9fb32dea44e12ffde2fb6e1ee0986dc54148ac1f7613b3018ad6e113dd6"
            },
            "downloads": -1,
            "filename": "yalidine-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3f7a3b3f84a06ccd3b4c105c0f7a58a7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 6889,
            "upload_time": "2024-08-13T22:46:48",
            "upload_time_iso_8601": "2024-08-13T22:46:48.605872Z",
            "url": "https://files.pythonhosted.org/packages/01/0c/14e060dd23201db1b19c8287a501600a7f1f31b420eeae147e324d746f47/yalidine-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2fccc79d204bd1b2182b5afd7c30219a8ac978e9ed9fe0fa4c688384e94d306e",
                "md5": "9935b896b5ebacc077cab9b31c862061",
                "sha256": "3c59bbcdcdb35116e509524dab0ef26dfc2a4f1df43c931cf024e0379c8f2708"
            },
            "downloads": -1,
            "filename": "yalidine-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "9935b896b5ebacc077cab9b31c862061",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 18319,
            "upload_time": "2024-08-13T22:46:50",
            "upload_time_iso_8601": "2024-08-13T22:46:50.760750Z",
            "url": "https://files.pythonhosted.org/packages/2f/cc/c79d204bd1b2182b5afd7c30219a8ac978e9ed9fe0fa4c688384e94d306e/yalidine-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-13 22:46:50",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "yalidine"
}