Data Science Documentation Packaging PyPi Testing
See in schedule: Thu, Jul 29, 08:30-09:00 CEST (30 min)Halfway through my first postdoc it was clear it would be very difficult to submit a paper to a journal before my contract ended. How do I make something useful in the time allotted that keeps me motivated enough to finish a paper after my contract ends (and useful on a CV)? Answer: package my code into a tested library via GitHub, The Python Package Index (PyPI) and Zenodo for citations.
Goals:
- Pros and cons of rearranging a project for public release (5 min)
- Python cookiecutter templates (5 min)
- Options for testing (standard library unittest vs pytest) (5 min)
- Continuous Integration (Travis vs GitHub Actions) (5 min)
- Documentation (5 min)
- Release on Zotero for citation (5 min)
Prerequisites:
- Intermediate Python
- Command line
Type: Talk (30 mins); Python level: Intermediate; Domain level: Beginner
Dr Griffith Rees is a postdoc at the Alan Turing Institute. He has a PhD in sociology and is relieved to have colleagues who are much more experienced software developers.
