Managing Versions with Python Dictionaries: A Software Carpentry Approach

When creating software, versioning is a crucial step in maintaining consistency and communication with users. In this chapter, we'll explore how to create and release new versions of your Python package using semantic versioning.

In semantic versioning, each version number consists of three integers - the major, minor, and patch versions (A.B.C). This unique identifier helps track changes made to your package over time. As you develop and refine your software, it's essential to assign a new version number to each distinct state of your package.

Releasing new versions is an effective way to inform users about updates, bug fixes, or added features. Most users will prefer the latest version of your package, but sometimes, they may need to use an older version that is compatible with their project. To accommodate these needs, developers assign a unique version number to each state of their package and release each new version independently.

When updating your package, it's essential to consider potential breaking changes. For example, modifying a module name or removing a function argument could break user code. By releasing new versions independently, you can ensure that users have access to compatible and reliable software.

In the next step of our packaging workflow, we'll explore how to update your Python package using dictionaries. This chapter assumes you have developed a Python package from scratch by creating source code, writing tests, documenting your work, and releasing it online via PyPI (if desired).

Overall, managing versions with Python dictionaries is an essential aspect of software development. By following best practices for versioning and updating your package, you can ensure that your users receive the most up-to-date and reliable software possible.

Python dictionaries software carpentry