https://github.com/utrechtuniversity/simple-python-template
simple template project
https://github.com/utrechtuniversity/simple-python-template
python template-project template-repository utrecht-university
Last synced: 6 months ago
JSON representation
simple template project
- Host: GitHub
- URL: https://github.com/utrechtuniversity/simple-python-template
- Owner: UtrechtUniversity
- License: mit
- Created: 2023-01-19T14:16:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T05:45:00.000Z (about 2 years ago)
- Last Synced: 2025-04-11T15:46:55.291Z (9 months ago)
- Topics: python, template-project, template-repository, utrecht-university
- Homepage:
- Size: 7.81 KB
- Stars: 2
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# re-simple-python-project
This simple project structure template repository is adapted from the [Good Enough Project](https://github.com/bvreede/good-enough-project) Cookiecutter template by Barbara Vreede (2019).
If you plan to develop a package, check the [template repository for a Python package](https://github.com/UtrechtUniversity/re-python-package).
## Usage
Click "Use this template" at the top of this page to create a new repository with the same folder structure.
## Project Structure
The project structure distinguishes three kinds of folders:
- read-only (RO): not edited by either code or researcher
- human-writeable (HW): edited by the researcher only.
- project-generated (PG): folders generated when running the code; these folders can be deleted or emptied and will be completely reconstituted as the project is run.
```
.
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── data <- All project data, ignored by git
│ ├── processed <- The final, canonical data sets for modeling. (PG)
│ ├── raw <- The original, immutable data dump. (RO)
│ └── temp <- Intermediate data that has been transformed. (PG)
├── docs <- Documentation notebook for users (HW)
│ ├── manuscript <- Manuscript source, e.g., LaTeX, Markdown, etc. (HW)
│ └── reports <- Other project reports and notebooks (e.g. Jupyter, .Rmd) (HW)
├── results
│ ├── figures <- Figures for the manuscript or reports (PG)
│ └── output <- Other output for the manuscript or reports (PG)
└── src <- Source code for this project (HW)
```
## Add a citation file
Create a citation file for your repository using [cffinit](https://citation-file-format.github.io/cff-initializer-javascript/#/)
## License
This project is licensed under the terms of the [MIT License](/LICENSE).