Metadata-Version: 1.1
Name: superdir
Version: 0.1.3
Summary: Turn that text file into a file tree!
Home-page: http://github.com/foundling/superdir
Author: Alex Ramsdell
Author-email: alexramsdell@gmail.com
License: MIT
Description: ![superdir_header](https://github.com/foundling/superdir/blob/master/superdir_logo.png)
        
        `superdir` is a command-line tool for Linux, BSD, and OSX that generates a directory tree from a reasonable, consistently-indented flat file representation.  It is MIT-licensed.
        
        ## Installation:
        
        ````bash
        pip install Superdir
        ````
        
        ## Usage:
        
        ````bash
        superdir SCHEMA_FILE [OUTPUT_DIR]
        ````
        
        ## Contributing
        
        See here for the [contributors guide](https://github.com/foundling/superdir/blob/master/CONTRIBUTING.md). 
        
        
        ## Parsing Rules:
        
        - `superdir` creates the directory structure from the schema only if it passes validation.
        - By default, lines that end with '`/`' are treated as directories. Everything else is treated as a file. 
        - Comments are prefixed with a '`#`'.
        - Comments and blank lines are ignored.
        - If an `OUTPUT_DIR` argument is **not** given, the schema must contain a single top-level directory.
        - If an `OUTPUT_DIR` argument is given, the schema file may contain multiple top-level directories.
        - If the `OUTPUT_DIR` already exists, it won't be overwritten. 
        
        ## Superdir in action!
        
        ````bash
        $ cat schema.txt
        
        # Flat-file example of a directory structure
        superdir/
            docs/
            superdir/
                superdir.py
                validator.py
                tree.py
            test/
                superdir_test.py
                validator_test.py
                tree_test.py
            README.md
            LICENSE.md
            test/
        
        $ superdir schema.txt new_project 
        $ tree
        new_project
        └── superdir/
            └── docs/
            └── superdir/
                └── superdir.py
                └── validator.py
                └── tree.py
            └── test/
                └── superdir_test.py
                └── validator_test.py
                └── tree_test.py
            └── README.md
            └── LICENSE.md
        ````
        
Keywords: cli productivity
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
