Welcome to HevsLib’s documentation!

  /\  /\/__\/\   /\/ _\   / /(_) |__
 / /_/ /_\  \ \ / /\ \   / / | | '_ \  python hevslib
/ __  //__   \ V / _\ \ / /__| | |_) | (c) SPL HES-SO Valais-Wallis
\/ /_/\__/    \_/  \__/ \____/_|_.__/

Description

This repository contains multiple python modules to be reused in SPL projects.

Web documentation

https://spl.hevs.io/hevslib-python/

Gitlab Page

https://gitlab.hevs.ch/SPL/hevslib-python

All SPL Docs

• SPL-Docs - Public - General information about programming tools, code, spl admin stuff and internal informations

• Constellium-Docs - Private - Non public webpage for Constellium related confidential informations

• Hevslib-python - Public - Documentation about our own python library with some modules helping programming in python

Project Structure

+-- docs/                       # project documentation
+-- hevslib/
  +-- applehealth.py            # apple health API module
  +-- general.py                # helper functions for python standard libraries
  +-- log.py                    # log module for console and file colorful logs
  +-- md.py                     # markdown module to create markdown and pdf files
  +-- pandas.py                 # pandas helper functions
  +-- plotly.py                 # plotly helper functions
  +-- scikitlearn.py            # scikitlearn helper functions
  +-- sphinx.py                 # sphinx rst module to create rst files intented for sphinx
  +-- time.py                   # time a and datetime helper functions
  +-- toggl.py                  # functions linked to the toggl API
  +-- version.py                # hevslib library version
+-- img/                        # project images
+-- .gitignore
+-- LICENSE                     # The project license
+-- README.md                   # This file

Clone

Clone repo including submodules

git clone --recursive <repo_url>

Pull changes repo and submodules

Pull all changes in the repo including changes in the submodules (of given commit)

git pull --recursive-submodules

Install

As module

pip

pip install git+https://gitlab.hevs.ch/SPL/hevslib-python.git

pipenv

pipenv install git+https://gitlab.hevs.ch/SPL/hevslib-python.git#egg=hevslib

As submodule

git submodule add -b master ../../SPL/hevslib-python hevslib
git submodule add -b master https://gitlab.hevs.ch/SPL/hevslib-python hevslib

Known Issues / TODOs

Gitlab Issues

Credits

• Axel Amand (AmA) - Gitlab Profile

• Darko Petrovic Amand (PeD) - Gitlab Profile

• Gilles Mottiez (MGi) - Gitlab Profile

• Jerome Corre (CoJ) - Gitlab Profile

• Loïc Fracheboud (FrL) - Gitlab Profile

• Michael Clausen (ClM) - Gitlab Profile

• Silvan Zahno (ZaS) - Gitlab Profile

• Steve Devenes (DeS) - Gitlab Profile

Icons made by Freepik from Flaticon

License

Mit License © Smart Process Lab

Indices and tables

• Index

• Module Index

• Search Page

Find us on

• Website hevs.ch

• Linkedin HES-SO Valais-Wallis

• Twitter @hessovalais

• Instagram @hessovalais

• Youtube HES-SO Valais-Wallis

• Facebook @hessovalais

—

Hevslib is part of the SPL HES-SO Valais-Wallis software suite for Data Science, Education and Industry 4.0 applications.