Python is a high-level programming language that is widely used for web development, machine learning, scientific computing and more. In this blog post, we will be identify (and build) how to develop a simple python project with unit testing, publishing it finally as a binary and distribute it as source.<\/p>\n\n\n\n
First, we will create a python module that contains a simple function. This function takes a number as an input and returns the square of that number. We will name this module as “square”.<\/p>\n\n\n\n
def square(x):\n return x * x<\/code><\/pre>\n\n\n\nNext, we will write unit tests for this module. We will use the unittest<\/code> module to write tests that check if the square function is working correctly.<\/p>\n\n\n\nimport unittest\nimport square\n\nclass TestSquare(unittest.TestCase):\n def test_square(self):\n self.assertEqual(square.square(2), 4)\n self.assertEqual(square.square(3), 9)\n\nif __name__ == '__main__':\n unittest.main()<\/code><\/pre>\n\n\n\nOnce we have developed and tested our module, it’s time to distribute it. We will use the pyinstaller<\/code> tool to generate a binary distribution of our module. Pyinstaller generates a standalone executable file that contains all the necessary dependencies, including python itself.<\/p>\n\n\n\nTo generate a binary distribution, we need to run the following command:<\/p>\n\n\n\n
pyinstaller --onefile square.py<\/code><\/pre>\n\n\n\nWe can also publish our module as a source distribution. This is useful if the users want to modify the code or want to see how it works. To create a source distribution, we will use the setup<\/code> module.<\/p>\n\n\n\nfrom setuptools import setup\n\nsetup(\n name='square',\n version='1.0',\n description='A simple module to square a number',\n author='Your Name',\n author_email='your.email@example.com',\n py_modules=['square'],\n classifiers=[\n 'Development Status :: 5 - Production\/Stable',\n 'Intended Audience :: Developers',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n ],\n)<\/code><\/pre>\n\n\n\nTo create a source distribution, we need to run the following command:<\/p>\n\n\n\n
python3 setup.py sdist<\/code><\/pre>\n\n\n\nThis will generate a source distribution archive in the dist directory. The users can download this archive, extract it, and install the module using the following command:<\/p>\n\n\n\n
pip3 install dist\/square-1.0.tar.gz<\/code><\/pre>\n\n\n\nConclusion<\/h3>\n\n\n\n
In this blog post, we have discussed how to develop a simple python project with unit testing, and publishing it as both a binary and source distribution. We have used the pyinstaller<\/code> tool to generate a binary distribution and the setup<\/code> module to create a source distribution.<\/p>\n\n\n\n