Skip to content

Commit 29b9b3f

Browse files
authored
Merge pull request #5 from jklymak/doc-readme-edits
DOC: readme edits
2 parents 4b9c21f + 2b20855 commit 29b9b3f

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
# Matplotlib 3rd Party Package Cookiecutter
22

3-
Turn your matplotlib convenience scripts into a proper python package using this cookiecutter.
3+
Turn your matplotlib scripts into a sharable python package using this
4+
[cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/) recipe:
5+
46
```
57
pip install cookiecutter
68
cookiecutter gh:matplotlib/matplotlib-extension-cookiecutter
79
```
8-
**Buy why?**
910

10-
Why use this over just starting with a setup.py? This cookiecutter will provide the infrastructure of open-source project quickly, you can set all this up on your own, but it will take time and can be annoying to get right. With the cookiecutter you get:
11+
Add your code to `yourname/yourname/yourcode.py` and you can do
12+
```python
13+
from yourname import yourcode
14+
```
15+
16+
## But why?
17+
18+
Sharing your code on public distribution channels like PyPi requires some infrastructure in terms of setup files that take time and can be annoying to get right. The cookiecutter takes care of this for you, and alos sets up a testing and documentation building environment:
1119

12-
- Github actions works
13-
- Issue Templates
20+
- Github actions work
21+
- Issue templates
1422
- Properly set up packaging
1523
- A setup for docs with:
1624
- `sphinx-gallery`
@@ -43,8 +51,8 @@ For full instructions see: https://github.com/matplotlib/pytest-mpl#using
4351

4452
Once you've made your package other people will likely want to use your hard work, and maybe even contribute to it! But for this to happen they need to know about it. The Matplotlib devs also want you to share your package and like to amplify your advertising. So some great steps to take in order to share your package are:
4553

46-
1. Make a PR to add it to Matplotlib's 3rd party packages page
47-
- [Example PR](https://github.com/matplotlib/matplotlib/pull/13076)
54+
1. Make a PR to add it to Matplotlib's 3rd party packages page:
55+
- https://matplotlib.org/mpl-third-party/
4856
2. Tweet about your pacakge and and mention `@matplotlib` for a retweet.
4957

5058

0 commit comments

Comments
 (0)