Adding Version Control Numbering to Python Project

Version control is an essential part of software development that helps you track changes in your project, collaborate with other developers, and easily manage different versions of your code. In this tutorial, we'll explore how to add version control to a Python project using Git and how to incorporate version numbering into your project.
Before you begin, make sure you have the following prerequisites:
Let's start by creating a simple Python project. For this tutorial, we'll create a project that calculates the factorial of a number. You can replace this example with your own project.
Now, open factorial.py in your code editor and add the following code:
To add version control to your project, you'll need to initialize a Git repository. Open your terminal and navigate to your project directory:
Initialize a Git repository by running the following command:
This command sets up a local Git repository in your project folder.
A .gitignore file allows you to specify which files and directories should be ignored by Git. It's essential to exclude files that don't need to be versioned, such as Python bytecode files (*.pyc) and virtual environment folders.
Create a .gitignore file in your project directory and add the following lines:
These rules will tell Git to ignore Python bytecode files, the __pycache__ directory, and any virtual environment directory (assuming you're using a virtual environment).
Now, add your Python code to the Git repository. You can add all the files in the project directory using:
To commit your changes, run:
This creates a new commit that represents the initial state of your project.
To add version numbering to your project, you can follow the Semantic Versioning (SemVer) convention. This convention uses three numbers separated by dots: MAJOR.MINOR.PATCH. Here's how you can apply it to your project:
In your Python project, you can store the version number in a separate file, typically named version.py. Create this file in your project directory:
Open version.py and define the initial version:
You can then import this version number into your code whenever you need to reference it.
When you make significant changes to your project, update the version number in version.py according to the SemVer rules.
For example, if you make a backward-compatible change, update the MINOR version number:
After updating the version number, commit the change to Git:
You've successfully added version control to your Python project using Git and incorporate