{ "info": { "author": "Calloway Project", "author_email": "webmaster@callowayproject.com", "bugtrack_url": null, "classifiers": [ "Framework :: Django" ], "description": "===================\nDjango App Skeleton\n===================\n\n:Version: 1.0.3\n:Docs: http://github.com/callowayproject/django-app-skeleton/\n:Download: http://pypi.python.org/pypi/django-app-skeleton/\n:Source: http://github.com/callowayproject/django-app-skeleton/\n\n==========\nChange Log\n==========\n\n* **1.0.3**\n * Bug fixes\n\n* **1.0.2**\n * Windows compatibility\n\n* **1.0.1**\n * Updated example app so the code is more up to date with django\n\n* **1.0**\n * Default configuration file `.djas`\n * Virtualenv creation is now optional\n * Added command-line argument for using virtualenv\n * `create_app` was renamed to `create_pkg`\n * App skeleton is compatible with django's `startapp` command\n * Bunch of code tweaks, should be easier to read and debug\n\nSee all the changes: https://github.com/callowayproject/django-app-skeleton/pull/6\n\n==========================================\nGenerating a Packagable Django Application\n==========================================\n\nThe ``create_pkg.py`` uses several variables to replace within a \"template\"\ndirectory. The default template directory is included and called \"skel\".\n\nRunning the script\n==================\n\nFirst, clone this repo or use `pip` to install the package::\n\n $ pip install django-app-skeleton\n\n\nThe script is interactive, although you can specify some options when you\ncall it. Calling the script is as easy as::\n\n\tpython create_pkg.py\n\nand the script will ask you for everything it needs.\n\n.. parsed-literal::\n\n **Package Name:** django-coolapp\n **App Name [coolapp]:**\n **Author [johnnycool]:** Johnny Cool\n **Author Email [johnnycool@example.com]:**\n **Destination DIR [/path/to/package/destination]:**\n **Template DIR [/path/to/package/template]:**\n **Use Virtualenv [n]:** y\n **Virtualenv Name [coolapp]:**\n\nYou can specify some or all of the options when calling the script.\n\nCommand-line Options\n--------------------\n\nBelow are the possible commands to supplied the `create_pkg.py` script. If any\nof the values are present, no prompt will be displayed for its value.\n\n-a, --author\n\tThe name of the author.\n\n-e, --email\n The email of the author\n\n-p, --package\n\tThe name of the installed package, like 'django-coolapp'.\n\n-n, --name\n\tThe name of the application, like 'coolapp'.\n\n-i, --use-venv\n Wheater or not to create a virtualenv\n\n-v, --virtenv\n\tThe name of the virtualenv to create. Only relative if `--use-venv` is `y`\n\n-d, --dest\n\tWhere to put the new package. Relative paths are recognized.\n\n-t, --template\n\tThe package template to use as a basis for the new application. Relative paths are recognized.\n\n\nDefault Command options\n=======================\n\nWhen the script is first run prompted you for the values or if they are supplied\nvia the command-line arguments, some of the values are set as defaults.\n\nA configuration filed located at `~/.djas` is created. Below is an example\nconfiguration.\n\n.. parsed-literal::\n\n [main]\n author = Johnny Cool\n author_email = johnnycool@example.com\n destination_dir = /path/to/package/destination\n template_dir = /path/to/package/template\n use_venv = n\n\n\nUsing just the app skeleton\n===========================\n\nIf all you want is the `app` skeleton, you can use the following command::\n\n $ django-admin.py startapp --template=/path/to/django-app-skeleton/skel/app_name\n\n.. note::\n\n Our `skeleton` is a **package** skeletion, and django's\n `startapp` command expects a **app** skeletion. Therefore the path above\n points to just our **app** skeleton.\n\n\nVariable Substitution\n=====================\n\nThe script creates several substitution variables that it uses to substitute\nfor file names and within text files. If you want to create a custom package\ntemplate, below are the possible variables supplied to each file in the\nskeleton.\n\n\n`app_name`\n\tThe name supplied by ``-n``\\ , ``--name``\\ , or the answer to *Application name*.\n\n`pkg_name`\n\tThe name supplied by ``-p``\\ , ``--package``\\ , or the answer to *Package name*. The default is the ``APP_NAME`` without ``django-``\\ .\n\n`pkg_author`\n\tThe value supplied by ``-a``\\ , ``--author``\\ , or the answer to *Author*. The default is the current user name.\n\n`pkg_author_email`\n The value supplied by ``-e``\\, ``--author_email``\\, or the answer to *Author Email*.\n\n`secret_key`\n\tA randomly generated string of characters used in the ``settings.py`` file.\n\n`venv`\n\tThe name supplied by ``-v``\\ , ``--virtenv``\\ , or the answer to *Virtual environment name*. The default is the ``APP_NAME``\\ .\n\nThe variables are referenced by surrounding them with ``{{``\\ , such as\n``{{app_name}}``\\ . Here is an example from the setup.py file::\n\n\tsetup(\n\t name = \"{{app_name}}\",\n\t version = __import__('{{pkg_name}}').get_version().replace(' ', '-'),\n\t url = '',\n\t author = '{{pkg_author}}',\n\n.. note::\n\n Previously `$$$$` was used, this was changed to be `{{` in order for the\n template, i.e. `/skel/app_name` to be usable with\n `django-admin.py startapp --template=...`, see below.\n\n In addition to `{{ .. }}`, anything with the name folder name `app_name` is\n also replaced with its correct value. This is also so make the **app**\n skeleton compatible with django's `startapp` command.\n\n\nOther Notes\n===========\n\nThe supplied ``example`` (skel/app_name/example/) application demonstrates\nhow you might reference your new application within a project. To clarify,\nthe project name refers to the parent directory created by ``create_pkg``\nscript, if none is supplied using the ``-d`` switch, while the app name refers to\nyour initial application name, development directory, etc. It is this latter\nname you will find populated, as expected, in the ``example/settings.py`` file.\n\nNote: Please don't get confused by this when using identical names for both\nproject and application -- only the application name counts unless you\nintentionally change some related setting(s).\n\n\nContributors\n============\n\n* Eric Florenzano\n* Corey Oordt\n* Jose Soares\n* Justin Quick\n* Adam Patterson\n* Ben Margoli", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/callowayproject/django-app-skeleton", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "django-app-skeleton", "package_url": "https://pypi.org/project/django-app-skeleton/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-app-skeleton/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/callowayproject/django-app-skeleton" }, "release_url": "https://pypi.org/project/django-app-skeleton/1.0.4/", "requires_dist": null, "requires_python": null, "summary": "A basic skeleton and script to make a packageable django application", "version": "1.0.4" }, "last_serial": 820931, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "646352ede22f770b7dc60860825ec616", "sha256": "d0d905f718e468c0b04c2c9762309155a09630d92b9691f5d0142f543aa3c37b" }, "downloads": -1, "filename": "django-app-skeleton-1.0.tar.gz", "has_sig": false, "md5_digest": "646352ede22f770b7dc60860825ec616", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 248572, "upload_time": "2013-01-28T02:34:37", "url": "https://files.pythonhosted.org/packages/79/0a/5265c3b4ffa2e32fec229a3277fd07484f44f49e265aa2126294fe783c86/django-app-skeleton-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "ae9eaec39d9b33910bb0ae8f7cabcc5f", "sha256": "3f2959f71697a3dac4ecd4b5f3f6d97241bf3c0369763583ff0b448c8de47d25" }, "downloads": -1, "filename": "django-app-skeleton-1.0.1.tar.gz", "has_sig": false, "md5_digest": "ae9eaec39d9b33910bb0ae8f7cabcc5f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 250135, "upload_time": "2013-01-31T04:09:49", "url": "https://files.pythonhosted.org/packages/6f/90/9051680353e297e98478156dad8592f25436d56cd01715e304aa7ee2790c/django-app-skeleton-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "0cbe963565c67581231bc4e205c8a165", "sha256": "80c8f40a64830b5d785fc0e45100af8d51249ceda251583ce63fda55c3d91884" }, "downloads": -1, "filename": "django-app-skeleton-1.0.2.tar.gz", "has_sig": false, "md5_digest": "0cbe963565c67581231bc4e205c8a165", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 250223, "upload_time": "2013-02-04T01:30:47", "url": "https://files.pythonhosted.org/packages/4f/3c/08525251771e64f7b7bdee43745b47d165747a8f2bb0abf2341f1fc8ca76/django-app-skeleton-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "cbae53b9cdad4a0e3b8a9440a25ce631", "sha256": "9d3f0d871c7c18d957b38bd931ef63abb2a344362102a8f94633b212b8bb6ddc" }, "downloads": -1, "filename": "django-app-skeleton-1.0.3.tar.gz", "has_sig": false, "md5_digest": "cbae53b9cdad4a0e3b8a9440a25ce631", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 250331, "upload_time": "2013-02-05T04:26:58", "url": "https://files.pythonhosted.org/packages/30/82/87994cdfef0ef2ed007a2ab1e1c45ce402e8f838a64aad043c825e2ff843/django-app-skeleton-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "7934d75a2a78e0f43a56675b08b5c9bf", "sha256": "f2e37e45de78afc8ad754a663a53dda471bcd38d54938a445abb5e7c8422a2df" }, "downloads": -1, "filename": "django-app-skeleton-1.0.4.tar.gz", "has_sig": false, "md5_digest": "7934d75a2a78e0f43a56675b08b5c9bf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 247797, "upload_time": "2013-03-20T19:50:00", "url": "https://files.pythonhosted.org/packages/d9/13/459896bae5175ff8bf816f7f221d03e7b937141e91a9bf5b51ea6d374f90/django-app-skeleton-1.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7934d75a2a78e0f43a56675b08b5c9bf", "sha256": "f2e37e45de78afc8ad754a663a53dda471bcd38d54938a445abb5e7c8422a2df" }, "downloads": -1, "filename": "django-app-skeleton-1.0.4.tar.gz", "has_sig": false, "md5_digest": "7934d75a2a78e0f43a56675b08b5c9bf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 247797, "upload_time": "2013-03-20T19:50:00", "url": "https://files.pythonhosted.org/packages/d9/13/459896bae5175ff8bf816f7f221d03e7b937141e91a9bf5b51ea6d374f90/django-app-skeleton-1.0.4.tar.gz" } ] }