{ "info": { "author": "Lo\u00efc Schneider", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "**pydoit-project-builder** is an open source python library that provides command line interface to accelerate python development. The library is build on top of [doit](http://pydoit.org/).\n\nInside a new project and assuming the presence of a `setup.py` file, pydoit-project-builder provides a series of command lines to manage a python project:\n\n* Create a virtual environment for the project.\n* Install dependencies.\n* Create documentation.\n* Check code style with pylint and flake8.\n* Create a distribution and package the project.\n* Remove auxialiary files such as the virtual environment, the auxialiary files, ects.\n* Launch tests.\n\n## Installation\n\nTo install the current release:\n\n```shell\npip install pydoit-project-builder\n```\n\n**Dependencies**\n\nIn order to be use, the [doit](http://pydoit.org/) tool must be installed.\n\n\n## First steps\n\nLets start a new project called `my-py-project` with the following structure:\n\n```\nmy-py-project\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac docs\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac conf.py\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac index.rst\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac static\n\u00e2\u201d\u201a \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac templates\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac my_py_project\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac __init__.py\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac src_file_1.py\n\u00e2\u201d\u201a \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac src_file_2.py\n\u00e2\u201d\u201a \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac ...\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac README.md\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac LICENSE\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac setup.cfg\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac setup.py\n\u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac dodo.py\n\u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac test\n \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac __init__.py\n \u00e2\u201d\u0153\u00e2\u201d\u20ac\u00e2\u201d\u20ac test_src_file_1.py\n \u00e2\u201d\u201d\u00e2\u201d\u20ac\u00e2\u201d\u20ac test_src_file_2.py\n```\n\nThe `setup.py` should define on which library the project relies upon. The `dodo.py` file is the file used by the automation tool `doit` to generate command line to be used in a terminal. Its content must be:\n```python\n\"\"\"Define tasks to be used by the library pydoit.\"\"\"\nfrom pydoit_project_builder import TaskCreator\n\n# Define project parameters.\nproject_name = \"pydoit_project_builder\"\npython_version = \"3.6\"\n# Instantiate tasks for pydoit library.\ntask_creator = TaskCreator(\n project_name=project_name, python_version=python_version)\nlist_callbacks = task_creator.get_all_tasks()\nfor callback in list_callbacks:\n fn_name = callback.__name__\n globals()[\"task_\" + fn_name] = callback\n```\n\nIn the shell, in the folder containing the `dodo.py` file, enter the command `doit list` to see the list of available tasks.\n\n\n## License\n\n[Apache License 2.0](LICENSE)\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/schneiderlo/pydoit-project-builder", "keywords": "", "license": "Apache 2", "maintainer": "", "maintainer_email": "", "name": "pydoit-project-builder", "package_url": "https://pypi.org/project/pydoit-project-builder/", "platform": "", "project_url": "https://pypi.org/project/pydoit-project-builder/", "project_urls": { "Homepage": "https://github.com/schneiderlo/pydoit-project-builder" }, "release_url": "https://pypi.org/project/pydoit-project-builder/0.1.0/", "requires_dist": [ "wheel; extra == 'dev'", "pylint; extra == 'dev'", "flake8; extra == 'dev'", "flake8-docstrings; extra == 'dev'", "pytest; extra == 'dev'", "pytest-cov; extra == 'dev'", "pytest-html; extra == 'dev'", "pytest-xdist; extra == 'dev'", "coverage; extra == 'dev'" ], "requires_python": "", "summary": "Templates to be used when creating projects.", "version": "0.1.0" }, "last_serial": 4474264, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "5c6274dd4949375fa0a68450a24e7a8f", "sha256": "9417ecabca5f5409d3ce43c240a8656cc799a68150ab0d7d708f1321b4d3c495" }, "downloads": -1, "filename": "pydoit_project_builder-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5c6274dd4949375fa0a68450a24e7a8f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11073, "upload_time": "2018-11-11T13:28:08", "url": "https://files.pythonhosted.org/packages/ff/3f/22922316499db866bb40585bf9f2d09d8d48f678c6a387cb95add3082851/pydoit_project_builder-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "70cb8e749454a3e8115b094d0f595503", "sha256": "f9c73d4f700449e3dd176cd705eb3e491138aa7afe0931eae83c22cab15cd90e" }, "downloads": -1, "filename": "pydoit-project-builder-0.1.0.tar.gz", "has_sig": false, "md5_digest": "70cb8e749454a3e8115b094d0f595503", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5167, "upload_time": "2018-11-11T13:28:17", "url": "https://files.pythonhosted.org/packages/c8/2f/b3492e918febb335b66ab8471de52740d0db71714a9c2ab4f06ec1dda592/pydoit-project-builder-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5c6274dd4949375fa0a68450a24e7a8f", "sha256": "9417ecabca5f5409d3ce43c240a8656cc799a68150ab0d7d708f1321b4d3c495" }, "downloads": -1, "filename": "pydoit_project_builder-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5c6274dd4949375fa0a68450a24e7a8f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11073, "upload_time": "2018-11-11T13:28:08", "url": "https://files.pythonhosted.org/packages/ff/3f/22922316499db866bb40585bf9f2d09d8d48f678c6a387cb95add3082851/pydoit_project_builder-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "70cb8e749454a3e8115b094d0f595503", "sha256": "f9c73d4f700449e3dd176cd705eb3e491138aa7afe0931eae83c22cab15cd90e" }, "downloads": -1, "filename": "pydoit-project-builder-0.1.0.tar.gz", "has_sig": false, "md5_digest": "70cb8e749454a3e8115b094d0f595503", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5167, "upload_time": "2018-11-11T13:28:17", "url": "https://files.pythonhosted.org/packages/c8/2f/b3492e918febb335b66ab8471de52740d0db71714a9c2ab4f06ec1dda592/pydoit-project-builder-0.1.0.tar.gz" } ] }