{ "info": { "author": "dks", "author_email": "june3474@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Topic :: Utilities" ], "description": "*skelpy* is a simple template tool to create the directory structure for\npython projects. In addition to creating basic directories for a project,\n*skelpy* generates several configuration files for widely-used tools.\nThose include:\n\n * ``setup.py`` and ``setup.cfg`` for `setuptools `_\n * ``conf.py``, ``index.rst`` for `sphinx `_ documentation\n\nFor the complete directory structure and files for *skelpy* to create, see `quick_start`_\n\nFeatures\n========\n\nOS Independent\n--------------\n*skelpy* supports Linux, Windows, OSX and Cygwin.\n\nNo Dependency\n-------------\n*skelpy* was written in pure python and requires no extra library or module\nunless you want to run the test codes of *skelpy* yourself.\nIn that case, you will need `pytest `_\nand `mock `_ (only if you use python 2.7 and\n3.3 downward)\n\n.. note::\n\n mock is now part of the Python standard library, available as unittest.mock in Python 3.3 onwards.\n\nSupport python 2.7 and 3.x\n--------------------------\n*skelpy* works well on python 2.7 and 3.x.\n\nInstall\n=======\n\nFrom PyPi\n---------\nOn the command line, just type either of belows::\n\n pip install skelpy\n or\n pip install --user skelpy\n\nThe first one is for system-wide installation and you may need the administrator\n/root privilege. The second command will install *skelpy* in the user's python\ninstall directory, which is ~/.local/ on linux and Mac,\n%APPDATA%\\Python on Windows.\n\nFrom Git\n--------\nAnother option is to download *skelpy*'s source codes using ``git`` and to build an\nexecutable zip file. *skelpy*'s ``setup.py`` can build the zip-formatted executable.\nTo do that, run the command below in order::\n\n $ git clone https://github.com/june3474/skelpy.git\n $ cd skelpy\n $ python setup.py ezip\n\nNow you will be able to find an excutable zip file named ``skelpy.zip``\nin the ``dist`` directory .\nOnce got the zip file--changing the name of the zip file is OK--,\nyou can directly run the zip file as if it were a python module like below::\n\n python skelpy.zip [options_for_skelpy] [project_name_to_create]\n\n\nOr, if you use Linux or any POSIX-compatible OS, you can make the zip file an executable::\n\n $ echo '#!/usr/bin/env python' > skelpy\n $ cat skelpy-master.zip >> skelpy\n $ chmod u+x skelpy\n\nCodes above are from \"The Hitchhiker's Guide to Python\" by Kenneth Reitz and Tanya Schlusser.\n\n.. _quick_start:\n\nQuick Start\n===========\n\nTo start a new project, say 'my_project', just type on the command line ::\n\n skelpy my_project\n\nThis will create a new folder ``my_project`` under the current directory and\nfill the directory with sub-directories and configuration files like below::\n\n 'basic' format(default) 'src' format\n\n my_project/ my_project/\n \u251c\u2500\u2500 docs/ \u251c\u2500\u2500 docs/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 _build/ \u2502\u00a0\u00a0 \u251c\u2500\u2500 _build/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 _static/ \u2502\u00a0\u00a0 \u251c\u2500\u2500 _static/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 _templates/ \u2502\u00a0\u00a0 \u251c\u2500\u2500 _templates/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 conf.py \u2502\u00a0\u00a0 \u251c\u2500\u2500 conf.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 index.rst \u2502\u00a0\u00a0 \u251c\u2500\u2500 index.rst\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 make.bat \u2502\u00a0\u00a0 \u251c\u2500\u2500 make.bat\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 Makefile \u2502\u00a0\u00a0 \u2514\u2500\u2500 Makefile\n \u251c\u2500\u2500 my_project/ \u251c\u2500\u2500 src/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py \u2502\u00a0\u00a0 \u2514\u2500\u2500 my_project/\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 main.py \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u251c\u2500\u2500 tests/ \u2502\u00a0\u00a0 \u2514\u2500\u2500 main.py\n \u2502 \u2514\u2500\u2500 test_main.py \u251c\u2500\u2500 tests/\n \u251c\u2500\u2500 LICENSE \u2502 \u2514\u2500\u2500 test_main.py\n \u251c\u2500\u2500 README.rst \u251c\u2500\u2500 LICENSE\n \u251c\u2500\u2500 setup.cfg \u251c\u2500\u2500 README.rst\n \u2514\u2500\u2500 setup.py \u251c\u2500\u2500 setup.cfg\n \u2514\u2500\u2500 setup.py\n\nYou can choose which tructure to use with the ``--format/-f`` option.\nAlso, if you do not provide the project name, *skelpy* will consider\nthe current directory name(the last component of the current working directory)\nto be the project name.\n\nFor more options, See ``skelpy -h``\n\nLicense\n=======\n*skelpy* is under the `MIT`_ license.\n\nAuthor\n======\ndks \n\nChange Log\n==========\n## [1.0.rc0] - 2019-04-13\n\n## [1.0.0] - 2019-05-31\n\nReference\n=========\nReference is available at \n`https://june3474.github.io/skelpy/api/modules.html `_\n\n.. _Pyscaffold: https://pyscaffold.org/en/latest/\n.. _Cookiecutter: https://cookiecutter.readthedocs.org/\n.. _MIT: https://choosealicense.com/licenses/mit/\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/june3474/skelpy", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "skelpy", "package_url": "https://pypi.org/project/skelpy/", "platform": "any", "project_url": "https://pypi.org/project/skelpy/", "project_urls": { "Homepage": "https://github.com/june3474/skelpy" }, "release_url": "https://pypi.org/project/skelpy/1.0.0/", "requires_dist": null, "requires_python": ">=2.7", "summary": "A simple template tool to create the skeleton for a python project", "version": "1.0.0" }, "last_serial": 5345403, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "d41d96b2de67feaabef2e41ad9dd1187", "sha256": "3023878023d1a72376af2237b9d251d8c1609dd5e50c0f2367ee75ff8c92360f" }, "downloads": -1, "filename": "skelpy-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d41d96b2de67feaabef2e41ad9dd1187", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7", "size": 82053, "upload_time": "2019-06-01T04:44:36", "url": "https://files.pythonhosted.org/packages/8b/a5/facfafe32c1da459ce21948846abeeaa4c802cf031e2abb44547d5471cd1/skelpy-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "86c21cdbf5928194a42bba090e44e4a2", "sha256": "c73899f33871fab6c4950fd046aaa3f5de26c4d6795ab54c307103b57fbd3716" }, "downloads": -1, "filename": "skelpy-1.0.0.tar.gz", "has_sig": false, "md5_digest": "86c21cdbf5928194a42bba090e44e4a2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 62761, "upload_time": "2019-06-01T04:44:38", "url": "https://files.pythonhosted.org/packages/f0/33/ae6383694c9630e44ed3a52b798ccd6ac65aadcc837089a9c7f4feae724e/skelpy-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d41d96b2de67feaabef2e41ad9dd1187", "sha256": "3023878023d1a72376af2237b9d251d8c1609dd5e50c0f2367ee75ff8c92360f" }, "downloads": -1, "filename": "skelpy-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d41d96b2de67feaabef2e41ad9dd1187", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7", "size": 82053, "upload_time": "2019-06-01T04:44:36", "url": "https://files.pythonhosted.org/packages/8b/a5/facfafe32c1da459ce21948846abeeaa4c802cf031e2abb44547d5471cd1/skelpy-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "86c21cdbf5928194a42bba090e44e4a2", "sha256": "c73899f33871fab6c4950fd046aaa3f5de26c4d6795ab54c307103b57fbd3716" }, "downloads": -1, "filename": "skelpy-1.0.0.tar.gz", "has_sig": false, "md5_digest": "86c21cdbf5928194a42bba090e44e4a2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 62761, "upload_time": "2019-06-01T04:44:38", "url": "https://files.pythonhosted.org/packages/f0/33/ae6383694c9630e44ed3a52b798ccd6ac65aadcc837089a9c7f4feae724e/skelpy-1.0.0.tar.gz" } ] }