fw-client

Name	fw-client JSON
Version	0.8.6 JSON
	download
home_page	https://gitlab.com/flywheel-io/tools/lib/fw-client
Summary	Flywheel HTTP API client.
upload_time	2024-09-17 06:02:49
maintainer	None
docs_url	None
author	Flywheel
requires_python	<4.0,>=3.8
license	MIT
keywords	flywheel api http client
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # fw-client

Flywheel HTTP API client.

## Installation

Add as a `poetry` dependency to your project:

```bash
poetry add fw-client
```

## Usage

```python
from fw_client import FWClient

fw = FWClient(
    api_key="site.flywheel.io:699uxdIh2wmqtdDyLJ",
    client_name="my-app",
    client_version="1.0",
)
projects = fw.get("/api/projects")
project_labels = [proj.label for proj in projects]
```

## Development

Install the project using `poetry` and enable `pre-commit`:

```bash
poetry install
pre-commit install
```

## License

[![MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/flywheel-io/tools/lib/fw-client",
    "name": "fw-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "Flywheel, API, HTTP, client",
    "author": "Flywheel",
    "author_email": "support@flywheel.io",
    "download_url": null,
    "platform": null,
    "description": "# fw-client\n\nFlywheel HTTP API client.\n\n## Installation\n\nAdd as a `poetry` dependency to your project:\n\n```bash\npoetry add fw-client\n```\n\n## Usage\n\n```python\nfrom fw_client import FWClient\n\nfw = FWClient(\n    api_key=\"site.flywheel.io:699uxdIh2wmqtdDyLJ\",\n    client_name=\"my-app\",\n    client_version=\"1.0\",\n)\nprojects = fw.get(\"/api/projects\")\nproject_labels = [proj.label for proj in projects]\n```\n\n## Development\n\nInstall the project using `poetry` and enable `pre-commit`:\n\n```bash\npoetry install\npre-commit install\n```\n\n## License\n\n[![MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Flywheel HTTP API client.",
    "version": "0.8.6",
    "project_urls": {
        "Documentation": "https://gitlab.com/flywheel-io/tools/lib/fw-client",
        "Homepage": "https://gitlab.com/flywheel-io/tools/lib/fw-client",
        "Repository": "https://gitlab.com/flywheel-io/tools/lib/fw-client"
    },
    "split_keywords": [
        "flywheel",
        " api",
        " http",
        " client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d3faee139bd1ca01574058ad1d207cb762d7f407b2574e53a61d9a3136fc7fc",
                "md5": "da26e720f505ee8199c8f985a1b7b9d5",
                "sha256": "7297562451cbed89f38af6a8457600479f322cbf2be6bf177471b5f631128968"
            },
            "downloads": -1,
            "filename": "fw_client-0.8.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "da26e720f505ee8199c8f985a1b7b9d5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 15881,
            "upload_time": "2024-09-17T06:02:49",
            "upload_time_iso_8601": "2024-09-17T06:02:49.202437Z",
            "url": "https://files.pythonhosted.org/packages/9d/3f/aee139bd1ca01574058ad1d207cb762d7f407b2574e53a61d9a3136fc7fc/fw_client-0.8.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-17 06:02:49",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "flywheel-io",
    "gitlab_project": "tools",
    "lcname": "fw-client"
}