[](https://gitdev.digdeo.fr/digdeo-projets-floss1/digdeo-syspass-client/-/commits/master) [](https://gitdev.digdeo.fr/digdeo-projets-floss1/digdeo-syspass-client/-/commits/master)
# digdeo-syspass-client
Python API Client for SysPass server (https://www.syspass.org/en)
### Implemented API
Both 100% Cover and 100% UnitTested
* 3.0: https://syspass-doc.readthedocs.io/en/3.0/
* 3.1: https://syspass-doc.readthedocs.io/en/3.1/
### Cool but what i need to use it ?
The API Client require settings like the server and token ;)
It have many ways to inject that setting, via config file and/or by ENV vars.
### Permanent configuration::
That is suppose to be the default setting , where a file ``config.yml`` is store in user space.
That standard is describe on FreeDedktop web site. https://specifications.freedesktop.org/basedir-spec/basedir-spec-0.6.html
Then by follow recommendation and standard we use ``$HOME/.config/digdeo-syspass-client/`` as default directory for search ``config.yml`` file.
You can change the ``$XDG_CONFIG_HOME/digdeo-syspass-client/config.yml`` search by set a ENV var **syspass_config_dir** then
``$HOME/.config/digdeo-syspass-client/config.yml`` will become ``$syspass_config_dir/config.yml``
For more information's take a look on FreeDesktop XDG recommendation.
### Config file
You can use any type of key here, in our usage that is a Read Only key.
```
syspassclient:
api_url: 'https://you.server.exemple.com/api.php'
api_version: '3.1'
authToken: '######################################################'
tokenPass: '######################################################'
verify_ssl: True
debug: False
debug_level: 0
verbose: False
verbose_level: 0
```
### Variables
* **syspass_config_dir**
* **syspass_auth_token**
* **syspass_token_pass**
* **syspass_verify_ssl**
* **syspass_api_url**
* **syspass_api_version**
* **syspass_debug**
* **syspass_debug_LEVEL**
* **syspass_verbose**
* **syspass_verbose_level**
#### syspass_config_dir
Shortcut the ``$HOME/.config/digdeo-syspass-client`` default path by the value of the variable
#### syspass_auth_token
Shortcut the ``authToken`` set inside the ``config.yml``
#### syspass_verify_ssl
If it variable is set then, SSL certificates will be verify.
Note that is Python **Requests** module it deal with SSL certificate , if you take a look of it module documentation, you'll be inform about how deal with self signed certificates.
In summary, Requests module use **REQUESTS_CA_BUNDLE** env variable, for get the SSL Bundle certificate file path of you system.
Example:
```shell script
export REQUESTS_CA_BUNDLE="/etc/ssl/certs/ca-certificates.crt"
```
The ``ca-certificates.crt`` file is generate by system package call ``ca-certificates`` and must be re-generate each time you add a new self-signed certificate.
Exemple:
```shell script
sudo cp my.cert /usr/local/share/ca-certificates/
sudo update-ca-certificates
```
For many programming language, self signed certificates addition, require to inform the system about that new self-signed certificates existence.
The SSL Bundle Certificates , is common thing for SSL and is not impose by Python it self. If you want more information's, back to you system documentation for know more about SSL bundle cert .
#### syspass_token_pass
Shortcut the ``tokenPass`` set inside the ``config.yml``
#### syspass_api_url
Shortcut the ``api_url`` set inside the ``config.yml``
#### syspass_api_version
Shortcut the ``api_version`` set inside the ``config.yml``
#### syspass_debug
Shortcut the ``debug`` set inside the ``config.yml``
#### syspass_debug_LEVEL
Shortcut the ``debug_level`` set inside the ``config.yml``
#### syspass_verbose
Shortcut the ``verbose`` set inside the ``config.yaml``
#### syspass_verbose_level
Shortcut the ``verbose_level`` set inside the ``config.yml``
### Tips
* If you would like to change token on fly, you'll have to play with **$syspass_config_dir** and a subdirectory structure.
* Syspassclient can start without config.yml file and is suppose to use Variables , that permit to make tests inside a CI.
---
DigDeo FLOSS Team - 2020
Raw data
{
"_id": null,
"home_page": "https://git.digdeo.fr/digdeo-system/FLOSS/digdeo-syspass-client/",
"name": "digdeo-syspass-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "DigDeo Syspass Client",
"author": "DigDeo",
"author_email": "pierre-henry.muller@digdeo.fr",
"download_url": "https://files.pythonhosted.org/packages/11/f9/48ac450371ea9c7e4fc9cf4deb95f04acc800acba03bdfad1250a48da7fe/digdeo_syspass_client-0.6.8.tar.gz",
"platform": null,
"description": "[](https://gitdev.digdeo.fr/digdeo-projets-floss1/digdeo-syspass-client/-/commits/master) [](https://gitdev.digdeo.fr/digdeo-projets-floss1/digdeo-syspass-client/-/commits/master)\n\n# digdeo-syspass-client\n\nPython API Client for SysPass server (https://www.syspass.org/en)\n\n### Implemented API\nBoth 100% Cover and 100% UnitTested\n* 3.0: https://syspass-doc.readthedocs.io/en/3.0/\n* 3.1: https://syspass-doc.readthedocs.io/en/3.1/\n\n### Cool but what i need to use it ?\nThe API Client require settings like the server and token ;)\nIt have many ways to inject that setting, via config file and/or by ENV vars.\n\n### Permanent configuration::\n\nThat is suppose to be the default setting , where a file ``config.yml`` is store in user space. \n\nThat standard is describe on FreeDedktop web site. https://specifications.freedesktop.org/basedir-spec/basedir-spec-0.6.html\n\nThen by follow recommendation and standard we use ``$HOME/.config/digdeo-syspass-client/`` as default directory for search ``config.yml`` file.\n\nYou can change the ``$XDG_CONFIG_HOME/digdeo-syspass-client/config.yml`` search by set a ENV var **syspass_config_dir** then \n``$HOME/.config/digdeo-syspass-client/config.yml`` will become ``$syspass_config_dir/config.yml``\n\nFor more information's take a look on FreeDesktop XDG recommendation.\n\n### Config file\n\nYou can use any type of key here, in our usage that is a Read Only key.\n\n```\nsyspassclient:\n api_url: 'https://you.server.exemple.com/api.php'\n api_version: '3.1'\n authToken: '######################################################'\n tokenPass: '######################################################'\n verify_ssl: True\n debug: False\n debug_level: 0\n verbose: False\n verbose_level: 0\n```\n\n### Variables\n\n* **syspass_config_dir**\n* **syspass_auth_token**\n* **syspass_token_pass**\n* **syspass_verify_ssl**\n* **syspass_api_url**\n* **syspass_api_version**\n* **syspass_debug**\n* **syspass_debug_LEVEL**\n* **syspass_verbose**\n* **syspass_verbose_level**\n \n#### syspass_config_dir\nShortcut the ``$HOME/.config/digdeo-syspass-client`` default path by the value of the variable\n\n#### syspass_auth_token\nShortcut the ``authToken`` set inside the ``config.yml``\n\n#### syspass_verify_ssl\nIf it variable is set then, SSL certificates will be verify.\n\nNote that is Python **Requests** module it deal with SSL certificate , if you take a look of it module documentation, you'll be inform about how deal with self signed certificates.\nIn summary, Requests module use **REQUESTS_CA_BUNDLE** env variable, for get the SSL Bundle certificate file path of you system.\n\nExample:\n```shell script\nexport REQUESTS_CA_BUNDLE=\"/etc/ssl/certs/ca-certificates.crt\"\n```\n\nThe ``ca-certificates.crt`` file is generate by system package call ``ca-certificates`` and must be re-generate each time you add a new self-signed certificate.\n\nExemple:\n```shell script\nsudo cp my.cert /usr/local/share/ca-certificates/\nsudo update-ca-certificates\n```\n\nFor many programming language, self signed certificates addition, require to inform the system about that new self-signed certificates existence.\n\nThe SSL Bundle Certificates , is common thing for SSL and is not impose by Python it self. If you want more information's, back to you system documentation for know more about SSL bundle cert .\n\n#### syspass_token_pass\nShortcut the ``tokenPass`` set inside the ``config.yml``\n\n#### syspass_api_url\nShortcut the ``api_url`` set inside the ``config.yml``\n\n#### syspass_api_version\nShortcut the ``api_version`` set inside the ``config.yml``\n\n#### syspass_debug\nShortcut the ``debug`` set inside the ``config.yml``\n\n#### syspass_debug_LEVEL\nShortcut the ``debug_level`` set inside the ``config.yml``\n\n#### syspass_verbose\nShortcut the ``verbose`` set inside the ``config.yaml``\n\n#### syspass_verbose_level\nShortcut the ``verbose_level`` set inside the ``config.yml``\n\n### Tips\n\n* If you would like to change token on fly, you'll have to play with **$syspass_config_dir** and a subdirectory structure.\n* Syspassclient can start without config.yml file and is suppose to use Variables , that permit to make tests inside a CI.\n---\nDigDeo FLOSS Team - 2020\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE Version 3",
"summary": "DigDeo Syspass Client",
"version": "0.6.8",
"project_urls": {
"Homepage": "https://git.digdeo.fr/digdeo-system/FLOSS/digdeo-syspass-client/"
},
"split_keywords": [
"digdeo",
"syspass",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5819a4df31e5ba29cc674cdbfb476113e6f695df3228f06b88ef9bdf8b54ab5",
"md5": "b143e0e3831a7b73090a98786768cb5d",
"sha256": "48ee8a1e490714ff17c64c5a75b897199aeac62464f504537c4b38c2460bb51e"
},
"downloads": -1,
"filename": "digdeo_syspass_client-0.6.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b143e0e3831a7b73090a98786768cb5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 36629,
"upload_time": "2024-09-20T20:21:37",
"upload_time_iso_8601": "2024-09-20T20:21:37.267292Z",
"url": "https://files.pythonhosted.org/packages/a5/81/9a4df31e5ba29cc674cdbfb476113e6f695df3228f06b88ef9bdf8b54ab5/digdeo_syspass_client-0.6.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "11f948ac450371ea9c7e4fc9cf4deb95f04acc800acba03bdfad1250a48da7fe",
"md5": "1e8558f83b47b1f0e9b54ac07332a8b7",
"sha256": "01827f062cfe5097514559f2639cc8a1bf9c5a5703931891871671aa2e6158b4"
},
"downloads": -1,
"filename": "digdeo_syspass_client-0.6.8.tar.gz",
"has_sig": false,
"md5_digest": "1e8558f83b47b1f0e9b54ac07332a8b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39162,
"upload_time": "2024-09-20T20:21:39",
"upload_time_iso_8601": "2024-09-20T20:21:39.150371Z",
"url": "https://files.pythonhosted.org/packages/11/f9/48ac450371ea9c7e4fc9cf4deb95f04acc800acba03bdfad1250a48da7fe/digdeo_syspass_client-0.6.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 20:21:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "digdeo-syspass-client"
}
JSON