template-python-miniconda-notebook

Opinionated Python + Miniconda template for new notebooks.

Getting Started

1. Go to or create the project folder.
2. Get the template files:

npx degit github:joaopalmeiro/template-python-miniconda-notebook

or

npx degit github:joaopalmeiro/template-python-miniconda-notebook --force

3. Search for template-python-miniconda-notebook and replace it with the project name. Ignore the template repository URL in the NOTES.md file.
4. Search for Opinionated [Python](https://www.python.org/) + [Miniconda](https://docs.anaconda.com/free/miniconda/) template for new notebooks. and replace it with the (short) project description.
5. Search for João Palmeiro and replace it with the author's name.
6. Open the environment.yml file and add the project-specific dependencies.
7. Delete the TEMPLATE.md file.
8. Delete the Getting Started section.

Development

Install Miniconda (if necessary).

conda env create -f environment.yml

conda env list

conda activate template-python-miniconda-notebook

conda list

jupyter lab

ruff check

ruff check --fix

ruff format

conda deactivate