statsuite-lib

Name	statsuite-lib JSON
Version	0.1.4 JSON
	download
home_page	None
Summary	None
upload_time	2025-08-01 10:28:11
maintainer	None
docs_url	None
author	Sergio Pena
requires_python	<4.0,>=3.11
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # StatSuite-lib

StatSuite-lib is an opinionated library to interact with dotStatSuite components.
There is no full coverage of the APIs, it will be completed as needed.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install statsuite-lib.

```bash
pip install statsuite-lib
```

## Usage

Check the documentation, mainly the statsuite-cli repo can serve as example on how to use this library
Keycloak client must be initialized and pass to any other client requiring authentication to manage the token creation and renewal

```python
from statsuite_lib import SFSClient, KeycloakClient


OPENID_URL = "http://localhost:8080/auth/realms/demo/.well-known/openid-configuration"
KEYCLOAK_USER = 'test-admin'
KEYCLOAK_PASSWORD = 'admin'
SFS_API_KEY = 'secret'
SFS_URL = 'http://localhost:3004'

keycloak = KeycloakClient(openid_url=OPENID_URL,
                          username=KEYCLOAK_USER,
                          password=KEYCLOAK_PASSWORD)


sfs = SFSClient(sfs_url=SFS_URL, sfs_api_key=SFS_API_KEY)

id = sfs.index()

print(f"Index started with id {id}")
sfs.wait_for_reindex_to_finish(loading_id=id, tenant='default')
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "statsuite-lib",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Sergio Pena",
    "author_email": "isergiopena@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/db/b0/7b84bd0c4b1e0c633c6da0f11ebf2dfe76f1ee97279b2c82f9d89d09a9a9/statsuite_lib-0.1.4.tar.gz",
    "platform": null,
    "description": "# StatSuite-lib\n\nStatSuite-lib is an opinionated library to interact with dotStatSuite components.\nThere is no full coverage of the APIs, it will be completed as needed.\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install statsuite-lib.\n\n```bash\npip install statsuite-lib\n```\n\n## Usage\n\nCheck the documentation, mainly the statsuite-cli repo can serve as example on how to use this library\nKeycloak client must be initialized and pass to any other client requiring authentication to manage the token creation and renewal\n\n```python\nfrom statsuite_lib import SFSClient, KeycloakClient\n\n\nOPENID_URL = \"http://localhost:8080/auth/realms/demo/.well-known/openid-configuration\"\nKEYCLOAK_USER = 'test-admin'\nKEYCLOAK_PASSWORD = 'admin'\nSFS_API_KEY = 'secret'\nSFS_URL = 'http://localhost:3004'\n\nkeycloak = KeycloakClient(openid_url=OPENID_URL,\n                          username=KEYCLOAK_USER,\n                          password=KEYCLOAK_PASSWORD)\n\n\nsfs = SFSClient(sfs_url=SFS_URL, sfs_api_key=SFS_API_KEY)\n\nid = sfs.index()\n\nprint(f\"Index started with id {id}\")\nsfs.wait_for_reindex_to_finish(loading_id=id, tenant='default')\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first\nto discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.1.4",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f02798aaffe508be2121de9833180c502ae9943f90a06d7928190d02d36414ed",
                "md5": "1bda53987122dd6512f01256a101ac8a",
                "sha256": "3f563fde4daa6887bbb4c74ac0d5eb8783bc5d0fb5f35df52a15a019dde2f98d"
            },
            "downloads": -1,
            "filename": "statsuite_lib-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1bda53987122dd6512f01256a101ac8a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 12794,
            "upload_time": "2025-08-01T10:28:10",
            "upload_time_iso_8601": "2025-08-01T10:28:10.086005Z",
            "url": "https://files.pythonhosted.org/packages/f0/27/98aaffe508be2121de9833180c502ae9943f90a06d7928190d02d36414ed/statsuite_lib-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "dbb07b84bd0c4b1e0c633c6da0f11ebf2dfe76f1ee97279b2c82f9d89d09a9a9",
                "md5": "feb8b0eb6e1b099929140cf51f37d18b",
                "sha256": "97d7846b63480fb04e016f5947a250f545d472f24309087bcfc7e6ecba163a21"
            },
            "downloads": -1,
            "filename": "statsuite_lib-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "feb8b0eb6e1b099929140cf51f37d18b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 8892,
            "upload_time": "2025-08-01T10:28:11",
            "upload_time_iso_8601": "2025-08-01T10:28:11.128569Z",
            "url": "https://files.pythonhosted.org/packages/db/b0/7b84bd0c4b1e0c633c6da0f11ebf2dfe76f1ee97279b2c82f9d89d09a9a9/statsuite_lib-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-01 10:28:11",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "statsuite-lib"
}