chift


Namechift JSON
Version 0.3.11 PyPI version JSON
download
home_pageNone
SummaryChift API client
upload_time2025-08-13 10:34:44
maintainerNone
docs_urlNone
authorHenry Hertoghe
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Chift Python Library

[![pypi](https://img.shields.io/pypi/v/chift.svg)](https://pypi.python.org/pypi/chift)
[![Build Status](https://github.com/chift-oneapi/chift-python-sdk/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/chift-oneapi/chift-python-sdk/actions?query=branch:main)
[![Coverage Status](https://coveralls.io/repos/github/chift-oneapi/chift-python-sdk/badge.svg?branch=main)](https://coveralls.io/github/chift-oneapi/chift-python-sdk?branch=master)


The Chift Python library provides convenient access to the Chift API from
applications written in the Python language.

## Documentation

See the [API docs](https://chift.stoplight.io/docs/chift-api/intro).

## Installation

You don't need this source code unless you want to modify the package. If you just
want to use the package, just run:

```sh
pip install --upgrade chift
```

Install from source with:

```sh
python setup.py install
```

### Requirements

- Python 3.9+

## Usage

```python
import chift

chift.client_secret = "Spht8g8zMYWHTRaT1Qwy"
chift.client_id = "pZMQxOJJ6tl1716"
chift.account_id = "a8bfa890-e7ab-480f-9ae1-4c685f2a2a76"
chift.url_base = "http://chift.localhost:8000" # for development

# get a consumer
consumer = chift.Consumer.get("0e260397-997e-4791-a674-90ff6dab7caa")

# get all products
products = consumer.invoicing.Product.all(limit=2)

# get one products
product = consumer.invoicing.Product.get("PRD_3789488")

# print the product name
print(product.name)
```

## Development

Set up the development env:

```sh
make
```

Run all tests:

```sh
make test
```

Run the formatter:

```sh
make fmt
```


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "chift",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Henry Hertoghe",
    "author_email": "henry.hertoghe@chift.eu",
    "download_url": "https://files.pythonhosted.org/packages/fc/85/cfe992532515eda5ac75b8df83e7e7dc1b7cd6b7b635208c33caedd895a2/chift-0.3.11.tar.gz",
    "platform": null,
    "description": "# Chift Python Library\n\n[![pypi](https://img.shields.io/pypi/v/chift.svg)](https://pypi.python.org/pypi/chift)\n[![Build Status](https://github.com/chift-oneapi/chift-python-sdk/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/chift-oneapi/chift-python-sdk/actions?query=branch:main)\n[![Coverage Status](https://coveralls.io/repos/github/chift-oneapi/chift-python-sdk/badge.svg?branch=main)](https://coveralls.io/github/chift-oneapi/chift-python-sdk?branch=master)\n\n\nThe Chift Python library provides convenient access to the Chift API from\napplications written in the Python language.\n\n## Documentation\n\nSee the [API docs](https://chift.stoplight.io/docs/chift-api/intro).\n\n## Installation\n\nYou don't need this source code unless you want to modify the package. If you just\nwant to use the package, just run:\n\n```sh\npip install --upgrade chift\n```\n\nInstall from source with:\n\n```sh\npython setup.py install\n```\n\n### Requirements\n\n- Python 3.9+\n\n## Usage\n\n```python\nimport chift\n\nchift.client_secret = \"Spht8g8zMYWHTRaT1Qwy\"\nchift.client_id = \"pZMQxOJJ6tl1716\"\nchift.account_id = \"a8bfa890-e7ab-480f-9ae1-4c685f2a2a76\"\nchift.url_base = \"http://chift.localhost:8000\" # for development\n\n# get a consumer\nconsumer = chift.Consumer.get(\"0e260397-997e-4791-a674-90ff6dab7caa\")\n\n# get all products\nproducts = consumer.invoicing.Product.all(limit=2)\n\n# get one products\nproduct = consumer.invoicing.Product.get(\"PRD_3789488\")\n\n# print the product name\nprint(product.name)\n```\n\n## Development\n\nSet up the development env:\n\n```sh\nmake\n```\n\nRun all tests:\n\n```sh\nmake test\n```\n\nRun the formatter:\n\n```sh\nmake fmt\n```\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Chift API client",
    "version": "0.3.11",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e731c8595b187df37d727b3470724925c4b9c0189a49d2d3e69de0be8b395780",
                "md5": "3f1f15df0dde298257646e23f8b52b3e",
                "sha256": "ae7d30cea0ed837b92413b85a4ab263af35b769441b673f013fd94802a34ced5"
            },
            "downloads": -1,
            "filename": "chift-0.3.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3f1f15df0dde298257646e23f8b52b3e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 114098,
            "upload_time": "2025-08-13T10:34:43",
            "upload_time_iso_8601": "2025-08-13T10:34:43.087682Z",
            "url": "https://files.pythonhosted.org/packages/e7/31/c8595b187df37d727b3470724925c4b9c0189a49d2d3e69de0be8b395780/chift-0.3.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "fc85cfe992532515eda5ac75b8df83e7e7dc1b7cd6b7b635208c33caedd895a2",
                "md5": "d0b88a1d80b5c24e2ec1f25919c1e8f1",
                "sha256": "9009060ba24e7d91dcce69846054788f93c28103a2646495f0398e23e8a27387"
            },
            "downloads": -1,
            "filename": "chift-0.3.11.tar.gz",
            "has_sig": false,
            "md5_digest": "d0b88a1d80b5c24e2ec1f25919c1e8f1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 102247,
            "upload_time": "2025-08-13T10:34:44",
            "upload_time_iso_8601": "2025-08-13T10:34:44.375708Z",
            "url": "https://files.pythonhosted.org/packages/fc/85/cfe992532515eda5ac75b8df83e7e7dc1b7cd6b7b635208c33caedd895a2/chift-0.3.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-13 10:34:44",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "chift"
}
        
Elapsed time: 1.31828s