.. image:: https://readthedocs.org/projects/vislog/badge/?version=latest
:target: https://vislog.readthedocs.io/en/latest/
:alt: Documentation Status
.. image:: https://github.com/MacHu-GWU/vislog-project/actions/workflows/main.yml/badge.svg
:target: https://github.com/MacHu-GWU/vislog-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/vislog-project/branch/main/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/vislog-project
.. image:: https://img.shields.io/pypi/v/vislog.svg
:target: https://pypi.python.org/pypi/vislog
.. image:: https://img.shields.io/pypi/l/vislog.svg
:target: https://pypi.python.org/pypi/vislog
.. image:: https://img.shields.io/pypi/pyversions/vislog.svg
:target: https://pypi.python.org/pypi/vislog
.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
:target: https://github.com/MacHu-GWU/vislog-project/blob/main/release-history.rst
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/vislog-project
------
.. image:: https://img.shields.io/badge/Link-Document-blue.svg
:target: https://vislog.readthedocs.io/en/latest/
.. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: https://vislog.readthedocs.io/en/latest/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/vislog-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/vislog-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/vislog-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/vislog#files
Welcome to ``vislog`` Documentation
==============================================================================
.. image:: https://vislog.readthedocs.io/en/latest/_static/vislog-logo.png
:target: https://vislog.readthedocs.io/en/latest/
``vislog`` is a ZERO-dependency logging library that brings visual effect to your logging message. It allows you to use any logging library you like, and just add visual effect.
.. code-block:: python
@logger.emoji_block(msg="build", emoji="🏭")
def run_build():
time.sleep(1)
logger.info("run build")
@logger.emoji_block(msg="test", emoji="🧪")
def run_test():
time.sleep(1)
logger.info("run test")
with logger.nested():
run_build()
@logger.emoji_block(msg="deploy", emoji="🚀")
def run_deploy():
time.sleep(1)
logger.info("run deploy")
with logger.nested():
run_test()
run_deploy()
Will show:
.. code-block::
[User 2024-06-16 15:06:44] +----- 🕑 🚀 Start 'deploy' -----------------------------------------------------+
[User 2024-06-16 15:06:44] 🚀
[User 2024-06-16 15:06:45] 🚀 run deploy
[User 2024-06-16 15:06:45] 🚀 +----- 🕑 🧪 Start 'test' -----------------------------------------------------+
[User 2024-06-16 15:06:45] 🚀 🧪
[User 2024-06-16 15:06:46] 🚀 🧪 run test
[User 2024-06-16 15:06:46] 🚀 🧪 +----- 🕑 🏭 Start 'build' --------------------------------------------------+
[User 2024-06-16 15:06:46] 🚀 🧪 🏭
[User 2024-06-16 15:06:47] 🚀 🧪 🏭 run build
[User 2024-06-16 15:06:47] 🚀 🧪 🏭
[User 2024-06-16 15:06:47] 🚀 🧪 +----- ⏰ ✅ 🏭 End 'build', elapsed = 1.01 sec ------------------------------+
[User 2024-06-16 15:06:47] 🚀 🧪
[User 2024-06-16 15:06:47] 🚀 +----- ⏰ ✅ 🧪 End 'test', elapsed = 2.02 sec ---------------------------------+
[User 2024-06-16 15:06:47] 🚀
[User 2024-06-16 15:06:47] +----- ⏰ ✅ 🚀 End 'deploy', elapsed = 3.03 sec ---------------------------------+
.. _install:
Install
------------------------------------------------------------------------------
``vislog`` is released on PyPI, so all you need is to:
.. code-block:: console
$ pip install vislog
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade vislog
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/vislog-project",
"name": "vislog",
"maintainer": "Sanhe Hu",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "husanhe@gmail.com",
"keywords": null,
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/54/75/7c41faeafb961873c16284140cfd27f0cc00581a85c7cf8abe41d75f9490/vislog-0.1.2.tar.gz",
"platform": "Windows",
"description": "\n.. image:: https://readthedocs.org/projects/vislog/badge/?version=latest\n :target: https://vislog.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/vislog-project/actions/workflows/main.yml/badge.svg\n :target: https://github.com/MacHu-GWU/vislog-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/vislog-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/vislog-project\n\n.. image:: https://img.shields.io/pypi/v/vislog.svg\n :target: https://pypi.python.org/pypi/vislog\n\n.. image:: https://img.shields.io/pypi/l/vislog.svg\n :target: https://pypi.python.org/pypi/vislog\n\n.. image:: https://img.shields.io/pypi/pyversions/vislog.svg\n :target: https://pypi.python.org/pypi/vislog\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/vislog-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/vislog-project\n\n------\n\n.. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://vislog.readthedocs.io/en/latest/\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://vislog.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/vislog-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/vislog-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/vislog-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/vislog#files\n\n\nWelcome to ``vislog`` Documentation\n==============================================================================\n.. image:: https://vislog.readthedocs.io/en/latest/_static/vislog-logo.png\n :target: https://vislog.readthedocs.io/en/latest/\n\n``vislog`` is a ZERO-dependency logging library that brings visual effect to your logging message. It allows you to use any logging library you like, and just add visual effect.\n\n.. code-block:: python\n\n @logger.emoji_block(msg=\"build\", emoji=\"\ud83c\udfed\")\n def run_build():\n time.sleep(1)\n logger.info(\"run build\")\n\n @logger.emoji_block(msg=\"test\", emoji=\"\ud83e\uddea\")\n def run_test():\n time.sleep(1)\n logger.info(\"run test\")\n with logger.nested():\n run_build()\n\n @logger.emoji_block(msg=\"deploy\", emoji=\"\ud83d\ude80\")\n def run_deploy():\n time.sleep(1)\n logger.info(\"run deploy\")\n with logger.nested():\n run_test()\n\n run_deploy()\n\nWill show:\n\n.. code-block::\n\n [User 2024-06-16 15:06:44] +----- \ud83d\udd51 \ud83d\ude80 Start 'deploy' -----------------------------------------------------+\n [User 2024-06-16 15:06:44] \ud83d\ude80\n [User 2024-06-16 15:06:45] \ud83d\ude80 run deploy\n [User 2024-06-16 15:06:45] \ud83d\ude80 +----- \ud83d\udd51 \ud83e\uddea Start 'test' -----------------------------------------------------+\n [User 2024-06-16 15:06:45] \ud83d\ude80 \ud83e\uddea\n [User 2024-06-16 15:06:46] \ud83d\ude80 \ud83e\uddea run test\n [User 2024-06-16 15:06:46] \ud83d\ude80 \ud83e\uddea +----- \ud83d\udd51 \ud83c\udfed Start 'build' --------------------------------------------------+\n [User 2024-06-16 15:06:46] \ud83d\ude80 \ud83e\uddea \ud83c\udfed\n [User 2024-06-16 15:06:47] \ud83d\ude80 \ud83e\uddea \ud83c\udfed run build\n [User 2024-06-16 15:06:47] \ud83d\ude80 \ud83e\uddea \ud83c\udfed\n [User 2024-06-16 15:06:47] \ud83d\ude80 \ud83e\uddea +----- \u23f0 \u2705 \ud83c\udfed End 'build', elapsed = 1.01 sec ------------------------------+\n [User 2024-06-16 15:06:47] \ud83d\ude80 \ud83e\uddea\n [User 2024-06-16 15:06:47] \ud83d\ude80 +----- \u23f0 \u2705 \ud83e\uddea End 'test', elapsed = 2.02 sec ---------------------------------+\n [User 2024-06-16 15:06:47] \ud83d\ude80\n [User 2024-06-16 15:06:47] +----- \u23f0 \u2705 \ud83d\ude80 End 'deploy', elapsed = 3.03 sec ---------------------------------+\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``vislog`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n $ pip install vislog\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade vislog\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Bring visual effect to your logging message.",
"version": "0.1.2",
"project_urls": {
"Download": "https://pypi.python.org/pypi/vislog/0.1.2#downloads",
"Homepage": "https://github.com/MacHu-GWU/vislog-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c3d0af2747f3549dca069021cd722770d8dcac5b2a25417652566fe540fc343",
"md5": "3c4c8fbdd64f6e7b21f7f6def46c12e3",
"sha256": "21311339dda1e7ba7164a7e2ee0c3806a2578e9ded94b93cf6cb13bc19c405a0"
},
"downloads": -1,
"filename": "vislog-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c4c8fbdd64f6e7b21f7f6def46c12e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12583,
"upload_time": "2024-06-16T20:19:25",
"upload_time_iso_8601": "2024-06-16T20:19:25.571474Z",
"url": "https://files.pythonhosted.org/packages/6c/3d/0af2747f3549dca069021cd722770d8dcac5b2a25417652566fe540fc343/vislog-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "54757c41faeafb961873c16284140cfd27f0cc00581a85c7cf8abe41d75f9490",
"md5": "b54a2b0695a32868db6d0ce5ff1632b3",
"sha256": "25a2f1f4285a9cfb113a5e55401845d3562f949492bec329daeb23d7b144bb70"
},
"downloads": -1,
"filename": "vislog-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "b54a2b0695a32868db6d0ce5ff1632b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14444,
"upload_time": "2024-06-16T20:19:28",
"upload_time_iso_8601": "2024-06-16T20:19:28.612767Z",
"url": "https://files.pythonhosted.org/packages/54/75/7c41faeafb961873c16284140cfd27f0cc00581a85c7cf8abe41d75f9490/vislog-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-16 20:19:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "vislog-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "vislog"
}
JSON
