fix: Remove tox dependency from tap/target template (#1345)

meltano · Jan 24, 2023 · c852b99 · c852b99
1 parent 1ee4c4a
commit c852b99
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 13 deletions.
diff --git a/cookiecutter/tap-template/{{cookiecutter.tap_id}}/pyproject.toml b/cookiecutter/tap-template/{{cookiecutter.tap_id}}/pyproject.toml
@@ -19,7 +19,6 @@ requests = "^2.28.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.0"
-tox = "^4.1.3"
 flake8 = "^3.9.2"
 black = "^22.12.0"
 pydocstyle = "^6.2.1"

diff --git a/cookiecutter/target-template/{{cookiecutter.target_id}}/pyproject.toml b/cookiecutter/target-template/{{cookiecutter.target_id}}/pyproject.toml
@@ -19,7 +19,6 @@ requests = "^2.28.1"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.2.0"
-tox = "^4.1.3"
 flake8 = "^3.9.2"
 black = "^22.12.0"
 pydocstyle = "^6.2.1"

diff --git a/docs/dev_guide.md b/docs/dev_guide.md
@@ -39,16 +39,20 @@ for more information on differences between a target's `Sink` class versus a tap
 
 ## Building a New Tap or Target
 
-First, install [cookiecutter](https://cookiecutter.readthedocs.io) if you haven't
-done so already:
+First, install [cookiecutter](https://cookiecutter.readthedocs.io),
+[Poetry](https://python-poetry.org/docs/), and optionally [Tox](https://tox.wiki/):
 
 ```bash
 # Install pipx if you haven't already
-pip3 install pipx
+pip install pipx
 pipx ensurepath
+
 # Restart your terminal here, if needed, to get the updated PATH
 pipx install cookiecutter
 pipx install poetry
+
+# Optional: Install Tox if you want to use it to run auto-formatters, linters, tests, etc.
+pipx install tox
 ```
 
 Now you can initialize your new project with the Cookiecutter template for taps:

diff --git a/poetry.lock b/poetry.lock