Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.64 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.64 KB
Raw

viashpy

Various tools and utilities to interact with viash using python.

Installation

To install viashpy, you can do so from the python package index PyPI using pip.

pip install viashpy

Running the tests

To run the tests, clone the repository and install the development requirements by running the following command from the root of the repository:

pip install .[dev] # Do not forget to quote this if you are using zsh

By default, viashpy can tested against different python versions (more specifically 3.8 to 3.13) using tox. These versions of python must be made available to tox (by adding them to your PATH environment variable), for example by installing and enabling them using pyenv.

Afterwards, running the tests is a matter of executing:

tox

Alternatively, if you wish to test for the python version installed on your system only, you can choose to only test -e parameter.

# Uses python3.8
tox -e py3.8

License

Copyright (C) 2020 Data Intuitive

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.