# DSCC SDD Client
The `dscc_sdd_client` library is a client to interact with the DSCC SDD server.
Utilizing this client library is strongly advised for querying and interacting with the server, as it takes care of all the necessary tasks such as serialization, deserialization, REST API calls, and ensures the correct installation of other required libraries.
### Installation
It can be installed with the command:
```python
pip install dscc_sdd_client
```
### Examples
To see detailed examples of the library, many notebooks are available in the [client](https://github.com/dscc-admin/dscc_sdd/blob/develop/client) folder. For instance, refer to [Demo_Client_Notebook.ipynb](https://github.com/dscc-admin/dscc_sdd/blob/develop/client/Demo_Client_Notebook.ipynb).
### More detailed documentation
To see a more detailed documentation, clone the repo go to `dscc_sdd_client/client` and run:
```python
sphinx-build -M html documentation docs
```
To see the pages, go to `dscc_sdd_client/client/docs/html`, run:
```
start .\index.html
```
(in windows) and the doc page will open!
Raw data
{
"_id": null,
"home_page": "https://github.com/dscc-admin/dscc_sdd/",
"name": "dscc-sdd-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "opendp, smartnoise-sql, logger, ast",
"author": "Data Science Competence Center, Swiss Federal Statistical Office",
"author_email": "dscc@bfs.admin.ch",
"download_url": "https://files.pythonhosted.org/packages/cd/a5/9c13ecf53720bf23548b7801142b84192a9c00b550ba9a34dcaee916b112/dscc_sdd_client-0.0.3.tar.gz",
"platform": null,
"description": "# DSCC SDD Client\r\n\r\nThe `dscc_sdd_client` library is a client to interact with the DSCC SDD server.\r\n\r\nUtilizing this client library is strongly advised for querying and interacting with the server, as it takes care of all the necessary tasks such as serialization, deserialization, REST API calls, and ensures the correct installation of other required libraries.\r\n\r\n### Installation\r\nIt can be installed with the command:\r\n```python\r\npip install dscc_sdd_client\r\n```\r\n\r\n### Examples\r\nTo see detailed examples of the library, many notebooks are available in the [client](https://github.com/dscc-admin/dscc_sdd/blob/develop/client) folder. For instance, refer to [Demo_Client_Notebook.ipynb](https://github.com/dscc-admin/dscc_sdd/blob/develop/client/Demo_Client_Notebook.ipynb).\r\n\r\n\r\n### More detailed documentation\r\nTo see a more detailed documentation, clone the repo go to `dscc_sdd_client/client` and run:\r\n\r\n```python\r\nsphinx-build -M html documentation docs\r\n```\r\n\r\nTo see the pages, go to `dscc_sdd_client/client/docs/html`, run:\r\n\r\n```\r\nstart .\\index.html\r\n```\r\n(in windows) and the doc page will open!\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A client to interact with the DSCC SDD server.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/dscc-admin/dscc_sdd/"
},
"split_keywords": [
"opendp",
" smartnoise-sql",
" logger",
" ast"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cda59c13ecf53720bf23548b7801142b84192a9c00b550ba9a34dcaee916b112",
"md5": "26a98d6c2b1bcd36c1ba4399de3e7551",
"sha256": "3529ee2d94a73c4a4a8d5d791e5b0e0992ddf47aff371b04c4d7b1de6c36b8d0"
},
"downloads": -1,
"filename": "dscc_sdd_client-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "26a98d6c2b1bcd36c1ba4399de3e7551",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 4591,
"upload_time": "2024-03-27T13:07:38",
"upload_time_iso_8601": "2024-03-27T13:07:38.392253Z",
"url": "https://files.pythonhosted.org/packages/cd/a5/9c13ecf53720bf23548b7801142b84192a9c00b550ba9a34dcaee916b112/dscc_sdd_client-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 13:07:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dscc-admin",
"github_project": "dscc_sdd",
"github_not_found": true,
"lcname": "dscc-sdd-client"
}
JSON
