From ea1c4218382985f5148388d2d27609412c976389 Mon Sep 17 00:00:00 2001 From: Paul Pfeister Date: Thu, 16 May 2024 23:47:10 -0400 Subject: [PATCH] Update docs with module changes --- docs/README.md | 5 ----- docs/install.md | 19 ++++++++++++++----- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index 9f3c413..5835de4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -133,15 +133,10 @@ Original Creator - [Siddharth Dushantha](https://github.com/sdushantha) [docs_install]: /docs/install.md [docs_docker]: /docs/install.md#docker -[docs_docker_dockerhub]: /docs/install.md#docker -[docs_docker_compose]: /docs/install.md#using-compose -[docs_docker_source]: /docs/install.md#build-image-from-source-useful-for-contributors [docs_py]: /docs/install.md#python -[docs_py_build]: /docs/install.md#build-python-package-from-source-useful-for-contributors [docs_contrib]: /docs/CONTRIBUTING.md [docs_contrib_adding_targets]: /docs/CONTRIBUTING.md#adding-targets [docs_contrib_removing_targets]: /docs/CONTRIBUTING.md#removing-targets [docs_contrib_restoring_targets]: /docs/CONTRIBUTING.md#restoring-targets [ext_pypi]: https://pypi.org/project/sherlock-project/ [ext_brew]: https://formulae.brew.sh/formula/sherlock - diff --git a/docs/install.md b/docs/install.md index 9813a09..0a5069d 100644 --- a/docs/install.md +++ b/docs/install.md @@ -37,13 +37,22 @@ Python pipx install sherlock-project ``` -### Build python package from source (useful for contributors) +### Build live package from source (useful for contributors) + +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. ```bash -# pipx is recommended, but pip may suffice if pipx is unavailable -git clone https://github.com/sherlock-project/sherlock.git -cd sherlock -pipx install . +# Assumes repository cloned, and pwd is repository root +pipx install -e . +``` + +### Run package from source (no install) + +If you'd rather not install directly to your system, you can import the module at runtime with `-m`. + +```bash +# Assumes repository cloned, and pwd is repository root +python3 -m sherlock user123 user789 ```