{ "info": { "author": "Alex Ramsdell", "author_email": "alexramsdell@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3" ], "description": "[![Build Status](https://travis-ci.org/foundling/superdir.svg?branch=master)](https://travis-ci.org/foundling/superdir)\n\n[![PyPI version](https://badge.fury.io/py/superdir.svg)](https://badge.fury.io/py/superdir)\n\n![superdir_header](https://github.com/foundling/superdir/blob/master/media/superdir_logo.png)\n\n`superdir` is a command-line tool for Linux and OSX that generates a directory tree from a reasonable, consistently-indented flat file representation. It is MIT-licensed.\n\n## Installation:\n\n````bash\npip install superdir\n````\n\n## Dependencies\n\n````bash\nclick\n````\n\n## Usage:\n\n````bash\n\nUsage: superdir [OPTIONS] SCHEMA_FILE\n\nOptions:\n -o, --outfile TEXT Filename of the directory to contain your superdir'd\n files\n -c, --config TEXT Config file to read before superdir'ing your schema\n -h, --help Show this message and exit.\n\n````\n\n## Contributing\n\nSee here for the [contributors guide](https://github.com/foundling/superdir/blob/master/CONTRIBUTING.md). \n\n\n## Motivation:\n\n`superdir` is a simple and quick way to generate a directory structure without code. All you need is a schema file that you can generate yourself or copy from a tutorial you're following along with. Pipe it to `superdir` or pass it as a filename argument, and off you go.\n\n## Behavior:\n\n- `superdir` will not overwrite any existing files or directories and creates the directory structure from your schema only if it passes validation.\n- By default, lines that end with '`/`' are treated as directories. Everything else is treated as a file. \n- Comments should be prefixed by '`#`'.\n- Comments and blank lines are ignored.\n- If no `OUTPUT_DIR` option is given, the schema must contain exactly one top-level directory with no sibling files.\n- If an `OUTPUT_DIR` option is given, the schema file may contain one or more top-level directories and or files.\n\n## Hooks:\n\nHooks will let you copy a pre-existing file's content into a file created from your schema. To take advantage of hooks, pass the `-c` or `--config` flag with a filepath relative to your $HOME directory. In the config file, add an equal-delimited list of key-value pairs, where the key is the filename and the value is the filepath for the file you want to copy. Here's an example:\n\n````bash\n# config file in $HOME/.superdir_hooks \n\n# pattern to match from schema -> template location \nindex.html = ~/apps/lib/html/index.html\nstyles.css = ~/apps/lib/css/styles.css\n\n````\n\nIn the process of building the tree, if `superdir` comes across a matching file key, it will write the corresponding content from the file into the file tree's resulting file.\n\n## superdir in action!\n\n````bash\n\n# this a valid schema file\n$ cat schema.txt\nsuperdir/\n docs/\n # comments and blank lines are ignored\n superdir/\n superdir.py\n validator.py\n tree.py\n test/\n superdir_test.py\n validator_test.py\n tree_test.py\n README.md\n LICENSE.md\n test/\n\n# creating a directory tree from the schema file\n$ superdir schema.txt -o new_project && tree new_project \nnew_project\n\u2514\u2500\u2500 superdir/\n \u2514\u2500\u2500 docs/\n \u2514\u2500\u2500 superdir/\n \u2514\u2500\u2500 superdir.py\n \u2514\u2500\u2500 validator.py\n \u2514\u2500\u2500 tree.py\n \u2514\u2500\u2500 test/\n \u2514\u2500\u2500 superdir_test.py\n \u2514\u2500\u2500 validator_test.py\n \u2514\u2500\u2500 tree_test.py\n \u2514\u2500\u2500 README.md\n \u2514\u2500\u2500 LICENSE.md\n\n# Piping schema.txt into superdir \n$ cat schema.txt | superdir -o another_new_project && tree another_new_project\nanother_new_project\n\u2514\u2500\u2500 superdir/\n \u2514\u2500\u2500 docs/\n \u2514\u2500\u2500 superdir/\n \u2514\u2500\u2500 superdir.py\n \u2514\u2500\u2500 validator.py\n \u2514\u2500\u2500 tree.py\n \u2514\u2500\u2500 test/\n \u2514\u2500\u2500 superdir_test.py\n \u2514\u2500\u2500 validator_test.py\n \u2514\u2500\u2500 tree_test.py\n \u2514\u2500\u2500 README.md\n \u2514\u2500\u2500 LICENSE.md\n````", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/foundling/superdir", "keywords": "cli productivity", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "superdir", "package_url": "https://pypi.org/project/superdir/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/superdir/", "project_urls": { "Homepage": "http://github.com/foundling/superdir" }, "release_url": "https://pypi.org/project/superdir/0.1.6/", "requires_dist": null, "requires_python": "", "summary": "Turn that text file into a file tree!", "version": "0.1.6" }, "last_serial": 2304149, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "ce0d49bb3d73506d811dd8e6bae53239", "sha256": "021694311c1d8a7f0ad69e325e4e565a85bea6d562686dbd70d3c9d6a3df6f3a" }, "downloads": -1, "filename": "superdir-0.1.0.tar.gz", "has_sig": false, "md5_digest": "ce0d49bb3d73506d811dd8e6bae53239", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5184, "upload_time": "2016-08-10T23:07:16", "url": "https://files.pythonhosted.org/packages/06/26/cc78ffa57fc4a76bb4ad40d48cb3649b3b2410d669149254ee93cb545ae7/superdir-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "cf09808b3a5e84f702bfdc43c645f061", "sha256": "9a9528ab891b4531b51b1a6eb30a804043584c3bbbad60f8f3a35f809f3aa1f1" }, "downloads": -1, "filename": "superdir-0.1.1.tar.gz", "has_sig": false, "md5_digest": "cf09808b3a5e84f702bfdc43c645f061", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5390, "upload_time": "2016-08-10T23:16:13", "url": "https://files.pythonhosted.org/packages/34/af/9a22102b4a066a0a93b01e6ec62adc5260769bfed55310e3b6858cce53ba/superdir-0.1.1.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "55946ed46ca2af05dcb7866dd361b041", "sha256": "852da19a56e0f88f8a8d7cb80b1c25524a42ff690439abb7503843d66833f283" }, "downloads": -1, "filename": "superdir-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "55946ed46ca2af05dcb7866dd361b041", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8407, "upload_time": "2016-08-11T00:18:27", "url": "https://files.pythonhosted.org/packages/5f/19/3b0c40a3c1ac61e01738c3e34b7c2092dfa3231e7dc11d631aa29abf47ff/superdir-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0f3e0d07d6e70c71a939e97180ae29b4", "sha256": "0bba73e042312bdc2baad14280b72e9cdbb7c48a1ea782d90708ac669f1140a9" }, "downloads": -1, "filename": "superdir-0.1.3.tar.gz", "has_sig": false, "md5_digest": "0f3e0d07d6e70c71a939e97180ae29b4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8024, "upload_time": "2016-08-11T00:18:29", "url": "https://files.pythonhosted.org/packages/b2/7f/0cdabe2c3bb133693ce07c15e6777e7b3afb4d536ffb8f786ddf6a73a7c7/superdir-0.1.3.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "26bb6f4dcafbba0ea0172872798c9d23", "sha256": "4c46100d1473666859db721499821724df40670a35ded5a5d075c0c0908701e6" }, "downloads": -1, "filename": "superdir-0.1.5.macosx-10.11-intel.tar.gz", "has_sig": false, "md5_digest": "26bb6f4dcafbba0ea0172872798c9d23", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11940, "upload_time": "2016-08-25T17:24:36", "url": "https://files.pythonhosted.org/packages/97/63/28eec6bdcfde6006fe164a57bf5375733b415ecd6966c6149cb485917091/superdir-0.1.5.macosx-10.11-intel.tar.gz" }, { "comment_text": "", "digests": { "md5": "e327ee0034bec128007fd83cbcfb6de8", "sha256": "58258bd24e2c5fe89ea5c56b047e2d090f8276bf1dc652930824d893a45b1aea" }, "downloads": -1, "filename": "superdir-0.1.5.tar.gz", "has_sig": false, "md5_digest": "e327ee0034bec128007fd83cbcfb6de8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10478, "upload_time": "2016-08-25T17:24:40", "url": "https://files.pythonhosted.org/packages/38/35/3ac7911e9b90817e87ae8844fce603b720d7d8323495e91e69b5cfe4b9b6/superdir-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "73e56e42d1316eea68d504e13d955670", "sha256": "abdf4755766d7b77338067a6f786a05fc5daccaec9584c83bcb64d4d47833abb" }, "downloads": -1, "filename": "superdir-0.1.6.macosx-10.11-intel.tar.gz", "has_sig": false, "md5_digest": "73e56e42d1316eea68d504e13d955670", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12335, "upload_time": "2016-08-25T18:50:13", "url": "https://files.pythonhosted.org/packages/20/2e/825ea363c59deef6e643addb4ff1b202e5427d7fabbb0249579bb3fa4bd9/superdir-0.1.6.macosx-10.11-intel.tar.gz" }, { "comment_text": "", "digests": { "md5": "0a71667894354784f4da29a7f6c65513", "sha256": "6b7c882af24c1c373ec8a36a44fbb93e96e908586f296733de2d4f9d2026e244" }, "downloads": -1, "filename": "superdir-0.1.6.tar.gz", "has_sig": false, "md5_digest": "0a71667894354784f4da29a7f6c65513", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10707, "upload_time": "2016-08-25T18:50:17", "url": "https://files.pythonhosted.org/packages/3e/d5/d4a9da099ec67e268827b9b0078a1151a9fc1acd9edae68d15ad1746f3d4/superdir-0.1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "73e56e42d1316eea68d504e13d955670", "sha256": "abdf4755766d7b77338067a6f786a05fc5daccaec9584c83bcb64d4d47833abb" }, "downloads": -1, "filename": "superdir-0.1.6.macosx-10.11-intel.tar.gz", "has_sig": false, "md5_digest": "73e56e42d1316eea68d504e13d955670", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12335, "upload_time": "2016-08-25T18:50:13", "url": "https://files.pythonhosted.org/packages/20/2e/825ea363c59deef6e643addb4ff1b202e5427d7fabbb0249579bb3fa4bd9/superdir-0.1.6.macosx-10.11-intel.tar.gz" }, { "comment_text": "", "digests": { "md5": "0a71667894354784f4da29a7f6c65513", "sha256": "6b7c882af24c1c373ec8a36a44fbb93e96e908586f296733de2d4f9d2026e244" }, "downloads": -1, "filename": "superdir-0.1.6.tar.gz", "has_sig": false, "md5_digest": "0a71667894354784f4da29a7f6c65513", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10707, "upload_time": "2016-08-25T18:50:17", "url": "https://files.pythonhosted.org/packages/3e/d5/d4a9da099ec67e268827b9b0078a1151a9fc1acd9edae68d15ad1746f3d4/superdir-0.1.6.tar.gz" } ] }