{ "info": { "author": "Junho Kim", "author_email": "h4wldev@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# python-figures\n> \ud83d\ude00Can use unicode symbols on any OS!\n\nThis project is based on [sindresorhus/figures](https://github.com/sindresorhus/figures).\n\n\n\n## Installation\n```bash\npip install python-figures\n```\n\n## Usage\nYou can see supported symbols on [this code](https://github.com/h4wldev/python-figures/blob/master/figures/default.py) or [windows](https://github.com/h4wldev/python-figures/blob/master/figures/windows.py). You can also see this example on [example.py](https://github.com/h4wldev/python-figures/blob/master/example.py)\n```python\nfrom figures import Figures, figures as f\n\n\nfigures = Figures()\n\nprint(figures.get('tick'))\n\nfigures.add('santa', '\ud83c\udf85\ud83c\udffb')\nprint(figures.get('santa'))\n\nprint(figures.get('nonexistent', default=''))\n\nprint(figures.string('\u2714 \u2714 \u2714')) # \u2714 \u2714 \u2714 or \u221a \u221a \u221a\n\n # or you can use just like this\nprint(f('tick'))\nprint(f(string='\u2714 \u2714 \u2714')) # \u2714 \u2714 \u2714 or \u221a \u221a \u221a\n```\n\n## API\n### Figure\n#### add(key, default, windows)\nYou can add custom symbol with this function.\n\n##### key\nType : `String`\n\nUnicode symbol's key\n\n##### default\nType : `String`\n\nUnicode symbol (like \ud83c\udf85)\n\n##### windows\nType : `String`\n\nif you enter this argument, it return unicode symbol on windows CMD\n\n#### get(key, default)\nReturn os friendly unicode symbol with key\n\n##### key\nType : `String`\n\nUnicode symbols, see [Figures](#figures). also you can use custom symbol with add function.\n\n##### default\nType : `String`\n\nReturn this when nonexistent key argument.\n\n#### string(string)\nreplace string for windows CMD.\n\n##### string\nType : `String`\n\nString what have unicode symbols.\n\n#### get_all()\nGet all of symbols, include custom symbols\n\n#### get_keys()\nGet all of symbol's keys, include custom symbols\n\n---\n\n### figures(key=None, string=None, default=None)\nReturn os friendly unicode symbol with key, or replace string for windows CMD.\n\n#### key\nType : `String`\n\nUnicode symbols, see [Figures](#figures).\n\n#### string\nType : `String`\n\nString what have unicode symbols.\n\n#### default\nType : `String`\n\nReturn this when nonexistent key argument.\n\n## Figures\n| Key | Default | Windows |\n| ------------------ | :-------: | :-----: |\n| tick | \u2714 | \u221a |\n| cross | \u2716 | \u00d7 |\n| star | \u2605 | * |\n| square | \u2587 | \u2588 |\n| squareSmall | \u25fb | [ ] |\n| squareSmallFilled | \u25fc | [\u2588] |\n| play | \u25b6 | \u25ba |\n| circle | \u25ef | ( ) |\n| circleFilled | \u25c9 | (*) |\n| circleDotted | \u25cc | ( ) |\n| circleDouble | \u25ce | ( ) |\n| circleCircle | \u24de | (\u25cb) |\n| circleCross | \u24e7 | (\u00d7) |\n| circlePipe | \u24be | (\u2502) |\n| circleQuestionMark | ?\u20dd | (?) |\n| bullet | \u25cf | * |\n| dot | \u2024 | . |\n| line | \u2500 | \u2500 |\n| ellipsis | \u2026 | ... |\n| pointer | \u276f | > |\n| pointerSmall | \u203a | \u00bb |\n| info | \u2139 | i |\n| warning | \u26a0 | \u203c |\n| hamburger | \u2630 | \u2261 |\n| smiley | \u32e1 | \u263a |\n| mustache | \u0df4 | \u250c\u2500\u2510 |\n| heart | \u2665 | \u2665 |\n| arrowUp | \u2191 | \u2191 |\n| arrowDown | \u2193 | \u2193 |\n| arrowLeft | \u2190 | \u2190 |\n| arrowRight | \u2192 | \u2192 |\n| radioOn | \u25c9 | (*) |\n| radioOff | \u25ef | ( ) |\n| checkboxOn | \u2612 | [\u00d7] |\n| checkboxOff | \u2610 | [ ] |\n| checkboxCircleOn | \u24e7 | (\u00d7) |\n| checkboxCircleOff | \u24be | ( ) |\n| questionMarkPrefix | ?\u20dd | \uff1f |\n\n### License : [MIT](https://github.com/h4wldev/python-figures/blob/master/LICENSE) @ h4wldev", "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/h4wldev/python-figures", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "python-figures", "package_url": "https://pypi.org/project/python-figures/", "platform": "", "project_url": "https://pypi.org/project/python-figures/", "project_urls": { "Homepage": "https://github.com/h4wldev/python-figures" }, "release_url": "https://pypi.org/project/python-figures/1.1/", "requires_dist": null, "requires_python": "", "summary": "\ud83d\ude00 Can use unicode symbols on any OS!", "version": "1.1" }, "last_serial": 3930571, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "e7e66f7b6a3c16728948d8cec196281c", "sha256": "1ca56a2ce3c59bea8e310da7eb228d83158939478fd8667d162c0170a0fe6df0" }, "downloads": -1, "filename": "python-figures-1.0.tar.gz", "has_sig": false, "md5_digest": "e7e66f7b6a3c16728948d8cec196281c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3532, "upload_time": "2018-06-05T02:31:14", "url": "https://files.pythonhosted.org/packages/5f/51/c46b23f5c55d9f16f88078cd6c5918babe70ffcf88212691555f439b3d03/python-figures-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "16f38828126d832a0a7999fde06cc544", "sha256": "a70c3efc51977af563af11eb6001e036256cf6680089150f0d7c7ebff6256243" }, "downloads": -1, "filename": "python-figures-1.1.tar.gz", "has_sig": false, "md5_digest": "16f38828126d832a0a7999fde06cc544", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3664, "upload_time": "2018-06-05T02:34:54", "url": "https://files.pythonhosted.org/packages/b2/68/2ee3b699237a1d3bb185159f1b9c3bb32bd9e4112bb3a3651fba706834ac/python-figures-1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "16f38828126d832a0a7999fde06cc544", "sha256": "a70c3efc51977af563af11eb6001e036256cf6680089150f0d7c7ebff6256243" }, "downloads": -1, "filename": "python-figures-1.1.tar.gz", "has_sig": false, "md5_digest": "16f38828126d832a0a7999fde06cc544", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3664, "upload_time": "2018-06-05T02:34:54", "url": "https://files.pythonhosted.org/packages/b2/68/2ee3b699237a1d3bb185159f1b9c3bb32bd9e4112bb3a3651fba706834ac/python-figures-1.1.tar.gz" } ] }