You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+22-3Lines changed: 22 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,32 @@
2
2
All notable changes to this project will be documented in this file.
3
3
This project adheres to [Semantic Versioning](http://semver.org/).
4
4
5
-
## [2.0.7] - [Unreleased]
5
+
## [Unreleased]
6
+
### Added
7
+
- 'sort' parameter to `FF.create_violin` to control whether violin plots are sorted alphabetically.
8
+
9
+
## [2.0.8] - 2017-04-21
10
+
### Added
11
+
- Beta: Added API methods that wrap the API endpoint for managing Dash objects on plot.ly. The API interface is under `plotly.api.v2.dash_apps`
12
+
- offline embedded plots are now responsive to window resizing when `output_type == "div"` is set in `plotly.offline.iplot()`.
13
+
- Offline embedded plots are now responsive to window resizing when `output_type == "div"` is set in `plotly.offline.iplot()`.
14
+
- Offline animations are now supported on Plotly Cloud.
15
+
16
+
### Updated
17
+
- Updated `plotly.min.js` to version 1.26.0 for `plotly.offline`.
18
+
- See [the plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md) for additional information regarding the updates.
19
+
20
+
### Updated
21
+
-`plotly.offline.plot` and `plotly.offline.iplot` now accept various [configuration options](https://plot.ly/javascript/configuration-options/) for their arguments.
22
+
23
+
## [2.0.7] - 2017-04-07
6
24
### Updated
7
25
- Updated `plotly.min.js` to version 1.25.0 for `plotly.offline`.
8
26
- See [the plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md) for additional information regarding the updates.
9
27
28
+
### Added
29
+
- Added check to verify the share key is enabled when secret charts are created.
30
+
10
31
## [2.0.6] - 2017-03-20
11
32
### Added
12
33
- Added a new mimetype 'text/vnd.plotly.v1+html' for `iplot` outputs.
@@ -37,8 +58,6 @@ Note: This release's installation was broken. It has been removed from PyPI
37
58
See [https://github.com/nteract/nteract/pull/662](https://github.com/nteract/nteract/pull/662)
38
59
for the associated PR in nteract.
39
60
- As part of the above, plotly output now prints with a [custom mimetype](https://github.com/plotly/plotly.py/blob/f65724f06b894a5db94245ee4889c632b887d8ce/plotly/offline/offline.py#L348) - `application/vnd.plotly.v1+json`
Copy file name to clipboardExpand all lines: contributing.md
+31-22Lines changed: 31 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,18 @@
1
+
# Contributing
2
+
1
3
The bottom line. Follow your Nose, or our Nose. Write-run-love tests :fist:.
2
4
3
-
##Setup
5
+
## Code of Conduct
6
+
7
+
Check out the [Code of Conduct](CODE_OF_CONDUCT.md). Don't tl:dr; it, but the general idea is to be nice.
8
+
9
+
## Got Questions?
10
+
11
+
Open an issue! Go to https://github.com/plotly/plotly.py/issues. It's possible that your issue was already addressed. If it wasn't, open it. We also accept PRs; take a look at the steps below for instructions on how to do this.
12
+
13
+
## Setup
4
14
5
-
###Fork, Clone, Setup Your Version of the Plotly Python API
15
+
###Fork, Clone, Setup Your Version of the Plotly Python API
6
16
7
17
First, you'll need to *get* our project. This is the appropriate *clone* command (if you're unfamiliar with this process, https://help.github.com/articles/fork-a-repo):
8
18
@@ -12,7 +22,7 @@ First, you'll need to *get* our project. This is the appropriate *clone* command
Second, this project uses git submodules! They're both helpful and, at times, difficult to work with. The good news is you probably don't need to think about them! Just run the following shell command to make sure that your local repo is wired properly:
18
28
@@ -35,7 +45,7 @@ Additionally, there are some project shortcuts that live in the `makefile` file.
35
45
make readme
36
46
```
37
47
38
-
###Making a Development Branch
48
+
###Making a Development Branch
39
49
40
50
Third, *don't* work in the `master` branch. As soon as you get your master branch ready, run:
41
51
@@ -46,22 +56,22 @@ git checkout -b my-dev-branch
46
56
47
57
... where you should give your branch a more descriptive name than `my-dev-branch`
48
58
49
-
###Pull Request When Ready
59
+
###Pull Request When Ready
50
60
51
61
Once you've made your changes (and hopefully written some tests...), make that pull request!
52
62
53
-
##Suggestions
63
+
##Suggestions
54
64
55
-
###Local Python
56
-
Setting up Python versions that *don't* require you to use `sudo` is a good idea. In addition, the core Python on your machine may not be the Python that we've developed in! Here are some nice guides for Mac, Windows, and Linux:
65
+
###Local Python
66
+
Setting up Python versions that *don't* require you to use `sudo` is a good idea. In addition, the core Python on your machine may not be the Python that we've developed in! Here are some nice guides for Mac, Windows, and Linux:
Virtualenv is a way to create Python environments on your machine that know nothing about one another. This is really helpful for ironing out dependency-problems arising from different versions of packages. Here's a nice guide on how to do this: http://docs.python-guide.org/en/latest/dev/virtualenvs/
63
73
64
-
###Alter Your PYTHONPATH
74
+
###Alter Your PYTHONPATH
65
75
The PYTHONPATH variable in your shell tells Python where to look for modules. Since you'll be developing, it'll be a pain to need to *install* Python every time you need to test some functionality (or at least ensure you're running code from the right directory...). You can easily make this change from a shell:
Note, that's non-permanent. When you close the shell, that variable definition disappears. Also, `path/to/local/repo` is *your* specific repository path (e.g., `/Users/andrew/projects/python-api`).
72
82
73
-
###Why?
83
+
###Why?
74
84
75
85
Now you can run the following code and be guaranteed to have a working development version that you can make changes to on-the-fly, test, and be confident will not break on other's machines!
There's a short list of core dependencies you'll need installed in your Python environment to have any sort of fun with Plotly's Python API (see `requirements.txt`). Additionally, you're likely to have even more fun if you install some other requirements (see `optional-requirements.txt`).
95
+
There's a short list of core dependencies you'll need installed in your Python environment to have any sort of fun with Plotly's Python API (see `requirements.txt`). Additionally, you're likely to have even more fun if you install some other requirements (see `optional-requirements.txt`).
86
96
87
-
###Dependencies and Virtualenv
97
+
###Dependencies and Virtualenv
88
98
89
99
If you decided to follow the suggestion about about the Virtualenv *and* you've run `source bin/activate` within your new virtualenv directory to activate it--you can run the following to install the core dependencies:
90
100
@@ -98,14 +108,14 @@ To install the optional dependencies:
98
108
pip install -r optional-requirements.txt
99
109
```
100
110
101
-
##Testing
111
+
##Testing
102
112
103
113
We take advantage of two tools to run tests:
104
114
105
115
*[`tox`](https://tox.readthedocs.io/en/latest/), which is both a virtualenv management and test tool.
106
116
*[`nose`](https://nose.readthedocs.org/en/latest/), which is is an extension of Python's unittest
107
117
108
-
###Running Tests with `nose`
118
+
###Running Tests with `nose`
109
119
110
120
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 `optional-requirements.txt` as explained above.
Running tests with tox is much more powerful, but requires a bit more setup.
139
149
@@ -174,29 +184,28 @@ Note that anything after `--` is substituted in for `{posargs}` in the tox.ini.
174
184
tox -- -a '!slow','!matplotlib'
175
185
```
176
186
177
-
###Writing Tests
187
+
###Writing Tests
178
188
179
-
You're *strongly* encouraged to write tests that check your added functionality.
189
+
You're *strongly* encouraged to write tests that check your added functionality.
180
190
181
191
When you write a new test anywhere under the `tests` directory, if your PR gets accepted, that test will run in a virtual machine to ensure that future changes don't break your contributions!
182
192
183
193
#### Publishing to Pip
184
194
185
195
You'll need the credentials file `~/.pypirc`. Request access from @theengineear and @chriddyp. Then, from inside the repository:
186
196
187
-
```
197
+
```bash
188
198
(plotly.py) $ git checkout master
189
199
(plotly.py) $ git stash
190
200
(plotly.py) $ git pull origin master
191
201
(plotly.py) $ python setup.py sdist upload # upload to pip
192
202
```
193
203
194
204
After it has uploaded, move to another directly and double+triple check that you are able to upgrade ok:
195
-
```
205
+
```bash
196
206
$ pip install plotly --upgrade
197
207
```
198
208
199
209
And ask one of your friends to do it too. Our tests should catch any issues, but you never know.
0 commit comments