Book Image

Modular Programming with Python

By : Erik Westra
Book Image

Modular Programming with Python

By: Erik Westra

Overview of this book

Python has evolved over the years and has become the primary choice of developers in various fields. The purpose of this book is to help readers develop readable, reliable, and maintainable programs in Python. Starting with an introduction to the concept of modules and packages, this book shows how you can use these building blocks to organize a complex program into logical parts and make sure those parts are working correctly together. Using clearly written, real-world examples, this book demonstrates how you can use modular techniques to build better programs. A number of common modular programming patterns are covered, including divide-and-conquer, abstraction, encapsulation, wrappers and extensibility. You will also learn how to test your modules and packages, how to prepare your code for sharing with other people, and how to publish your modules and packages on GitHub and the Python Package Index so that other people can use them. Finally, you will learn how to use modular design techniques to be a more effective programmer.
Table of Contents (16 chapters)
Modular Programming with Python
About the Author
About the Reviewer

Preparing a module or package for publication

In Chapter 6, Creating Reusable Modules, we looked at a number of things that make a module or package suitable for reuse:

  • It must function as a standalone unit

  • A package should ideally use relative imports

  • Any external dependencies in your module or package must be clearly noted

We also identified three things that help to create an excellent reusable module or package:

  • It should solve a general problem

  • Your code should follow standard coding conventions

  • Your module or package should be clearly documented

The first step in preparing your module or package for publication is to ensure that you've followed at least the first three of these, and, ideally, all six of these guidelines.

The second step is to make sure that you've written at least a few unit tests and your module or package passes all of these. Finally, you will need to decide how you want to publish your code.

If you want to share your code with friends or work colleagues or write a blog post...