{ "info": { "author": "Gonzalo Pe\u00f1a-Castellanos", "author_email": "goanpeca@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "=========\nCanvasCLI\n=========\n\n\nBuild Status\n------------\n\n.. image:: https://img.shields.io/travis/goanpeca/canvascli.svg\n :target: https://travis-ci.org/goanpeca/canvascli\n :alt: Travis Continuous Integration\n\n.. image:: https://ci.appveyor.com/api/projects/status/ap7il99q6npf4o53?svg=true\n :target: https://ci.appveyor.com/project/goanpeca/canvascli\n :alt: Appveyor Continuous Integration\n\n.. image:: https://codecov.io/gh/goanpeca/canvascli/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/goanpeca/canvascli\n :alt: Code coverage\n\n.. image:: https://scrutinizer-ci.com/g/goanpeca/canvascli/badges/quality-score.png?b=master\n :target: https://scrutinizer-ci.com/g/goanpeca/canvascli/?branch=master\n :alt: Scrutinizer Code Quality\n\nPackage information\n-------------------\n\n.. image:: https://img.shields.io/pypi/v/canvascli.svg\n :target: https://pypi.python.org/pypi/canvascli\n\n.. image:: https://readthedocs.org/projects/canvascli/badge/?version=latest\n :target: https://canvascli.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nDescription\n-----------\n\nThe simple console version of a drawing program!\n\n* Free software: MIT license\n* Documentation: https://canvascli.readthedocs.io.\n\nFeatures\n--------\n\nAt this time, the functionality of the program is quite limited but this might\nchange in the future. In a nutshell, the program should work as follows:\n\n1. Create a new canvas\n2. Start drawing on the canvas by issuing various commands\n3. Quit\n\nAt the moment, the program supports the following commands:\n\n* Create the Canvas\n* Draw a Line (Only horizontal and vertical lines are supported!)\n* Draw a Rectangle\n* Fill a Region with a given Color\n* Erase the Canvas\n* Quit\n\nIf you want to resize the Canvas after it has been created you can run the\ncreate command again, but you will be asked for confirmation as the previous\ncanvas will be replaced by the new one!\n\nInstallation\n------------\n\nYou can install with pip:\n\n.. code-block:: bash\n\n $ pip install canvascli\n\nUsage\n-----\n\nAfter installation you can run from the terminal/cli by executing\n\n\n.. code-block:: bash\n\n $ canvascli\n\nExample\n-------\n\n.. code-block:: text\n\n $ canvascli\n\n Enter command: C 20 4\n ----------------------\n | |\n | |\n | |\n | |\n ----------------------\n\n Enter command: L 1 2 6 2\n ----------------------\n | |\n |xxxxxx |\n | |\n | |\n ----------------------\n\n Enter command: L 6 3 6 4\n ----------------------\n | |\n |xxxxxx |\n | x |\n | x |\n ----------------------\n\n Enter command: R 16 1 20 3\n ----------------------\n | xxxxx|\n |xxxxxx x x|\n | x xxxxx|\n | x |\n ----------------------\n\n Enter command: B 10 3 o\n ----------------------\n |...............xxxxx|\n |xxxxxx.........x x|\n | x.........xxxxx|\n | x..............|\n ----------------------\n\n Enter command: E\n ----------------------\n | |\n | |\n | |\n | |\n ----------------------\n\n Enter command: Q\n\n\nLowercase commands are also valid!\n\nHelp\n----\n\nWhen running canvascli at any moment the help can be viewed typing **H**\n\n\n.. code-block:: text\n\n $ canvascli\n\n Enter command: H\n\n CanvasCLI: the simple console version of a drawing program!\n ===========================================================\n \n \n Program commands:\n -----------------\n \n H Display help\n \n C width height Create a new canvas of given size\n width: Canvas width\n height: Canvas height\n \n L x1 y1 x2 y2 Draw a Line from (x1,y1) to (x2,y2)\n x1: Point 1 x coordinate\n y1: Point 1 y coordinate\n x2: Point 2 x coordinate\n y2: Point 2 y coordinate\n \n R x1 y1 x2 y2 Draw a Rectangle given by (x1,y1) and (x2,y2)\n x1: Upper left corner x coordinate\n y1: Upper left corner y coordinate\n x2: Lower right corner x coordinate\n y2: Lower right corner y coordinate\n \n B x y color Fill the area connected to (x,y) with color\n x: Point x coordinate\n y: Point y coordinate\n color: Expressed as an ASCII single character\n \n E Erase the contents of the canvas.\n \n Q Quit program\n \n Notes: \n - Currently only horizontal or vertical lines are supported. \n - Horizontal and vertical lines will be drawn using the 'x' character.\n\nTesting\n-------\n\nTo run the test suite you need to install `pytest`_ and `pytest-cov`_ and run:\n\n.. code-block:: bash\n\n $ pip install pytest pytest-cov\n $ pytest tests/ --cov=canvascli\n\n\nCurrently the canvas and utils modules have 100% code coverage. The parser and\nthe cli modules have only partial coverage but we are working hard on improving\nthis!\n\nCode style\n----------\n\nWe try to follow `PEP8`_ and use `Flake8`_ to check code style.\n\nTo run the code style check you need to install flake8 and run:\n\n.. code-block:: bash\n\n $ pip install flake8\n $ flake8 canvascli/\n\n\nCredits\n-------\n\n* This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n* This package was inspired by a `Huge`_ Coding challenge!\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n.. _PEP8: https://www.python.org/dev/peps/pep-0008/\n.. _Flake8: http://flake8.pycqa.org/\n.. _pytest: https://docs.pytest.org\n.. _pytest-cov: http://pytest-cov.readthedocs.io/\n.. _Huge: https://www.hugeinc.com/\n\n\n=======\nHistory\n=======\n\n0.1.0 (2018-03-18)\n------------------\n\n* First release on PyPI.", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/goanpeca/canvascli", "keywords": "canvascli", "license": "MIT license", "maintainer": "", "maintainer_email": "", "name": "canvascli", "package_url": "https://pypi.org/project/canvascli/", "platform": "", "project_url": "https://pypi.org/project/canvascli/", "project_urls": { "Homepage": "https://github.com/goanpeca/canvascli" }, "release_url": "https://pypi.org/project/canvascli/0.1.0/", "requires_dist": null, "requires_python": "", "summary": "The simple console version of a drawing program!", "version": "0.1.0" }, "last_serial": 3697729, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "a2c1a8f58646388bb99471090195450b", "sha256": "45b0b3ec88d35125ae8a1bb7c64d9207210db2e717deda46563ae92e3724e13e" }, "downloads": -1, "filename": "canvascli-0.1.0.tar.gz", "has_sig": false, "md5_digest": "a2c1a8f58646388bb99471090195450b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22980, "upload_time": "2018-03-23T06:32:54", "url": "https://files.pythonhosted.org/packages/f4/58/171d2980779bf3554a173a724c9fc728673751541cb833cadff0b495c0e4/canvascli-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a2c1a8f58646388bb99471090195450b", "sha256": "45b0b3ec88d35125ae8a1bb7c64d9207210db2e717deda46563ae92e3724e13e" }, "downloads": -1, "filename": "canvascli-0.1.0.tar.gz", "has_sig": false, "md5_digest": "a2c1a8f58646388bb99471090195450b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22980, "upload_time": "2018-03-23T06:32:54", "url": "https://files.pythonhosted.org/packages/f4/58/171d2980779bf3554a173a724c9fc728673751541cb833cadff0b495c0e4/canvascli-0.1.0.tar.gz" } ] }