debugging interface module
Project description
| BRANCH | BUILD STATUS | COVERAGE | REQUIREMENTS | ISSUES | OPEN PRs |
| --- | :---: | :---: | :---: | :---: | :---: |
| Master | [](https://travis-ci.org/DrTexxOfficial/dbi) | [](https://codecov.io/gh/DrTexxOfficial/dbi) | [](https://requires.io/github/DrTexxOfficial/dbi/requirements/?branch=master) | [](https://GitHub.com/DrTexxOfficial/dbi/issues/) | [](https://GitHub.com/DrTexxOfficial/dbi/pull/) |
| Develop | [](https://travis-ci.org/DrTexxOfficial/dbi) | [](https://codecov.io/gh/DrTexxOfficial/dbi) | [](https://requires.io/github/DrTexxOfficial/dbi/requirements/?branch=develop)
# Debug Interface - DBI
[](https://pypi.python.org/pypi/dbi/)
[](https://GitHub.com/DrTexxOfficial/dbi/releases/)
[](https://github.com/DrTexxOfficial/dbi/blob/master/LICENSE)
[](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/>
[](https://www.python.org/)
| --- | :---: | :---: | :---: | :---: | :---: |
| Master | [](https://travis-ci.org/DrTexxOfficial/dbi) | [](https://codecov.io/gh/DrTexxOfficial/dbi) | [](https://requires.io/github/DrTexxOfficial/dbi/requirements/?branch=master) | [](https://GitHub.com/DrTexxOfficial/dbi/issues/) | [](https://GitHub.com/DrTexxOfficial/dbi/pull/) |
| Develop | [](https://travis-ci.org/DrTexxOfficial/dbi) | [](https://codecov.io/gh/DrTexxOfficial/dbi) | [](https://requires.io/github/DrTexxOfficial/dbi/requirements/?branch=develop)
# Debug Interface - DBI
[](https://pypi.python.org/pypi/dbi/)
[](https://GitHub.com/DrTexxOfficial/dbi/releases/)
[](https://github.com/DrTexxOfficial/dbi/blob/master/LICENSE)
[](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/>
[](https://www.python.org/)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size dbi-1.2.4-py3-none-any.whl (8.3 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |