Creating a Python Package Using Setuptools

NITIN GUPTA

 In this tutorial, we will learn how to create a Python Package Using Setuptools so that we can share or distribute it among others. I will walk you through all the steps so you may make your own package. 

Note: We are going to use the visual studio in this tutorial. For more understanding about setting and using Visual Studio, you may refer to my tutorial #121 and watch the video to learn the basics of the visual studio and its installation and use.

Python Package Using Setuptools:-

First, we are going to make a folder, and inside it, we are going to make a license and readme named text files ( we can also use the .md extension to create a markdown file instead of text, which is also a sort of text-based file with better editing ). These license files contain the copyright details, and the readme will contain instructions that you want to convey. Along with the text files, we are also going to make a package folder. 

Now we will open our visual studio so we can make our work more simple and easier. We can open our visual studio with the same directory address by writing the command “code .” in our PowerShell. Now we will create a setup.py file, and along with it, we will also create an __init__.py file in our package folder.

 

 

The package code is present in __init__.py, and setup.py is used for its identification. In simple words, setup.py tells setuptools about our package.

In __init__.py, we will write all the functions we want our package to have. We can use classes too for this cause. In setup.py, we have to import the setuptools module, and we are going to use its setup function here.

from setuptools import setup

We will provide it with some basic details about our package, such as:

  • name: The name of the package. We can give our package any name of our choice.
  • version: The starting version should be 0.1 because, with any update, it automatically increases it to one decimal place.
  • description: Here, we give a brief description of our package and its functionalities and uses.
  • long_description: In the long description we give an explanatory description of our package
  • author: We can specify the creator of the package here
  • packages: Here we give the name by which we want our package to be called or imported
  • install_requires: If our package has a prerequisite package, then we have to specify that here so both of them can work simultaneously and can perform better.

Now we are going to build our package. We are going to open our terminal window or PowerShell in the same directory, and we are going to install the wheel.

pip install wheel

and after that, we are going to make our package using the command 

python setup.py bdist_wheel

 

 

python setup.py sdist bdist_wheel

 

 

Now our package is created, and we can install it using.

pip install package_name

 

 

And we can also import it in the same way

Import package_name

 

Code setup.py as described/written in the video


from setuptools import setup
setup(name="packageharry",
version="0.3",
description="This is code with harry package",
long_description = "This is a very very long description",
author="Harry",
packages=['packageharry'],
install_requires=[])

Code __init__.py as described/written in the video


class Achha:
    def __init__(self):
        print("Constructor ban gaya")

    def achhafunc(self, number):
        print("This is a function")
        return number

Comments

Post a Comment

Popular posts from this blog

HOW IMPORT WORKS IN PYTHON?

NITIN GUPTA
  How does the import keyword work? When we write a certain module name along with the  import  keyword, it will start searching for a file with that name having an extension  .py . After finding the file, it will import it into our program, which means that it will permit our program to use the functions of the certain module we imported. We can import a module named  “sys”  to see the path that our import statement takes while searching for a module. import sys print ( sys . path ) Copy sys.path  prints out a list of directories. When we tell Python to import something, then it looks in each of the listed locations in order.  A common mistake that most of the beginners do and also the primary reason for making this tutorial is, why can’t we name our file, the same as the name of a module. The reason is associated with the path. When we give our file a name same as the name of a module, then instead of importing the original module, the system ...
Read more

Exercise 5: Health Management System

NITIN GUPTA
  Exercise#5 The task is to create a " Health Management System ." Suppose you are a fitness trainer and nutritionist. You have to deal with three clients, i.e., (Harry, Rohan, Hammad). For each client, you have to design their exercise and diet plan. Instructions: Create a food log file for each client Create an exercise log file for each client. Ask the user whether they want to log or retrieve client data. Write a function that takes the user input of the client's name. After the client's name is entered, it will display a message as "What you want to log- Diet or Exercise". Use function def getdate ( ) : import datetime return datetime . datetime . now ( ) Copy The purpose of this function is to give time with every record of food or exercise added in the file. Write a function to retrieve exercise or food file records for any client. You are advised to participate in solving this problem. This task helps you to become a good pr...
Read more

*args and **kwargs In Python

NITIN GUPTA
  Before discussing *args and **kwargs, we should have a basic knowledge about types of arguments. In Python programming, there are two types of arguments that can be passed in a function. positional arguments keyword arguments Positional arguments  are the one in which an order has to be followed while passing arguments. We have been dealing with them until now. We know how normal functions work with positional arguments, so now we will directly start exploring keyword arguments. But to understand them, we have to know about asterisk or more commonly known in Perl 6 and ruby as a splat operator.  Asterisk is used in python as a mathematical symbol for multiplication, but in case of arguments, it refers to unpacking. The unpacking could be for a list, tuple, or a dictionary. We will discover more about it by defining *args and **kwargs. *args: args is a short form used for arguments. It is used to unpack an argument. In the case of *args, the argument could be a list or t...
Read more