Metadata-Version: 2.1
Name: Quickdir
Version: 0.0.1
Summary: A package to create complex directories in single step using JSON objects.
Home-page: https://github.com/Viwarrior/Quickdir
Author: Avinash
Author-email: avinashwc2011@gmail.com
License: UNKNOWN
Description: # Quickdir
        JSON object to quick directory creator using python.
        
        ## Installation
        
        ```bash
        pip install Quickdir
        ```
        
        ## Usage
        
        In Json object structure, terminating values has to be supplied to end(leaf) nodes in dir structure. Supply 1 if it ends with a file, 0 if it ends with a folder.
        
        ```json
        json = {"folder": {
                        "subfolder": {
                                "subsubfolder": 0,
                                "file.txt": 1
                            }
                 }
        
        ```
        
        Creating directories using Quickdir object
        ```python
        from Quickdir import Quickdir
        
        # create object of Quickdir class 
        quick = Quickdir("Quickdir")
        
        # give custom path instead of 'Quickdir' if required
        quick2 = Quickdir("S:/Files")
        
        # create your dir structure as dict/json
        x = {"root": {
            "folder1":{
                "subfolder1":0,
                "file1.txt": 1
                }
            }
        }
        
        
        # make directories
        quick.make(x)
        ```
        
        ## Applications
        Example 1: HTML project
        ```python
        html = {"root": {
                        "logs": {
                                "test": 0,
                                "log.txt": 1
                            },
                        "css" : {
                                "style.css" : 1,
                                "bootstrap.css": 1
                            },
                        "js": {
                                "mainFunction.js":1,
                                "bootstrap.js":1,
                                "jquery.js":1
                            },
                        "common":{
                                "navbar.html" :1,
                                "footer.html" :1
                            },
                        "Readme.md": 1,
                        "fonts": {
                            "sample.txt" :1
                          },
                        "img": 0,
                        "index.html":1
                        
                } 
            }
        
        ```
        
        
        Example 2: Creating directory structure for a College course.
        ```python
        college = {"CSE420": {
                        "cat1": {
                                "alternate material": 0,
                                "notes.txt": 1
                            },
                        "cat2": {
                                "alternate material": 0,
                                "notes.txt": 1
                            },
                        "lab" : {
                                "1":0,
                                "2":0, 
                                "3":0,
                                "4":0,
                                "5":0,
                                "midterm":0,
                                "labfat":0,
                                "notes.txt": 1
                            },
                        "DA": {
                                "1":0,
                                "2":0
                            },
                        "FAT":{
                                "notes.txt" :1
                            },
                        "project": {
                                "review 1": 0,
                                "review 2": 0,
                                "review 3": 0,
                                "code": {
                                          "test.py":1  
                                }
                            },
                        
                        "syllabus": 0
                        
                } 
            }
        ```
        
        Accessing premade application templates
        ```python
        from Quickdir import config
        
        # college
        x = config.college
        
        # html
        x = config.html
        ```
        
        ## Contributing
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        
        
        ## License
        [MIT](https://choosealicense.com/licenses/mit/)
        
        
        &copy; 2020 Avinash 
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
