debugging interface module
Project description
| BRANCH | BUILD STATUS | COVERAGE | REQUIREMENTS | ISSUES | OPEN PRs |
| --- | :---: | :---: | :---: | :---: | :---: |
| Master | [![Build Status](https://travis-ci.org/DrTexxOfficial/dbi.svg?branch=master)](https://travis-ci.org/DrTexxOfficial/dbi) | [![codecov](https://codecov.io/gh/DrTexxOfficial/dbi/branch/master/graph/badge.svg)](https://codecov.io/gh/DrTexxOfficial/dbi) | [![Requirements Status](https://requires.io/github/DrTexxOfficial/dbi/requirements.svg?branch=master)](https://requires.io/github/DrTexxOfficial/dbi/requirements/?branch=master) | [![GitHub issues](https://img.shields.io/github/issues/DrTexxOfficial/dbi.svg?branch=master)](https://GitHub.com/DrTexxOfficial/dbi/issues/) | [![GitHub pull-requests](https://img.shields.io/github/issues-pr/DrTexxOfficial/dbi.svg?branch=master)](https://GitHub.com/DrTexxOfficial/dbi/pull/) |
| Develop | [![Build Status](https://travis-ci.org/DrTexxOfficial/dbi.svg?branch=develop)](https://travis-ci.org/DrTexxOfficial/dbi) | [![codecov](https://codecov.io/gh/DrTexxOfficial/dbi/branch/develop/graph/badge.svg)](https://codecov.io/gh/DrTexxOfficial/dbi) | [![Requirements Status](https://requires.io/github/DrTexxOfficial/dbi/requirements.svg?branch=develop)](https://requires.io/github/DrTexxOfficial/dbi/requirements/?branch=develop)
# Debug Interface - DBI
[![PyPI Version](https://img.shields.io/pypi/v/dbi.svg)](https://pypi.python.org/pypi/dbi/)
[![GitHub release](https://img.shields.io/github/release/drtexxofficial/dbi.svg)](https://GitHub.com/DrTexxOfficial/dbi/releases/)
[![GitHub license](https://img.shields.io/github/license/DrTexxOfficial/dbi.svg?branch=master)](https://github.com/DrTexxOfficial/dbi/blob/master/LICENSE)
[![Github all releases](https://img.shields.io/github/downloads/DrTexxOfficial/dbi/total.svg)](https://GitHub.com/DrTexxOfficial/dbi/releases/)
<img src="docs/dbi_logo.png" alt="dbi logo" width="200"/>
## Installation
### Install via pip
Install as user (recommended):
$ pip3 install dbi --user
Install as root:
$ sudo pip3 install dbi
### Install from source
Clone this repository:
$ git clone https://github.com/DrTexxOfficial/dbi.git
Install requirements:
$ cd dbi
$ pip3 install -r requirements.txt --user
## Script Functionality
### User-Written Verbosity-Dependant Debug Messages
- information is only show when A and B are satisfied
- debugging is active
- the threshold verbosity is reached or exceeded (this threshold is specified on a per-message basis)
- verbosity can be
- set in advanced
- **modified on-the-fly**
- multiple **external functions** can be executed in a single-line
- users can write their own debugging messages on the status of each function's progress
- console output is colour-coded (based on verbosity levels)
## What is the purpose?
My console had become populated by indecernable walls of debugging text, all thanks to riddling my scripts with lines like `print(str(var),var)` for debugging.
So I created a module to maintain my sanity and save my time.
## Examples
Initial config:
```python3
from dbi import Dbi
dbi = Dbi(3,True)
dpm = dbi.print_message
```
Generic example:
```
[IN ]: dpm(2,"message with","sub-message")
[OUT]: [3][2]<=[2018-12-10 01:54:59.845995] message with | sub-message
```
<br/>
[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)
| --- | :---: | :---: | :---: | :---: | :---: |
| Master | [![Build Status](https://travis-ci.org/DrTexxOfficial/dbi.svg?branch=master)](https://travis-ci.org/DrTexxOfficial/dbi) | [![codecov](https://codecov.io/gh/DrTexxOfficial/dbi/branch/master/graph/badge.svg)](https://codecov.io/gh/DrTexxOfficial/dbi) | [![Requirements Status](https://requires.io/github/DrTexxOfficial/dbi/requirements.svg?branch=master)](https://requires.io/github/DrTexxOfficial/dbi/requirements/?branch=master) | [![GitHub issues](https://img.shields.io/github/issues/DrTexxOfficial/dbi.svg?branch=master)](https://GitHub.com/DrTexxOfficial/dbi/issues/) | [![GitHub pull-requests](https://img.shields.io/github/issues-pr/DrTexxOfficial/dbi.svg?branch=master)](https://GitHub.com/DrTexxOfficial/dbi/pull/) |
| Develop | [![Build Status](https://travis-ci.org/DrTexxOfficial/dbi.svg?branch=develop)](https://travis-ci.org/DrTexxOfficial/dbi) | [![codecov](https://codecov.io/gh/DrTexxOfficial/dbi/branch/develop/graph/badge.svg)](https://codecov.io/gh/DrTexxOfficial/dbi) | [![Requirements Status](https://requires.io/github/DrTexxOfficial/dbi/requirements.svg?branch=develop)](https://requires.io/github/DrTexxOfficial/dbi/requirements/?branch=develop)
# Debug Interface - DBI
[![PyPI Version](https://img.shields.io/pypi/v/dbi.svg)](https://pypi.python.org/pypi/dbi/)
[![GitHub release](https://img.shields.io/github/release/drtexxofficial/dbi.svg)](https://GitHub.com/DrTexxOfficial/dbi/releases/)
[![GitHub license](https://img.shields.io/github/license/DrTexxOfficial/dbi.svg?branch=master)](https://github.com/DrTexxOfficial/dbi/blob/master/LICENSE)
[![Github all releases](https://img.shields.io/github/downloads/DrTexxOfficial/dbi/total.svg)](https://GitHub.com/DrTexxOfficial/dbi/releases/)
<img src="docs/dbi_logo.png" alt="dbi logo" width="200"/>
## Installation
### Install via pip
Install as user (recommended):
$ pip3 install dbi --user
Install as root:
$ sudo pip3 install dbi
### Install from source
Clone this repository:
$ git clone https://github.com/DrTexxOfficial/dbi.git
Install requirements:
$ cd dbi
$ pip3 install -r requirements.txt --user
## Script Functionality
### User-Written Verbosity-Dependant Debug Messages
- information is only show when A and B are satisfied
- debugging is active
- the threshold verbosity is reached or exceeded (this threshold is specified on a per-message basis)
- verbosity can be
- set in advanced
- **modified on-the-fly**
- multiple **external functions** can be executed in a single-line
- users can write their own debugging messages on the status of each function's progress
- console output is colour-coded (based on verbosity levels)
## What is the purpose?
My console had become populated by indecernable walls of debugging text, all thanks to riddling my scripts with lines like `print(str(var),var)` for debugging.
So I created a module to maintain my sanity and save my time.
## Examples
Initial config:
```python3
from dbi import Dbi
dbi = Dbi(3,True)
dpm = dbi.print_message
```
Generic example:
```
[IN ]: dpm(2,"message with","sub-message")
[OUT]: [3][2]<=[2018-12-10 01:54:59.845995] message with | sub-message
```
<br/>
[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
qwerty-1.2.1-py3-none-any.whl
(16.7 kB
view details)
File details
Details for the file qwerty-1.2.1-py3-none-any.whl
.
File metadata
- Download URL: qwerty-1.2.1-py3-none-any.whl
- Upload date:
- Size: 16.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.8.1 pkginfo/1.2.1 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.7.0 clint/0.5.1 CPython/3.5.3 Linux/4.9.0-8-amd64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1c4fb637143b636c3e87572771c66ef6f67f0b7fc0e207276f24db878ffef5b |
|
MD5 | b8875b79810b4ed492b9f86c1ade0e39 |
|
BLAKE2b-256 | 74eac5864cc4d928b7c52df2ab341acfd53f6c26c5b287abed4c780ddc96ed52 |