# fixinventoryclient-python
Python client for Fix Inventory
## Installation
```bash
pip install fixinventoryclient
```
For GraphVis and Pandas support:
```bash
pip install fixinventoryclient[extras]
```
## Usage
```python
from fixclient import FixInventoryClient
client = FixInventoryClient(url="https://localhost:8900", psk="changeme")
instances_csv = client.cli_execute("search is(instance) | tail 5 | list --csv")
for instance in instances_csv:
print(instance)
```
### Pandas Dataframes
```python
df = client.dataframe("is(instance)")
```
### GraphViz Digraph
```python
graph = client.graphviz("is(graph_root) -->")
```
## Test
The tests expect a FixCore on localhost with the default PSK `changeme`.
You can start it locally via:
```bash
$> fixcore --graphdb-database fixclient_test --psk changeme
```
A local test environment is required. See the [contribution guide](https://fix.com/docs/contributing/components) for instructions.
When the virtual environment is available, use those commands to set up the project and run the tests:
```bash
$> pip install --upgrade pip poetry nox nox-poetry
$> nox
```
For more examples see the examples directory.
## Publish
- bump the version number in pyproject.toml
- `poetry build`
- `poetry publish`
Raw data
{
"_id": null,
"home_page": "https://github.com/someengineering/fixinventoryclient-python",
"name": "fixinventoryclient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Some Engineering Inc.",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/a5/37/35f542963b1663ba008c98fe1fe04ad5e0410778c682294c0c4cafc8a984/fixinventoryclient-2.0.0.tar.gz",
"platform": null,
"description": "# fixinventoryclient-python\nPython client for Fix Inventory\n\n## Installation\n```bash\npip install fixinventoryclient\n```\n\nFor GraphVis and Pandas support:\n\n```bash\npip install fixinventoryclient[extras]\n```\n\n## Usage\n\n```python\nfrom fixclient import FixInventoryClient\n\nclient = FixInventoryClient(url=\"https://localhost:8900\", psk=\"changeme\")\ninstances_csv = client.cli_execute(\"search is(instance) | tail 5 | list --csv\")\n\nfor instance in instances_csv:\n print(instance)\n```\n\n### Pandas Dataframes\n```python\ndf = client.dataframe(\"is(instance)\")\n```\n\n### GraphViz Digraph\n```python\ngraph = client.graphviz(\"is(graph_root) -->\")\n```\n\n## Test\nThe tests expect a FixCore on localhost with the default PSK `changeme`.\nYou can start it locally via:\n\n```bash\n$> fixcore --graphdb-database fixclient_test --psk changeme\n```\n\nA local test environment is required. See the [contribution guide](https://fix.com/docs/contributing/components) for instructions.\nWhen the virtual environment is available, use those commands to set up the project and run the tests:\n\n```bash\n$> pip install --upgrade pip poetry nox nox-poetry\n$> nox\n```\n\nFor more examples see the examples directory.\n\n## Publish\n- bump the version number in pyproject.toml\n- `poetry build`\n- `poetry publish`\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Fix Inventory Python client library",
"version": "2.0.0",
"project_urls": {
"Changelog": "https://github.com/someengineering/fixinventoryclient-python/releases",
"Homepage": "https://github.com/someengineering/fixinventoryclient-python",
"Repository": "https://github.com/someengineering/fixinventoryclient-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7c2b4a5ba0a4e3c92da7ebd809a39bded2799303a1b7eb46bebbdda7b11650dd",
"md5": "6eb2c83babd980e55ae42aa05319908e",
"sha256": "c8ee73e0e77ce464dfe1b1328c4b10bf07d3ed6a03c21595961d3472cb64ffed"
},
"downloads": -1,
"filename": "fixinventoryclient-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6eb2c83babd980e55ae42aa05319908e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 24918,
"upload_time": "2024-02-27T10:07:26",
"upload_time_iso_8601": "2024-02-27T10:07:26.168326Z",
"url": "https://files.pythonhosted.org/packages/7c/2b/4a5ba0a4e3c92da7ebd809a39bded2799303a1b7eb46bebbdda7b11650dd/fixinventoryclient-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a53735f542963b1663ba008c98fe1fe04ad5e0410778c682294c0c4cafc8a984",
"md5": "75325cd71e27fa0d97d0d50d62c353f7",
"sha256": "e293843481231050ea23aaba43a874dd3a2e6fed59d5c8f5577e90d0d6bce037"
},
"downloads": -1,
"filename": "fixinventoryclient-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "75325cd71e27fa0d97d0d50d62c353f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 21243,
"upload_time": "2024-02-27T10:07:27",
"upload_time_iso_8601": "2024-02-27T10:07:27.275209Z",
"url": "https://files.pythonhosted.org/packages/a5/37/35f542963b1663ba008c98fe1fe04ad5e0410778c682294c0c4cafc8a984/fixinventoryclient-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 10:07:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "someengineering",
"github_project": "fixinventoryclient-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fixinventoryclient"
}
JSON
