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

Merge pull request #2160 from sherlock-project/feature/better-docu

Browse source 
Update install docs
This commit is contained in:
Siddharth Dushantha 2024-06-17 00:37:26 +00:00 committed by GitHub
commit 923fa4cd0e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/INSTALL.md
View file

@ -39,6 +39,15 @@ pipx install sherlock-project
### Build live package from source (useful for contributors)
> [!Note]
> With the switch to Poetry, Sherlock no longer requires a `requirements.txt` file. Dependencies are now specified within the `pyproject.toml` file.
>
> If the legacy `requirements.txt` file is still desired, it can be dynamically generated:
> ```bash
> # Append `--with dev` or `--only dev` to include dev dependencies
> 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).

6
docs/README.md
View file

@ -30,8 +30,12 @@
| | Command | Notes |
| - | - | - |
| PyPI | `pipx install sherlock-project` | `pip` may be used in place of `pipx` |
| Homebrew | `brew install sherlock` | Community supported |
| Docker | `docker pull sherlock/sherlock` | |
| Debian family | `apt install sherlock` | Kali, Parrot, Debian Testing and Sid |
| BlackArch | `pacman -S sherlock` | |
| Homebrew | `brew install sherlock` | |
PyPI and DockerHub images are mainaintenced by the Sherlock Project. Others are community supported.
### Alternative guides and methods