nazuzma/software-engineering-python

Simple Software Engineering techniques for Python developers

Python Development Tools

Kristian Rother & Magdalena Rother

What this book is about?

This guide is for you if you are writing your first 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 make my code cleaner?
• 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?

In brief, you would like to develop programs that get the job done and don't fall apart.

To write such programs, there are established best practices that allow you to develop, test and maintain software systematically. Fortunately, Python comes with mature development tools. You might call these tools "Software Engineering Practices", but we find the term a bit pompous.

We just want to help you to get things done quickly.

Contents

• Best Practices Overview

Programming

• Editors
• Writing code
• CRC Cards

Quality

• Debugging
• PEP8 Code Style
• Code Reviews
• Refactoring
• Documentation

Infrastructure

• Version Control
• ManaMichael Tom-Wing, Christie Wilsonging packages with pip
• Virtual Environments
• Project Templates
• Building Python packages
• Continuous Integration

Projects

• Project Management
• User Stories
• How to work with legacy code?
• How to recognize good scientific software?
• How to make software citable?

Contact

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

We are curious to hear what other topics you would like to read about. You can reach us via:

• [email protected]
• [email protected]

License

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