{ "info": { "author": "Jacky Zhao", "author_email": "j.zhao2k19@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6" ], "description": "# ThrowColour\n\nThrowColour is a small Python module to make printing messages with formatting and colours easier! This module is mostly just practice with creating a working pip module for learning purposes.\n\n## Features\n\n - Supports different types of print messages with colour coding\n - Support basic formatting (bold, italics)\n - Supports timestamp printing\n\n## Usage\n### Getting it\n\nTo download throwcolour, either fork this Github repo or simply use Pypi via pip.\n```sh\n$ pip install ThrowColour\n```\n\n### Using it\n\nA few functional examples of how to use ThrowColour.\n\n##### Basic Functionality\n\nA basic example of how to use the ```cthrow``` function.\n\n```Python\nfrom ThrowColour import cthrow\ncthrow('Test 1,2')\n```\n\nThis would print the message ```DATETIME - [INFO] Test 1,2``` in a nice looking purple with ```DATETIME``` replaced with the current timestamp.\n\n![eg1](res/eg1.png?raw=true)\n\n
\n\n##### The ```cthrow``` function\n\nThe full ```cthrow``` function is as follows:\n```Python\ncthrow(message, type='INFO', formatting=None, addPrefix=True, dateTime=True)\n```\n\n##### Setting the ```type``` argument\n\nAs you can see, a flag can be specified. This specifies the colour of the message and the message type. When setting flags, ensure the strings match exactly the name of the flag detailed below.\n * INFO - A nice aesthetic purple message\n * OK - A satisfying green message\n * WARN - A cautionary yellow message\n * ERR - A not-so-good red message\n\n
\n\nFor example:\n\n```Python\ncthrow(\"This probably isn't good\", type=\"WARN\")\n```\n\n![eg2](res/eg2.png?raw=true)\n\n
\n\n##### The ```addPrefix``` and ```dateTime``` arguments\n\nWe can also disable the prefix (the stuff inside the []) and timestamp as follows.\n\n```Python\ncthrow(\"Look Mom, no prefix and timestamp!\", addPrefix=False, dateTime=False)\n```\n\n
\n\n##### Setting formatting flags\n\nWith ThrowColour it is also possible to set multiple formatting flags such as bold and italics. It is important to note that the argument ```formatting``` takes a list containing strings of different formatting options.\n\n```Python\ncthrow(\"Bold and Underlined\", formatting=['BOLD','UNDERLINE'])\n```\n![eg3](res/eg3.png?raw=true)\n\nOr just bolded,\n```Python\ncthrow(\"Nice and bold\", formatting=['BOLD'])\n```\n\n![eg4](res/eg4.png?raw=true)\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jackyzha0/ThrowColour", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "ThrowColour-jzhao", "package_url": "https://pypi.org/project/ThrowColour-jzhao/", "platform": "", "project_url": "https://pypi.org/project/ThrowColour-jzhao/", "project_urls": { "Homepage": "https://github.com/jackyzha0/ThrowColour" }, "release_url": "https://pypi.org/project/ThrowColour-jzhao/1.0.4/", "requires_dist": null, "requires_python": "", "summary": "A small package to make printing pretty things easier!", "version": "1.0.4" }, "last_serial": 5111958, "releases": { "1.0.4": [ { "comment_text": "", "digests": { "md5": "d7a605b9657a5d230601568b5afa66a7", "sha256": "5cd4a8a44f41a0c9edcbe85e8e77be395fb8c6a01105e55a94f464386f7e8fe9" }, "downloads": -1, "filename": "ThrowColour_jzhao-1.0.4-py2-none-any.whl", "has_sig": false, "md5_digest": "d7a605b9657a5d230601568b5afa66a7", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 3104, "upload_time": "2019-04-08T04:56:35", "url": "https://files.pythonhosted.org/packages/86/10/72f92b4bc1ddfc04c3e7cc01d04eca0f9a1dd0330a65e7dc6ff6710db0a4/ThrowColour_jzhao-1.0.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5f4c38c2b8f049d9802e7625255d86d9", "sha256": "9136fcde38f8b4f583c792f814971d78af7c3adf633a3c37ef5b5d32b3617f10" }, "downloads": -1, "filename": "ThrowColour-jzhao-1.0.4.tar.gz", "has_sig": false, "md5_digest": "5f4c38c2b8f049d9802e7625255d86d9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2237, "upload_time": "2019-04-08T04:56:37", "url": "https://files.pythonhosted.org/packages/f0/be/144f2b3dd6ad0012353bcad77bdc975d1571949701b1f700fe022835efb2/ThrowColour-jzhao-1.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d7a605b9657a5d230601568b5afa66a7", "sha256": "5cd4a8a44f41a0c9edcbe85e8e77be395fb8c6a01105e55a94f464386f7e8fe9" }, "downloads": -1, "filename": "ThrowColour_jzhao-1.0.4-py2-none-any.whl", "has_sig": false, "md5_digest": "d7a605b9657a5d230601568b5afa66a7", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 3104, "upload_time": "2019-04-08T04:56:35", "url": "https://files.pythonhosted.org/packages/86/10/72f92b4bc1ddfc04c3e7cc01d04eca0f9a1dd0330a65e7dc6ff6710db0a4/ThrowColour_jzhao-1.0.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5f4c38c2b8f049d9802e7625255d86d9", "sha256": "9136fcde38f8b4f583c792f814971d78af7c3adf633a3c37ef5b5d32b3617f10" }, "downloads": -1, "filename": "ThrowColour-jzhao-1.0.4.tar.gz", "has_sig": false, "md5_digest": "5f4c38c2b8f049d9802e7625255d86d9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2237, "upload_time": "2019-04-08T04:56:37", "url": "https://files.pythonhosted.org/packages/f0/be/144f2b3dd6ad0012353bcad77bdc975d1571949701b1f700fe022835efb2/ThrowColour-jzhao-1.0.4.tar.gz" } ] }