From ecf1ec2a9833ee80c764bbed8300ff17c5701c27 Mon Sep 17 00:00:00 2001 From: Nova Date: Sun, 19 Jul 2020 01:35:55 +0530 Subject: [PATCH] #43 Updated the logo in readme and migrated readme from rst to md --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++ README.rst | 68 -------------------------------------------------- pyproject.toml | 2 +- 3 files changed, 61 insertions(+), 69 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..d0523cc --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ + +

opencv-log

+ +[![Pypi +Version](https://img.shields.io/pypi/v/opencv-log.svg)](https://pypi.org/project/opencv-log) [![Build +Status](https://img.shields.io/circleci/build/github/navarasu/opencv-log)](https://circleci.com/gh/navarasu/opencv-log) [![Coverage +Status](https://img.shields.io/coveralls/github/navarasu/opencv-log/master)](https://coveralls.io/github/navarasu/opencv-log?branch=master) [![MIT +License](https://img.shields.io/pypi/l/opencv-log)](https://github.com/navarasu/opencv-log/blob/master/LICENSE) + +An [OpenCV](https://opencv.org/) based visual logger for debugging, +logging and testing reporting an image processing code. + +# Why opencv-log? + +[![Visually Debug, Log and Test an Image Processing Code using OpenCV +and +Python](https://user-images.githubusercontent.com/20145075/81455232-3eaaba00-91ac-11ea-9213-7dd1c705f213.png)](https://blog.francium.tech/visually-debug-log-and-test-an-image-processing-code-using-opencv-and-python-36e2d944ebf2) + +# Installation + +Use the package manager [pip](https://pip.pypa.io/en/stable/) to +install. + +``` sh +pip install opencv-log +``` + +**Documentation:** + +# A Simple Usage + +``` python +import cvlog as log +import cv2 + +# image read using opencv +img = cv2.imread("sample.png") + +log.image(log.Level.ERROR, img) +``` + +Just by switching mode, you can use the same line of code for logging +and debugging. Also you can log houghlines, countour and more. + +Refer [docs](https://navarasu.github.io/opencv-log) to get started. + +# Contributing + +Pull requests are welcome. For major changes, please open an issue first +to discuss what you would like to change. + +Please make sure to update tests as appropriate. + +Refer +[Guidelines](https://github.com/navarasu/opencv-log/blob/master/CONTRIBUTION.md) +for more information. + +# License + +[MIT](https://choosealicense.com/licenses/mit/) \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index a270bf5..0000000 --- a/README.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. figure:: https://user-images.githubusercontent.com/20145075/78172497-c8f85380-7473-11ea-9eb6-8963fc879a42.png - -.. image:: https://img.shields.io/pypi/v/opencv-log.svg - :target: https://pypi.org/project/opencv-log - :alt: Pypi Version -.. image:: https://img.shields.io/circleci/build/github/navarasu/opencv-log - :target: https://circleci.com/gh/navarasu/opencv-log - :alt: Build Status -.. image:: https://img.shields.io/coveralls/github/navarasu/opencv-log/master - :target: https://coveralls.io/github/navarasu/opencv-log?branch=master - :alt: Coverage Status -.. image:: https://img.shields.io/pypi/l/opencv-log - :target: https://github.com/navarasu/opencv-log/blob/master/LICENSE - :alt: MIT License - -| - -An `OpenCV `_ based visual logger for debugging, logging and testing reporting an image processing code. - -Why opencv-log? -############### - -.. image:: https://user-images.githubusercontent.com/20145075/81455232-3eaaba00-91ac-11ea-9213-7dd1c705f213.png - :target: https://blog.francium.tech/visually-debug-log-and-test-an-image-processing-code-using-opencv-and-python-36e2d944ebf2 - :alt: Visually Debug, Log and Test an Image Processing Code using OpenCV and Python - -Installation -############ -Use the package manager `pip `_ to install. - -.. code-block:: sh - - pip install opencv-log - - -**Documentation:** ``_ - -A Simple Usage -############## - -.. code-block:: python - - import cvlog as log - import cv2 - - # image read using opencv - img = cv2.imread("sample.png") - - log.image(log.Level.ERROR, img) - -Just by switching mode, you can use the same line of code for logging and debugging. -Also you can log houghlines, countour and more. - -Refer `docs `_ to get started. - -Contributing -############ - -Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. - -Please make sure to update tests as appropriate. - -Refer `Guidelines `_ for more information. - -License -####### - -`MIT `_ diff --git a/pyproject.toml b/pyproject.toml index 29da0f2..d46cd33 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "opencv-log" version = "1.4.0" description = "OpenCV based visual logger for debugging,logging and testing image processing code" authors = ["Navarasu "] -readme = 'README.rst' +readme = 'README.md' license = "MIT" homepage = "https://navarasu.github.io/opencv-log" repository = "https://github.com/navarasu/opencv-log"