Startnewproject 🖥🗂️

This package includes a function to create a new project folderm with the desired tree, git and pylabnotebook initialized.

DEPENDENCY: this tool depends on git and pylabnotebook. Please install git and configure it prior to using this package.

Features

• Automatically create folder tree based on the configuration file
• Customizable configuration file
• Pre-compiled README in each folder, with the desired format (.txt, .md, or .html)
• Git initialization, with .gitignore and .gitattributes as well
• pylabnotebook initialization

Installation

To install the package, run:

pip install startnewproject

This will install the startnewproject package, as weel as its dependency; you can then run startnewproject function from within the terminal (detailed explanation below).

Start a new project

To start a new project, just run

startnewproject -n name_of_the_project

If you want to have spaces in your name, just wrap it into quotes. If the folder already exists, an error will be returned; use -f/--force to overwrite the existing folder. A folder is created with the default tree structure.

Costumize configuration

To use a costumize tree structure, you have to provide a configuration file structured like the one in templates/config.json as input with the -c/--config flag.
It must be a .json file containing as keys: "description" (a string, can be empty), "subfolders" (a dictionary of subfolders. Check the template to see an example), "files" (a list of file names, can be empty), ".gitignore" (a list of patterns to include in .gitignore), ".gitattributes" (a dictionary of things to include in .gitattributes. Check the template for an example).

Issue reporting and suggestions

If you find any issue or you want to suggest some edit, please feel free to open an issue or a pull request.