This is a set of simple Python utility scripts designed to keep your coding projects perfectly organized, regardless of the platform or language.
The tools automate the setup, naming, and documentation process for any structured collection of files.
These three scripts work together using the info.txt file as their central data source.
- What it does: Scans your existing project folders and files, and prints the data in the required
info.txtformat (Folder Namefollowed by a["File 1", "File 2"]list). - Run When: You need to update your data file from your current directory structure.
- Use Case: Perfect for when you've manually created folders and files and want to generate the
info.txtfor further automation to make clickable documentation for README files..
- What it does: Reads the
info.txtfile and automatically creates all necessary, serial-numbered project folders (e.g.,01_Basics) and solution files (e.g.,01_Problem_Title.py). - Run When: You need to create a large number of empty files and folders for a new section of your project.
- Use Case: Ideal for bootstrapping new coding projects or sections where you want a consistent structure without manually creating each file.
- What it does: Reads the
info.txtdata and generates aproject_list.mdfile. This file contains clickable Markdown links for every single file you created. - Run When: You need to generate the final, clean list of all your work for documentation or sharing.
- Use Case: Great for GitHub README files! It'll make your readme look super organized and professional.
You can easily customize the scripts to fit your specific needs. I commented the key sections in each script where you can make changes:
- Data Format: Modify the
info.txtformat if you have a different way of organizing your project data. - File Extensions: Change the file extensions in
file_creator.pyto match your programming language (e.g.,.js,.java, etc.). - Header Templates: Modify the header templates in
file_creator.pyto include your name, date, or any other metadata you want at the top of each file. - Directory Structure: Change the folder and file naming conventions in
file_creator.pyto match your project's requirements. (e.g., adding prefixes, suffixes, numerical serialization etc.). - Output Formats: Adjust the output format in
project_lister.pyto suit your documentation style. - Link Style: Change how links are formatted in
project_lister.py(e.g., relative vs absolute paths).
- Make your
info.txtfile with the Generator script if you don't already have one. - Place your project data in
info.txt. - Run the appropriate script to create files or documentation.
If you have any feedback or ideas to improve this project, feel free to contact me via