{ "info": { "author": "Korakot Leemakdej", "author_email": "kleemakdej@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "KorApp\n======\n\n.. figure:: https://github.com/korakotlee/img/raw/master/sample_mm.png\n :alt: \n\nPython package to generate app.\n\nInstallation\n~~~~~~~~~~~~\n\n::\n\n pip install korapp\n\nFor App Creator\n~~~~~~~~~~~~~~~\n\nIntroduction\n^^^^^^^^^^^^\n\n- A brain is an instruction to generate applications, you can generate\n any kind of application in any language depending on the brain.\n Download the brain that you want and put in the location ``~/.brain``\n- To create new application, use ``korapp new ``\n- Then cd into the new application folder\n- open file ``app.mm`` to examine and make modification\n- and run ``korapp gen``\n- If you change the ``app.mm`` mind map, run ``korapp gen`` again to\n regenerate the related files. Note that KorApp will overwrite its\n generated files so whatever customization you make will be\n overwritten. So if you want to modify the file, you can use the\n generated file as template and copy to other file or inherit from\n them.\n- However, the files created by ``korapp new`` will only generate once\n and not overwritten.\n\nDoc Server\n^^^^^^^^^^\n\nThe brain can behave differently from brain to brain. App Creator can\nlearn how each brain work from the document server. To access the\ndocument for the brain. ``cd korapp doc`` The document\nthen can be access from http://127.0.0.1:8000/\n\nFor Brain Creator\n~~~~~~~~~~~~~~~~~\n\nThe brain is also work from mind map as well. To create a brain\n\n- you need to write a mind map ``new.mm`` which will get run when app\n creator issue ``korapp new``\n- put any script used by ``new.mm`` inside ``script/`` directory\n- in the ``gen/`` directory, write mind maps corresponding to the\n branch that the app creator will be used in the first level branch,\n i.e., ``models.mm`` will get run when they use ``model`` branch,\n ``pages.mm`` for ``pages`` branch, and so on.\n- put all the script files under same ``script/`` directory.\n\nExample of ``models.mm``\n\n|models|.\n\nThe other directory structure are not required by KorApp, it depends on\nthe script to use them.\n\nKorapp New\n^^^^^^^^^^\n\n.. figure:: https://raw.githubusercontent.com/korakotlee/img/master/korapp/new_mm.png\n :alt: Korapp new\n\n Korapp new\n\n- Korapp will first look into ``new.mm`` and execute each branch. The\n first level node is command which can be either ``bash`` or\n ``python`` (``py`` is the same as ``python``)\n- The second level branch is the script filename that is under script/\n directory of the brain.\n- For bash, the script will run ``brain/script/.sh``, the\n extension ``.sh`` will be added automatically.\n- For python, the script will run ``brain/script/.py``, the\n extension ``.py`` will be added automatically.\n\nKorapp Gen Parameters\n^^^^^^^^^^^^^^^^^^^^^\n\n- for bash, will run with each node converted to snakecase arguments\n only first branch level\n- for other, will write node xml into ``.korapp/node_param.yaml`` and\n call as argument to script. The script can access node xml by using\n ``utils.get_node_param()`` like so\n\n ::\n\n from korapp import utils\n\n node_param = utils.get_node_param()\n\nKorapp Doc\n^^^^^^^^^^\n\nEach mind map (``.mm`` files) can have accompanied document file in the\nformat of markdown. The doc server will concatenate together\n``README.md``, ``new.md`` and all .md files in the ``gen/`` directory\n\nREFERENCE\n---------\n\nRequirement\n~~~~~~~~~~~\n\n- Python 3\n\nBrain Location\n~~~~~~~~~~~~~~\n\n- default to ~/.brain\n- can be specified by ``-b`` or ``--brain``\n ``korapp new my_app -b ~/brain0``\n\n.. |models| image:: https://github.com/korakotlee/img/raw/master/korapp/models.png\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/korakotlee", "keywords": "mind map,app generator", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "korapp", "package_url": "https://pypi.org/project/korapp/", "platform": "", "project_url": "https://pypi.org/project/korapp/", "project_urls": { "Homepage": "https://github.com/korakotlee" }, "release_url": "https://pypi.org/project/korapp/0.1.5/", "requires_dist": [ "untangle", "stringcase", "xmltodict", "pyyaml", "Flask", "markdown2" ], "requires_python": "", "summary": "Python package to generate app from mind map", "version": "0.1.5" }, "last_serial": 5168302, "releases": { "0.1.3": [ { "comment_text": "", "digests": { "md5": "7b32b8114a2cb3fe4d360a97d499ac19", "sha256": "6768cd2039dc37e5bf8a69f12725792c91033f8a11c5c52b54493210f0073577" }, "downloads": -1, "filename": "korapp-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "7b32b8114a2cb3fe4d360a97d499ac19", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11581, "upload_time": "2019-04-20T17:50:29", "url": "https://files.pythonhosted.org/packages/31/0a/aa20cf4bb536cd93992ba403500de28ef084ffce7104a920cbb2ccbe1a93/korapp-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6043bb5e1fe9b73cd8cb2bc00bae7703", "sha256": "e72e318c393885cc81b92ff963483a5ac4594cabe5100a991fe6bca9d6e906aa" }, "downloads": -1, "filename": "korapp-0.1.3.tar.gz", "has_sig": false, "md5_digest": "6043bb5e1fe9b73cd8cb2bc00bae7703", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7886, "upload_time": "2019-04-20T17:50:30", "url": "https://files.pythonhosted.org/packages/bb/70/2f89bb102ad8e4b8cc50509c8996d4dcc61cb0906e66eb295ae8978cddfd/korapp-0.1.3.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "09f0bc8331ad5fc2859f502c352f4803", "sha256": "fe3b3498762ab9217112e129fe62369519d390e143b2855159565ae5f5bcb487" }, "downloads": -1, "filename": "korapp-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "09f0bc8331ad5fc2859f502c352f4803", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11620, "upload_time": "2019-04-20T18:06:17", "url": "https://files.pythonhosted.org/packages/ac/ed/342db42bc676b9829b06e7ce9c9598ce415d67c44ccaeee1d812173efc62/korapp-0.1.5-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "09f0bc8331ad5fc2859f502c352f4803", "sha256": "fe3b3498762ab9217112e129fe62369519d390e143b2855159565ae5f5bcb487" }, "downloads": -1, "filename": "korapp-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "09f0bc8331ad5fc2859f502c352f4803", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11620, "upload_time": "2019-04-20T18:06:17", "url": "https://files.pythonhosted.org/packages/ac/ed/342db42bc676b9829b06e7ce9c9598ce415d67c44ccaeee1d812173efc62/korapp-0.1.5-py3-none-any.whl" } ] }