HALchemy

Name	HALchemy JSON
Version	0.2.2 JSON
	download
home_page	https://github.com/pointw-dev/HALchemy
Summary	Toolkit for creating clients of HAL based Hypermedia APIs.
upload_time	2024-02-01 00:21:50
maintainer
docs_url	None
author	Michael Ottoson
requires_python
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # HALchemy for Python
**HAL-based Hypermedia API clients for humans.**

![](https://github.com/pointw-dev/HALchemy/blob/main/img/halchemy-full-word.png?raw=True)

![](https://github.com/pointw-dev/HALchemy/blob/main/img/python.png?raw=True)


> This project has lofty goals, and is in its very early stages.  Please use with caution and beware of breaking changes until at least v0.7.0



## Getting started

```bash
pip install halchemy
```

In your code, instantiate an `Api` object with the base URL of your API

```python
from halchemy import Api

api = Api('http://example.org/api')

root = api.get()                           # get the root resource
people = api.get_from_rel(root, 'people')  # follow the people rel to get the list of people
```

(more docs coming)

## Methods

* **get**(self, url='/')
* **get_from_rel**(self, resource, rel='self', parameters={}, template={})
* **get_from_rel_with_lookup**(self, resource, rel, lookup, parameters={})
* **post_to_rel**(self, resource, rel, data, parameters={}, template={})
* **patch_resource**(self, resource, data)
* **put_to_rel**(self, resource, data, rel='self')
* **delete_url**(self, url)
* **delete_resource**(self, resource)
* **url_from_rel**(resource, rel, parameters={}, template={})
* **post_to_url**(self, url, data)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pointw-dev/HALchemy",
    "name": "HALchemy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Michael Ottoson",
    "author_email": "michael@pointw.com",
    "download_url": "",
    "platform": null,
    "description": "# HALchemy for Python\r\n**HAL-based Hypermedia API clients for humans.**\r\n\r\n![](https://github.com/pointw-dev/HALchemy/blob/main/img/halchemy-full-word.png?raw=True)\r\n\r\n![](https://github.com/pointw-dev/HALchemy/blob/main/img/python.png?raw=True)\r\n\r\n\r\n> This project has lofty goals, and is in its very early stages.  Please use with caution and beware of breaking changes until at least v0.7.0\r\n\r\n\r\n\r\n## Getting started\r\n\r\n```bash\r\npip install halchemy\r\n```\r\n\r\nIn your code, instantiate an `Api` object with the base URL of your API\r\n\r\n```python\r\nfrom halchemy import Api\r\n\r\napi = Api('http://example.org/api')\r\n\r\nroot = api.get()                           # get the root resource\r\npeople = api.get_from_rel(root, 'people')  # follow the people rel to get the list of people\r\n```\r\n\r\n(more docs coming)\r\n\r\n## Methods\r\n\r\n* **get**(self, url='/')\r\n* **get_from_rel**(self, resource, rel='self', parameters={}, template={})\r\n* **get_from_rel_with_lookup**(self, resource, rel, lookup, parameters={})\r\n* **post_to_rel**(self, resource, rel, data, parameters={}, template={})\r\n* **patch_resource**(self, resource, data)\r\n* **put_to_rel**(self, resource, data, rel='self')\r\n* **delete_url**(self, url)\r\n* **delete_resource**(self, resource)\r\n* **url_from_rel**(resource, rel, parameters={}, template={})\r\n* **post_to_url**(self, url, data)\r\n\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Toolkit for creating clients of HAL based Hypermedia APIs.",
    "version": "0.2.2",
    "project_urls": {
        "Homepage": "https://github.com/pointw-dev/HALchemy"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2b9e235beb9b72c28023a4c855ab30830d2fc4b36446252d0927b8396488a806",
                "md5": "969e1bcd1108d6be52276350852d4614",
                "sha256": "817d2a14d4dc7480d91dad4b6ae4e14e10626c7c24ddf06190385311d3bebe10"
            },
            "downloads": -1,
            "filename": "HALchemy-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "969e1bcd1108d6be52276350852d4614",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5616,
            "upload_time": "2024-02-01T00:21:50",
            "upload_time_iso_8601": "2024-02-01T00:21:50.588212Z",
            "url": "https://files.pythonhosted.org/packages/2b/9e/235beb9b72c28023a4c855ab30830d2fc4b36446252d0927b8396488a806/HALchemy-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-01 00:21:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pointw-dev",
    "github_project": "HALchemy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "halchemy"
}