From 46c316448d221e0e8f28a6e2351ca1b1f5f023f5 Mon Sep 17 00:00:00 2001 From: Steph Merritt <97111051+astronomerritt@users.noreply.github.com> Date: Fri, 16 Feb 2024 14:53:14 +0000 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 711d635..d528af6 100644 --- a/README.md +++ b/README.md @@ -60,3 +60,24 @@ Notes: into documentation for ReadTheDocs works as expected. For more information, see the Python Project Template documentation on [Sphinx and Python Notebooks](https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks) + +## Dev Guide - Updating pyproject.toml + +If you are adding code that requires a new dependency, this needs to be included in pyproject.toml under the `[project]' section: + +``` +dependencies = [ + "ipykernel", # Support for Jupyter notebooks + "numpy", + "lsst-rsp" + "your-dependency-here" +] +``` + +If you are adding code that should be run from the command line, this should be set up under `[project.scripts]`: + +``` +[project.scripts] +adler = "adler.adler:main" +my_command = "adler.module_folder.module_name:function_name" +```