/project-initialisation

Script to automate the initialisation of an academic python project.

Primary LanguageShellMIT LicenseMIT

Optimal PSE logo

Project initialisation

License: MIT

This bash script will instantiate a folder for an academic python project. It will:

  1. Initialise a new git repository for the project;
  2. Construct a basic README.md for the project and documentation;
  3. Create a reccomended python project file structure;
  4. Create additional folders for literature, preprints, slides and papers (these are ignored by git);
  5. Clone the ArXiv preprint template into the preprint folder (as a git submodule);
  6. Create a Conda environment for the project, and a respective environment.yml file containing basic packages;
  7. Include black and flake8 python formatter and style guide within git hooks, ensuring that these are included within pre-commit checks;
  8. Associate the MIT License to the project;
  9. Commit changes to the main branch, and create and switch to a develop branch following the gitflow branching model.

Usage

$ bash project_init.sh

Requirements

  • Unix based

Note

  • MIT License and README files are specific to the OptiMaL-PSE Group at Imperial College London.

Author - Tom Savage, 3/9/2021