lib-doctest-pycharm 0.0.1
lib_doctest_pycharm

lib_doctest_pycharm
===================

|Pypi Status| |license| |maintenance|

|Build Status| |Codecov Status| |Better Code| |code climate| |snyk security|

.. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg
   :target: http://en.wikipedia.org/wiki/MIT_License
.. |maintenance| image:: https://img.shields.io/maintenance/yes/2019.svg
.. |Build Status| image:: https://travis-ci.org/bitranox/lib_doctest_pycharm.svg?branch=master
   :target: https://travis-ci.org/bitranox/lib_doctest_pycharm
.. for the pypi status link note the dashes, not the underscore !
.. |Pypi Status| image:: https://badge.fury.io/py/lib-doctest-pycharm.svg
   :target: https://badge.fury.io/py/lib_doctest_pycharm
.. |Codecov Status| image:: https://codecov.io/gh/bitranox/lib_doctest_pycharm/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/bitranox/lib_doctest_pycharm
.. |Better Code| image:: https://bettercodehub.com/edge/badge/bitranox/lib_doctest_pycharm?branch=master
   :target: https://bettercodehub.com/results/bitranox/lib_doctest_pycharm
.. |snyk security| image:: https://snyk.io/test/github/bitranox/lib_doctest_pycharm/badge.svg
   :target: https://snyk.io/test/github/bitranox/lib_doctest_pycharm
.. |code climate| image:: https://api.codeclimate.com/v1/badges/703b84f88e062d1988a4/maintainability
   :target: https://codeclimate.com/github/bitranox/lib_doctest_pycharm/maintainability
   :alt: Maintainability

get log output into pycharm with doctest

supports python 3.7 and possibly other dialects.

`100% code coverage <https://codecov.io/gh/bitranox/lib_doctest_pycharm>`_, mypy static type checking, tested under `Linux, OsX, Windows and Wine <https://travis-ci.org/bitranox/lib_doctest_pycharm>`_, automatic daily builds  and monitoring

----

- `Installation and Upgrade`_
- `Basic Usage`_
- `Requirements`_
- `Acknowledgements`_
- `Contribute`_
- `Report Issues <https://github.com/bitranox/lib_doctest_pycharm/blob/master/ISSUE_TEMPLATE.md>`_
- `Pull Request <https://github.com/bitranox/lib_doctest_pycharm/blob/master/PULL_REQUEST_TEMPLATE.md>`_
- `Code of Conduct <https://github.com/bitranox/lib_doctest_pycharm/blob/master/CODE_OF_CONDUCT.md>`_
- `License`_
- `Changelog`_

----

Installation and Upgrade
------------------------

From source code:

.. code-block:: bash

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

via pip latest Release:

.. code-block:: bash

    # 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:

.. code-block:: bash

    # 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:

.. code-block:: bash

    # 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:

.. code-block:: 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 :

.. code-block:: bash

    ## 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 <https://github.com/bitranox/lib_doctest_pycharm/blob/master/CONTRIBUTING.md>`_

License
-------

This software is licensed under the `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_

---

Changelog
=========

0.0.1
-----
2019-07-22: Initial public release