FileCreator

This file creator creates files based on the given parameters. You can pass in a path to a json file or give the list instead. The concept is that you don't need to touch the code if you have to change some recurring tasks (if you use json).

How to install

There are no extra modules needed. You can copy the filecreator folder to your project.

Quick Usage

To use this small module you can import it, initialize and run. The example can be found in the main.py file.

from filecreator import FileCreator
data = [
    {"filename": "Myfile.txt", "path": [], "default": "Default MyFile"},
    {"filename": "MyOtherFile.txt", "path": ["testfoler"], "default": "Default OtherFile"}
]

# Initialize
creator = FileCreator("files.json", data)
# run the creator
creator.run()

This will create the requested files in the requested directories.

FileCreator class

The class has the following parameters when you create an instance of the class:
filecreator.FileCreator(json_path:str=None, data:List=None)

json_path: Default=None - The path to the json file as a string (I recommend the os module with os.path.join() if it is deeper in the filesystem).
data: Default=None - If you already have the data, you can provide it here as a list of dictonaries.
json_key: Default=None - Key where the JSON file contains the filelist as a string.
json_position: Default=0 - Integer position where JSON file contains the filelist. If nothing is provided at the key it will take the first position, but you can pass a higher position if nessesary (see JSON Format for more information).

If json_path and data have values they will be merged together. The order is json_path->data.

Format

Each list entry is a dictonary. The structure needs to be the following:

data = [
    {"filename": "Myfile.txt", "path": [], "default": "Default MyFile"},
    {"filename": "MyOtherFile.txt", "path": ["testfolder"], "default": "Default OtherFile"}
]

filename is the name of the file.
path is the path where the file needs to be located. It is a list with folders. If the tree does not exist it will be created. If the file has to be created in the same directory, you pass an empty list.
default is the content of the file. It can be left empty if no default is needed.

JSON Format

The JSON file has to look like this:

{
    "data": [
        {"filename": "file1.txt", "path": ["testfolder", "testfolder2"], "default": "This is the default of File 1" },
        {"filename": "file2.txt", "path": ["testfolder"], "default": "" }
        ]
}