The Assistant python library
Project description
Assistant library
This Python 3.x library is used to write programs that can interact with the Assistant.
Assistant : https://gitlab.com/goassistant/assistant
Pypi webpage : https://pypi.org/project/assistant-lib
Changelog
TODO
License
The license choosen for this project it the LGPLv3. It was choosen instead of the GPLv3 because :
The license allows developers and companies to use and integrate a software component released under the LGPL into their own (even proprietary) software without being required by the terms of a strong copyleft license to release the source code of their own components. However, any developer who modifies an LGPL-covered component is required to make their modified version available under the same LGPL license.
See Wikipedia for more informations.
Installation
pip3 install assistant-lib
Usage
Here is a simple test :
$ python3
Python 3.7.4 (default, Jul 11 2019, 10:43:21)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from assistant_lib import assistant
>>> ac = assistant.AssistantClient("test", "1.0")
Output redirected to the file : 'assistant.log'
>>> ac.get_hostname()
'ambre'
Local tests
If you plan to make some upgrades and test them, here is how to process :
- Edit your changes in the code
- Run the clean and build command:
make
- Check the dist/ folder
- Install the builded package from the dist/ folder:
pip3 install dist/assistant_lib-<version>.tar.gz
Releasing
The version number is automatically get from git thanks to the setuptools_scm library. So you have no version to set in the code.
To create a new release, just create a tag and push it to Gitlab. The CI/CD pipeline will build a release and publish it to Pypi. This is just magic ;). You can check the .gitlab-ci.yml file to understand how it works.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for assistant_lib-0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e4c1afd34c55ce6a7e7473597596176266130ce2cb0cbb6e279d6b7220c8a8e |
|
MD5 | 310b7b1ebe97696066f1167e0cdee092 |
|
BLAKE2b-256 | 7b0df29317a679cbeaa6bc00778ce5ad31d4406ddad5af3f1fdca03a883f22ce |