Metadata-Version: 2.1
Name: tibidi
Version: 0.1.0
Summary: Dump your traceback into a file.
Home-page: https://gergelyk.github.io/python-tbdump
License: MIT
Keywords: debug,dump,traceback
Author: Grzegorz Krasoń
Author-email: grzegorz.krason@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: dill (>=0.3.3,<0.4.0)
Requires-Dist: peepshow (>=0.2.3,<0.3.0)
Project-URL: Documentation, https://gergelyk.github.io/python-tbdump
Project-URL: Repository, https://github.com/gergelyk/python-tbdump
Description-Content-Type: text/markdown

# tbdump

Dump your traceback into a file.

* Documentation: <https://gergelyk.github.io/python-tbdump>
* Repository: <https://github.com/gergelyk/python-tbdump>
* Package: <https://pypi.python.org/pypi/tbdump>
* Author: [Grzegorz Krasoń](mailto:grzegorz.krason@gmail.com)
* License: [MIT](LICENSE)

## Requirements

This package requires CPython 3.8 or compatible. If you have other version already installed, you can switch using `pyenv`. It must be installed as described in the [manual](https://github.com/pyenv/pyenv).

```sh
pyenv install 3.8.2
pyenv local 3.8.2
```

## Installation

```sh
pip install tbdump
```

## Usage

```sh
poetry run python tbdump/hello.py
```

## Development

```sh
# Preparing environment
pip install --user poetry  # unless already installed
poetry install

# Auto-formatting
poetry run docformatter -ri tbdump tests
poetry run isort -rc tbdump tests
poetry run yapf -r -i tbdump tests

# Checking coding style
poetry run flake8 tbdump tests

# Checking composition and quality
poetry run vulture tbdump tests
poetry run mypy tbdump tests
poetry run pylint tbdump tests
poetry run bandit tbdump tests
poetry run radon cc tbdump tests
poetry run radon mi tbdump tests

# Testing with coverage
poetry run pytest --cov tbdump --cov tests

# Rendering documentation
poetry run mkdocs serve

# Building package
poetry build

# Releasing
poetry version minor  # increment selected component
git commit -am "bump version"
git push
git tag ${$(poetry version)[2]}
git push --tags
poetry build
poetry publish
poetry run mkdocs build
poetry run mkdocs gh-deploy -b gh-pages
```

## Donations

If you find this software useful and you would like to repay author's efforts you are welcome to use following button:

[![Donate](https://www.paypalobjects.com/en_US/PL/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D9KUJD9LTKJY8&source=url)


