lib-doctest-pycharm

lib_doctest_pycharm


License
MIT
Install
pip install lib-doctest-pycharm==0.0.1

Documentation

lib_doctest_pycharm

Pypi Status license maintenance

Build Status Codecov Status Better Code Maintainability snyk security

get log output into pycharm with doctest

supports python 3.7 and possibly other dialects.

100% code coverage, mypy static type checking, tested under Linux, OsX, Windows and Wine, automatic daily builds and monitoring



Installation and Upgrade

From source code:

# normal install
python setup.py install
# test without installing
python setup.py test

via pip latest Release:

# latest Release from pypi
pip install lib_doctest_pycharm

# test without installing
pip install lib_doctest_pycharm --install-option test

via pip latest Development Version:

# upgrade all dependencies regardless of version number (PREFERRED)
pip install --upgrade git+https://github.com/bitranox/lib_doctest_pycharm.git --upgrade-strategy eager
# normal install
pip install --upgrade git+https://github.com/bitranox/lib_doctest_pycharm.git
# test without installing
pip install git+https://github.com/bitranox/lib_doctest_pycharm.git --install-option test

via requirements.txt:

# Insert following line in Your requirements.txt:
# for the latest Release:
lib_doctest_pycharm
# for the latest Development Version :
git+https://github.com/bitranox/lib_doctest_pycharm.git

# to install and upgrade all modules mentioned in requirements.txt:
pip install --upgrade -r /<path>/requirements.txt

via python:

# for the latest Release
python -m pip install upgrade lib_doctest_pycharm

# for the latest Development Version
python -m pip install upgrade git+https://github.com/bitranox/lib_doctest_pycharm.git

Basic Usage

TBA

Requirements

following modules will be automatically installed :

## Test Requirements
## following Requirements will be installed temporarily for
## "setup.py install test" or "pip install <package> --install-option test"
typing ; python_version < "3.5"
pathlib; python_version < "3.4"
mypy ; platform_python_implementation != "PyPy" and python_version >= "3.5"
pytest
pytest-pep8 ; python_version < "3.5"
pytest-codestyle ; python_version >= "3.5"
pytest-mypy ; platform_python_implementation != "PyPy" and python_version >= "3.5"
pytest-runner

## Project Requirements

Acknowledgements

  • special thanks to "uncle bob" Robert C. Martin, especially for his books on "clean code" and "clean architecture"

Contribute

I would love for you to fork and send me pull request for this project. - please Contribute

License

This software is licensed under the MIT license

---

Changelog

0.0.2

development

0.0.1

2019-07-22: Initial public release