Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated docs to inlcude poetry to requirements.txt convertion #2173

Closed
wants to merge 1 commit into from
Closed

Updated docs to inlcude poetry to requirements.txt convertion #2173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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
```


<h2>
Docker
<a href="https://hub.docker.com/r/sherlock/sherlock"><img align="right" alt="Docker Image Version" src="https://img.shields.io/docker/v/sherlock/sherlock?sort=semver&style=for-the-badge&logo=docker&label=Docker&color=darkgreen"></a>
Expand Down
Loading