From 4699264e2f5b2f59a420caa5190637ab5d22236e Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha Date: Mon, 17 Jun 2024 01:38:27 +0200 Subject: [PATCH] fixes #2156 --- docs/INSTALL.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index d00be9158..0426d95a4 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -39,6 +39,14 @@ pipx install sherlock-project ### Build live package from source (useful for contributors) +> [!Note] +> With the use of Poetry, there is no need for a requirements.txt file. Dependencies are specified within the pyproject file, which is referenced by pip during the build process. +> +> If needed for some workflow, this file can be generated dynamically via the following... +> ```bash +> poetry export --without-hashes -f requirements.txt --output requirements.txt +> ``` + Building an editable (or live) package links the entry point to your current directory, rather than to the standard install location. This is often useful when working with the code base, as changes are reflected immediately without reinstallation. Note that the version number will be 0.0.0 for pipx local builds unless manually changed in the pyproject file (it will prompt the user for an update). @@ -57,6 +65,7 @@ If you'd rather not install directly to your system, you can import the module a python3 -m sherlock user123 user789 ``` +

Docker Docker Image Version