Skip to content

Commit

Permalink
Make an actual package with pyproject.toml
Browse files Browse the repository at this point in the history
Fixes #2017
  • Loading branch information
mjsir911 committed Mar 2, 2024
1 parent e3a09f8 commit 79f5f18
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 11 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ LABEL org.label-schema.vcs-ref=$VCS_REF \
COPY --from=build /wheels /wheels
COPY . /opt/sherlock/

RUN pip3 install --no-cache-dir -r requirements.txt -f /wheels \
RUN pip3 install --no-cache-dir . -f /wheels \
&& rm -rf /wheels

WORKDIR /opt/sherlock/sherlock

ENTRYPOINT ["python", "sherlock.py"]
ENTRYPOINT ["sherlock"]
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,13 @@
## Installation

```console
# clone the repo
$ git clone https://github.com/sherlock-project/sherlock.git

# change the working directory to sherlock
$ cd sherlock

# install the requirements
$ python3 -m pip install -r requirements.txt
pip install git+https://github.com/sherlock-project/sherlock.git
```

## Usage

```console
$ python3 sherlock --help
$ sherlock --help
usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT]
[--output OUTPUT] [--tor] [--unique-tor] [--csv]
[--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE]
Expand Down
23 changes: 23 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[build-system]
requires = ["setuptools >= 61.0"]
build-backend = "setuptools.build_meta"

[project.scripts]
sherlock = "sherlock:main"

[project.urls]
Homepage = "http://sherlock-project.github.io/"
Repository = "https://github.com/sherlock-project/sherlock.git"
Issues = "https://github.com/sherlock-project/sherlock/issues"

[project]
name = "sherlock"
readme = "README.md"
license = {file = "LICENSE"}
dynamic = ["dependencies", "version"]

[tool.setuptools.dynamic]
dependencies = {file = ["requirements.txt"]}

[tool.setuptools]
package-dir = {"" = "sherlock"}

0 comments on commit 79f5f18

Please sign in to comment.