Skip to content

Commit 1c4c3c9

Browse files
committed
rename requires-dev to requires-optional
1 parent a42bfb3 commit 1c4c3c9

File tree

4 files changed

+13
-6
lines changed

4 files changed

+13
-6
lines changed

contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ We will support Python 3.12 and higher versions soon.
139139
### Install requirements - (Non-Windows)
140140
```bash
141141
(plotly_dev) $ pip install -r packages/python/plotly/requires-install.txt
142-
(plotly_dev) $ pip install -r packages/python/plotly/requires-dev.txt
142+
(plotly_dev) $ pip install -r packages/python/plotly/requires-optional.txt
143143
```
144144
### Install requirements - (Windows + Conda)
145145
Because Windows requires Visual Studio libraries to compile some of the optional dependencies, follow these steps to
@@ -148,7 +148,7 @@ complete installation and avoid gdal-config errors.
148148
```bash
149149
(plotly_dev) $ pip install -r packages/python/plotly/requires-install.txt
150150
(plotly_dev) $ conda install fiona
151-
(plotly_dev) $ pip install -r packages/python/plotly/requires-dev.txt
151+
(plotly_dev) $ pip install -r packages/python/plotly/requires-optional.txt
152152
```
153153

154154
### Editable install of plotly packages
@@ -178,7 +178,7 @@ documentation on _development mode_.
178178
This repo uses the [Black](https://black.readthedocs.io/en/stable/) code formatter,
179179
and the [pre-commit](https://pre-commit.com/) library to manage a git commit hook to
180180
run Black prior to each commit. Both pre-commit and black are included in the
181-
`packages/python/plotly/requires-dev.txt` file, so you should have them
181+
`packages/python/plotly/requires-optional.txt` file, so you should have them
182182
installed already if you've been following along.
183183

184184
To enable the Black formatting git hook, run the following from within your virtual
@@ -266,7 +266,7 @@ We take advantage of two tools to run tests:
266266

267267
### Running Tests with `pytest`
268268

269-
Since our tests cover *all* the functionality, to prevent tons of errors from showing up and having to parse through a messy output, you'll need to install `requires-dev.txt` as explained above.
269+
Since our tests cover *all* the functionality, to prevent tons of errors from showing up and having to parse through a messy output, you'll need to install `requires-optional.txt` as explained above.
270270

271271
After you've done that, go ahead and run the test suite!
272272

packages/python/plotly/MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ include README.md
33
include versioneer.py
44
include plotly/_version.py
55
include requires-install.txt
6-
include requires-dev.txt
6+
include requires-optional.txt
77
include requires-express.txt
88
include plotly/package_data/widgetbundle.js

packages/python/plotly/requires-dev.txt renamed to packages/python/plotly/requires-optional.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
### Optional Dependencies for Additional Plotly Functionality ###
22
### ###
3+
### This file lists packages which are not strictly required ###
4+
### by Plotly.py, but which are needed to use some of the ###
5+
### library's functionality. See headings below for more ###
6+
### See headings below for more detail. ###
7+
### ###
8+
### Packages used in the development process are also listed ###
9+
### here. ###
10+
### ###
311
### To install, run: ###
412
### $ pip install -r requires-dev.txt ###
513
### ###

packages/python/plotly/setup.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,6 @@ def read_req_file(req_type):
562562
install_requires=read_req_file("install"),
563563
extras_require={
564564
"express": read_req_file("express"),
565-
"dev": read_req_file("dev"),
566565
},
567566
zip_safe=False,
568567
cmdclass=dict(

0 commit comments

Comments
 (0)