Skip to main content

Convenient Python helper classes for cli Main programs.

Project description

Convenient Python helper classes for cli Main programs.

Intended advantages:

  • consistent command line

  • consistent logging

Installation

pip install git+https://gitlab.diamond.ac.uk/kbp43231/dls-mainiac.git

dls-mainiac --version

Summary

TBD

Documentation

See https://www.cs.diamond.ac.uk/dls-mainiac for more detailed documentation.

Building and viewing the documents locally:

git clone git+https://gitlab.diamond.ac.uk/kbp43231/dls-mainiac.git
cd dls-mainiac
virtualenv /scratch/$USER/venv/dls-mainiac
source /scratch/$USER/venv/dls-mainiac/bin/activate
pip install -e .[dev]
make -f .dls-mainiac/Makefile validate_docs
browse to file:///scratch/$USER/venvs/dls-mainiac/build/html/index.html

Topics for further documentation:

  • TODO list of improvements

  • change log

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dls-mainiac-4.1.0.tar.gz (46.7 kB view hashes)

Uploaded Source

Built Distribution

dls_mainiac-4.1.0-py3-none-any.whl (12.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page