Mirrors/sherlock
2
0
Fork 0
mirror of https://github.com/sherlock-project/sherlock synced 2024-11-24 21:03:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update docs with module changes

Browse source
This commit is contained in:
Paul Pfeister 2024-05-16 23:47:10 -04:00
parent 63a1c1448a
commit ea1c421838
2 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/README.md
View file

@ -133,15 +133,10 @@ Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)
[docs_install]: /docs/install.md [docs_install]: /docs/install.md
[docs_docker]: /docs/install.md#docker [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]: /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]: /docs/CONTRIBUTING.md
[docs_contrib_adding_targets]: /docs/CONTRIBUTING.md#adding-targets [docs_contrib_adding_targets]: /docs/CONTRIBUTING.md#adding-targets
[docs_contrib_removing_targets]: /docs/CONTRIBUTING.md#removing-targets [docs_contrib_removing_targets]: /docs/CONTRIBUTING.md#removing-targets
[docs_contrib_restoring_targets]: /docs/CONTRIBUTING.md#restoring-targets [docs_contrib_restoring_targets]: /docs/CONTRIBUTING.md#restoring-targets
[ext_pypi]: https://pypi.org/project/sherlock-project/ [ext_pypi]: https://pypi.org/project/sherlock-project/
[ext_brew]: https://formulae.brew.sh/formula/sherlock [ext_brew]: https://formulae.brew.sh/formula/sherlock

19
docs/install.md
View file

@ -37,13 +37,22 @@ Python
pipx install sherlock-project 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 ```bash
# pipx is recommended, but pip may suffice if pipx is unavailable # Assumes repository cloned, and pwd is repository root
git clone https://github.com/sherlock-project/sherlock.git pipx install -e .
cd sherlock ```
pipx install .
### 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
``` ```
<h2> <h2>