hebe-api


Namehebe-api JSON
Version 1.0.2 PyPI version JSON
download
home_pageNone
SummaryUnofficial library for programmatic access to your Hebe account and your orders
upload_time2024-04-03 08:51:04
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords hebe hebe api hebe-api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Hebe API

[![Test](https://github.com/tomek7667/Hebe-API-python/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/tomek7667/Hebe-API-python/actions/workflows/test.yml)
Unofficial library for programmatic access to your Hebe account and your orders.

```
pip3 install hebe-api
```

## Usage:

### Obtaining Hebe security token

```python
from hebe_api import Hebe

hebe = Hebe("HEBE_USERNAME", "HEBE_PASSWORD")
hebe.authenticate()
print(hebe.token)
# T2a...................
```

or

```python
from hebe_api import Hebe

hebe = Hebe()
hebe.authenticate("HEBE_USERNAME", "HEBE_PASSWORD")
print(hebe.token)
# E9U...................
```

### Obtaining user orders

```python
# Default values are as follows:
orders = hebe.get_orders(start=0, max_orders=100)

# order attributes
order = orders[0]
order.id # str
order.position # int (index in the array, used for retrieving the order products)
order.date # str
order.price # float
order.price_str # str
order.packs # int
```

### Obtaining products of particular order

```python
# Default values are as follows:
products = hebe.get_order_products(order)

# product attributes
product = products[0]
product.title # str
product.subtitle # str
product.total_price_str # str
product.package_price_str # str
product.total_price # float
product.package_price # float
product.quantity # int
```

### Obtaining all products

```python
# Default values are as follows:
all_products = hebe.get_all_products(max_orders=100)
```

## Roadmap

-   polish API supporting:
    -   [x] auth
    -   [x] get orders
    -   [x] get products
-   `.com` hebe API support
    -   [ ] auth
    -   [ ] get orders
    -   [ ] get products

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "hebe-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "hebe, hebe api, hebe-api",
    "author": null,
    "author_email": "tomek7667 <hebeapi@cyber-man.pl>",
    "download_url": "https://files.pythonhosted.org/packages/a4/fd/8bae328d056228ab8e6d0873ad0a56c2b656ada6c6df7e7c652892a29a8a/hebe-api-1.0.2.tar.gz",
    "platform": null,
    "description": "# Hebe API\n\n[![Test](https://github.com/tomek7667/Hebe-API-python/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/tomek7667/Hebe-API-python/actions/workflows/test.yml)\nUnofficial library for programmatic access to your Hebe account and your orders.\n\n```\npip3 install hebe-api\n```\n\n## Usage:\n\n### Obtaining Hebe security token\n\n```python\nfrom hebe_api import Hebe\n\nhebe = Hebe(\"HEBE_USERNAME\", \"HEBE_PASSWORD\")\nhebe.authenticate()\nprint(hebe.token)\n# T2a...................\n```\n\nor\n\n```python\nfrom hebe_api import Hebe\n\nhebe = Hebe()\nhebe.authenticate(\"HEBE_USERNAME\", \"HEBE_PASSWORD\")\nprint(hebe.token)\n# E9U...................\n```\n\n### Obtaining user orders\n\n```python\n# Default values are as follows:\norders = hebe.get_orders(start=0, max_orders=100)\n\n# order attributes\norder = orders[0]\norder.id # str\norder.position # int (index in the array, used for retrieving the order products)\norder.date # str\norder.price # float\norder.price_str # str\norder.packs # int\n```\n\n### Obtaining products of particular order\n\n```python\n# Default values are as follows:\nproducts = hebe.get_order_products(order)\n\n# product attributes\nproduct = products[0]\nproduct.title # str\nproduct.subtitle # str\nproduct.total_price_str # str\nproduct.package_price_str # str\nproduct.total_price # float\nproduct.package_price # float\nproduct.quantity # int\n```\n\n### Obtaining all products\n\n```python\n# Default values are as follows:\nall_products = hebe.get_all_products(max_orders=100)\n```\n\n## Roadmap\n\n-   polish API supporting:\n    -   [x] auth\n    -   [x] get orders\n    -   [x] get products\n-   `.com` hebe API support\n    -   [ ] auth\n    -   [ ] get orders\n    -   [ ] get products\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Unofficial library for programmatic access to your Hebe account and your orders",
    "version": "1.0.2",
    "project_urls": {
        "Bug Reports": "https://github.com/tomek7667/Hebe-API-python/issues",
        "Homepage": "https://github.com/tomek7667/Hebe-API-python",
        "Source": "https://github.com/tomek7667/Hebe-API-python"
    },
    "split_keywords": [
        "hebe",
        " hebe api",
        " hebe-api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b1edeec48be5d6b0c0dcbed251dc68f266322a94486739242f7e6404a5380150",
                "md5": "f459b16cfffa863bfcf1a54021f30f15",
                "sha256": "00b659545d9405239b40910aee381eb1a3dae9c01e545b58d1124491b89484b5"
            },
            "downloads": -1,
            "filename": "hebe_api-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f459b16cfffa863bfcf1a54021f30f15",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 5361,
            "upload_time": "2024-04-03T08:51:03",
            "upload_time_iso_8601": "2024-04-03T08:51:03.677658Z",
            "url": "https://files.pythonhosted.org/packages/b1/ed/eec48be5d6b0c0dcbed251dc68f266322a94486739242f7e6404a5380150/hebe_api-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4fd8bae328d056228ab8e6d0873ad0a56c2b656ada6c6df7e7c652892a29a8a",
                "md5": "296e59dd4bfd8f048f1659a506ee1b88",
                "sha256": "6864eb59a1418780e72bb1e666b2f83d12c766aeb7a7948279f6271517582c66"
            },
            "downloads": -1,
            "filename": "hebe-api-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "296e59dd4bfd8f048f1659a506ee1b88",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 6969,
            "upload_time": "2024-04-03T08:51:04",
            "upload_time_iso_8601": "2024-04-03T08:51:04.706169Z",
            "url": "https://files.pythonhosted.org/packages/a4/fd/8bae328d056228ab8e6d0873ad0a56c2b656ada6c6df7e7c652892a29a8a/hebe-api-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-03 08:51:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tomek7667",
    "github_project": "Hebe-API-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "hebe-api"
}
        
Elapsed time: 0.26614s