File: development-notes.md

package info (click to toggle)
pysolar 0.10%2Brepack-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,804 kB
  • sloc: python: 2,774; makefile: 146
file content (16 lines) | stat: -rw-r--r-- 925 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
### Contributing ###

I'm happy to receive patches to Pysolar. Please make sure that your patch does not break the test suite before you send a pull request. If that's confusing, please feel free to send me an email.

### Release procedure ###

(These notes are just to remind Brandon how releases worked the last time he released a new version of Pysolar.)

1. Patch, test, patch, test, until it works right. Test includes running test/testsolar.py and the validation suite.
2. To run the validation suite, install Jupyter Notebook, Matplotlib, and Pandas. Then run each cell of `test/validation.ipynb`.
3. Commit and push to Github.
4. Update the version number in setup.py.
5. Update contributors.markdown if needed.
6. Add a release on Github that matches the new version number: https://github.com/pingswept/pysolar/releases
7. Test PyPI credentials with `python setup.py register`
8. Run `python setup.py sdist upload`