Skip to content
This repository was archived by the owner on Oct 9, 2023. It is now read-only.

Commit 17d70cd

Browse files
Fix duplicate requirements specification (#282)
## What is the goal of this PR? This PR solves issue #219 by including `requirements.txt` inside of `requirements_dev.txt`, so that the requirements are no longer duplicated. Going forward, developers will no longer need to remember to copy changes from `requirements.txt` to `requirements_dev.txt`. ## What are the changes implemented in this PR? This PR adds a reference (`-r requirements.txt`) to `requirements_dev.txt`, and cleans up the instructions around it. See the [pip install Requirements File Format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) for details on this feature. closes #219
1 parent 657556a commit 17d70cd

File tree

2 files changed

+8
-13
lines changed

2 files changed

+8
-13
lines changed

requirements.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@
1919
# under the License.
2020
#
2121

22-
## To install all dependencies, run: pip install -r requirements.txt
22+
## To install primary (not dev) dependencies, run:
23+
# pip install -r requirements.txt
24+
25+
## To install ALL (including dev) dependencies, run:
26+
# pip install -r requirements_dev.txt
2327

2428

2529
## Configuration options
@@ -31,7 +35,6 @@
3135

3236
## Dependencies
3337

34-
# IMPORTANT: Any changes to these dependencies should be copied to requirements_dev.txt.
3538
typedb-protocol==2.14.1
3639
grpcio>=1.43.0,<2
3740
protobuf>=3.15.5,<4

requirements_dev.txt

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,12 @@
1919
# under the License.
2020
#
2121

22-
## To install all dependencies, run: pip install -r requirements_dev.txt
22+
## To install ALL dependencies, run: pip install -r requirements_dev.txt
2323

2424

25-
## Configuration options
25+
## Primary Dependencies
2626

27-
# Allow importing of snapshots
28-
--extra-index-url https://repo.vaticle.com/repository/pypi-snapshot/simple
29-
30-
31-
## Dependencies
32-
33-
typedb-protocol==2.14.1
34-
grpcio>=1.43.0,<2
35-
protobuf>=3.15.5,<4
27+
-r requirements.txt
3628

3729

3830
# Dev dependencies (not required to use the typedb-client package, but necessary for its development)

0 commit comments

Comments
 (0)