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
2. Tweet about your pacakge and and mention `@matplotlib` for a retweet.
49
49
50
+
51
+
## Miscellaneous Advice
52
+
53
+
Do not use Matplotlib private methods. If you really need the functionality then consider opening a feature request to have Matplotlib provide a public API for what you want.
54
+
55
+
There is some discussion of how to use Matplotlib docstrings on discourse: https://discourse.matplotlib.org/t/docs-for-a-method-wrapping-a-matplotlib-method/21055
56
+
57
+
https://colcarroll.github.io/yourplotlib/ is a great read for how to make an extension to Matplotlib.
58
+
59
+
## LICENSE Advice
60
+
61
+
You may end up using portions of Matplotlib's code or copying docstrings when making a Matplotlib extension.
62
+
63
+
As a practical rule: If you end up copying a non-trivial amount of code or docs the safest course of action is to add the Matplotlib license to your project as a derived work. For example see how Matplotlib does it https://github.com/matplotlib/matplotlib/tree/master/LICENSE.
64
+
65
+
> But what counts as non-trivial?
66
+
67
+
68
+
A good rule of thumb is to ask yourself:
69
+
70
+
If it were homework and you didn't acknowledge would it be cheating?
71
+
72
+
If the answer is yes, then you should leave a comment in the code and include a license file in a top level `LICENSE` folder.
73
+
74
+
75
+
76
+
50
77
## Releasing to PyPi
51
78
### Manually
52
79
First set ensure you have the right packages installed:
@@ -96,28 +123,6 @@ then draft a new release:
96
123
After you fill out the information the Github action will create a new tag for you, build the wheel, and upload it to PyPI.
97
124
98
125
99
-
## Miscellaneous Advice
100
-
101
-
Do not use Matplotlib private methods. If you really need the functionality then consider opening a feature request to have Matplotlib provide a public API for what you want.
102
-
103
-
There is some discussion of how to use Matplotlib docstrings on discourse: https://discourse.matplotlib.org/t/docs-for-a-method-wrapping-a-matplotlib-method/21055
104
-
105
-
https://colcarroll.github.io/yourplotlib/ is a great read for how to make an extension to Matplotlib.
106
-
107
-
## LICENSE Advice
108
-
109
-
You may end up using portions of Matplotlib's code or copying docstrings when making a Matplotlib extension.
110
-
111
-
As a practical rule: If you end up copying a non-trivial amount of code or docs the safest course of action is to add the Matplotlib license to your project as a derived work. For example see how Matplotlib does it https://github.com/matplotlib/matplotlib/tree/master/LICENSE.
112
-
113
-
> But what is non-trivial????
114
-
115
-
116
-
practical copyright rules
117
-
118
-
If it were homework and you didn't acknowledge would it be cheating?
119
-
If yes then .... (e..g add a comment and include a license file in ___ folder)
0 commit comments