README.md

Python Software Development

What this guide is about?

This guide is for you if you are writing programs with more than 500 lines.

You know how to write Python code, but have realized that creating a piece of software is more complex. You are facing questions like:

• How to clean up my code?
• How to make sure my program works?
• How to install my program on multiple computers?
• How to keep the program running over time?
• How to deliver the program to other people?

Below you find development tools and techniques that help you to write programs that get the job done and don't fall apart.

---

Getting Started

• Start with a Prototype
• Set up a Git Repository
• Create a Folder Structure
• Create Issues on GitHub

---

Planning and Design

• Define an Interface
• Class Diagrams
• User Stories
• CRC Cards

---

Packaging and Maintenance

• Virtual Environments
• Installing packages with pip
• Create a pip-installable Package
• Continuous Integration

---

Coding Strategies

• Coding Strategies
• Debugging
• PEP8 Code Style
• Refactoring
• Code Reviews

---

Advanced Stuff

• Counting Lines of Code
• Technical Debt
• Project Templates
• Project Management
• How to work with legacy code?
• Documentation Tools
• Citable Code

---

Other Things

• Editors
• Environment Variables
• How to recognize good scientific software?
• Impostor Syndrome
• Exercise: Programming Languages
• Exercises

---

Contact

We are two Python software engineers who decided to write down our experience resulting from our Python projects in life science, web development and teaching.

License

© 2020 Kristian Rother and Magdalena Rother

This text is released under the conditions of the Creative Commons Attribution Share-alike License 4.0.