Skip to content
/ Patl Public

Patl helps you in creating a nice, monitorable structure for your files and folder of your big project.

License

Notifications You must be signed in to change notification settings

Ajay1290/Patl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Patl

Patl is a Python package which helps you in creating a monitorable structure for your files and folder of your big project.

Installing


Install and update using pip:

> pip install patl

A Simple Example


In order to use patl you first have to create a patl.json file in your project's root area.

Inside patl.json you have to structure your files and folder in such a perfect manner that how you wanted to arrange them and afterall we are all doing this is a JSON file we have to follow a certain kind of rules in order to structure our project.

  • Each file and folder's name must be as key holder.

  • Each file's value must be null to recognize it as a file.

e.g: 
    { "index.js" : null }
  • Each folder's value must be {} to recognize it as a folder.
e.g:
    { 
        "empty_folder" : {},
        "folder":{ "index.js" : null } 
    }
    

After constructing your structure in patl.json file you have to open your terminal and change your current working directory to folder where patl.json file is located.

To Scan Project Layout


Here you have to use -s flag in order to scan files and folders and take it to patl.json file

    path/to/patl.json> patl -s

To Create Project Layout


Here you have to use -c flag in order to create files and folders as you described inside patl.json

    path/to/patl.json> patl -c

To Remove Project Layout


Here you have to use -r flag in order to remove files and folders as you described inside patl.json

    path/to/patl.json> patl -r

Links

About

Patl helps you in creating a nice, monitorable structure for your files and folder of your big project.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages