Tool for managing machine learning model and service projects and other fast parsed python projects.
Project description
Bouillon contains; a) a project structure, b) a Command Line Interface (CLI) for building, testing, etc., that are easy to adapt and, c) a module that provides helper functionality when writing your script.
Features
The script provides various useful functionality using various projects, e.g.:
Pep8 syntax enforcement.
Static Code Analysis.
Verification of installed dependencies against requirements.
Verification of licenses in included modules.
Execution of unit tests.
Coverage of unit tests.
API documentation.
Updating of dependencies.
Getting Started
git clone git@github.com:janusheide/bouillon.git cd bouillon python boil --help python boil setup (will pip install packages, a venv is recommended) python boil test
Start A New Project
You can use this repository as a template https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template
Alternatively a more manual approach could be something like the following, where new_project is a empty git repository.
(clone the repository and remove the history) git clone git@github.com:janusheide/bouillon.git cd bouillon rm -rf .git (copy the project structure into your existing (empty) git repository) cp -r * ../new_project cd ../new_project/ git add . git commit -m 'Initial commit' git push
You should now have a project with the following structure, and should modify as indicated below.
├── boil -> cicd/boil.py ├── cicd (modify) │ ├── boil.py │ ├── licenses.ini │ ├── mypy.ini │ └── requirements.txt ├── LICENSE.txt (replace) ├── NEWS.rst (replace) ├── README.rst (replace) ├── setup.py (modify) ├── src (replace) │ ├── bouillon │ │ ├── bouillon.py │ │ ├── __init__.py │ │ └── requirements.txt └── test (replace) ├── cicd │ └── test_boil_cli.py ├── requirements.txt └── src ├── test_bouillon.py └── test___init__.py
At some point it might be convenient to fork the repository, make any changes you need and use that as your template repository.
Ways of Inclusion
You can include the bouillon module in a number of ways in your script, below are some prioritized options.
Pip Install During Setup Step
Install the module using Pip. This requires that the initial setup step can be executed without importing the module.
Pip Install Prior to Executing Script
The module can be installed prior to running any script commands, but this requires an extra step and means that the script setup step only partly setup the environment.
Copy Module File
Copy the module implementation (bouillon.py) into your project and import it from the local file in your script. Consequently you will have to manually update the module or implement a way to push a new module version into multiple repositories.
Copy Module Source Into CLI file
Copy the module implementation or the functionality you need into your cli file. While it is simple but even more inconvenient to keep the module functionality up to date.
Goals
The primary use is intended for, but not limited to, projects with frequently releases, e.g. ML models and services. The goal is to make it quick and easy to set up a new project with the basic testing and releasing functionality.
User Friendliness
Make the life of the user easier.
Use plain Python and modules that many are familiar with.
Quick and easy to setup and run repetitive tasks.
All tasks should be possible locally.
Reproducibility
Make results and builds reproducible.
All dependencies must be hard (versioned).
The master should always be green.
Simplicity
Simplicity over features.
Components should be easy to replace.
Automation
Reduce maintenance, repetitive tasks, and human errors.
Easy to upgrade dependencies.
Use merge policies and triggered and scheduled events.
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 bouillon-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60f305f5914a06e1944ae0725528d9063502c7c4e951ae391b085c9994cabcba |
|
MD5 | af58337b17d7a27b2031f01231a24b9a |
|
BLAKE2b-256 | 1fb932b634eaac402a8d6b8afddc68f3e39b2729582bae8dc641599e43ed7c55 |