Python setup.py

Python setup.py is important method to learn for installing any Python package on your system. Learn more about importatn aspect in this guide.

Parameter Usage
Name of your distribution.
name
Version string of your distribution.
version
List of Python packages (that is, directories containing modules) to include. This can be specified

packages manually, but a call to is typically used instead.
setuptools.find_packages()

List of top-level Python modules (that is, single       files) to include.

py_modules
.py

Python setup.py: Purpose of setup.py

The setup script is the center of all activity in building, distributing, and installing modules using the Distutils. Its purpose is the correct installation of the software.

If all you want to do is distribute a module called foo, contained in a file foo.py, then your setup script can be as simple as this:

from distutils.core import setup
setup(name='foo',
version='1.0',
py_modules=['foo'],

)

To create a source distribution for this module, you would create a setup script, setup.py, containing the above code, and run this command from a terminal:

python setup.py sdist

sdist will create an archive file (e.g., tarball on Unix, ZIP file on Windows) containing your setup script setup.py, and your module foo.py. The archive file will be named foo-1.0.tar.gz (or .zip), and will unpack into a directory foo-1.0.

If an end-user wishes to install your foo module, all she has to do is download foo-1.0.tar.gz (or .zip), unpack it, and—from the foo-1.0 directory—run

python setup.py install

Using source control metadata in setup.py

setuptools_scm is an officially-blessed package that can use Git or Mercurial metadata to determine the version number of your package, and find Python packages and package data to include in it.

from setuptools import setup, find_packages
setup(
setup_requires=['setuptools_scm'],
use_scm_version=True,
packages=find_packages(),
include_package_data=True,
)

This example uses both features; to only use SCM metadata for the version, replace the call to find_packages() with your manual package list, or to only use the package finder, remove use_scm_version=True.

Python setup.py: Adding command line scripts to your python package

Command line scripts inside python packages are common. You can organise your package in such a way that when a user installs the package, the script will be available on their path.

If you had the greetings package which had the command line script hello_world.py.

greetings/
greetings/
init.py
hello_world.py

You could run that script by running:

python greetings/greetings/hello_world.py

However if you would like to run it like so:

hello_world.py

You can achieve this by adding scripts to your setup() in setup.py like this:

from setuptools import setup
setup(
name='greetings',
scripts=['hello_world.py']
)

When you install the greetings package now, hello_world.py will be added to your path.

Another possibility would be to add an entry point:

entry_points={'console_scripts': ['greetings=greetings.hello_world:main']}

This way you just have to run it like:

greetings

Python setup.py: Adding installation options

As seen in previous examples, basic use of this script is:

python setup.py install

But there is even more options, like installing the package and have the possibility to change the code and test it without having to re-install it. This is done using:

python setup.py develop

If you want to perform specific actions like compiling a Sphinx documentation or building fortran code, you can create your own option like this:

cmdclasses = dict()

class BuildSphinx(Command):
"""Build Sphinx documentation."""
description = 'Build Sphinx documentation'
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
import sphinx
sphinx.build_main(['setup.py', '-b', 'html', './doc', './doc/_build/html'])
sphinx.build_main(['setup.py', '-b', 'man', './doc', './doc/_build/man'])
cmdclasses['build_sphinx'] = BuildSphinx
setup(
…
cmdclass=cmdclasses,
)

initialize_options and finalize_options will be executed before and after the run function as their names suggests it.

After that, you will be able to call your option:

python setup.py build_sphinx

Learn More

Must Read Python Interview Questions

• 165+ Python Interview Questions & Answers

200+ Python Tutorials With Coding Examples

Python Language Basics Tutorial	Python String Representations of Class Instances
Python For Beginners Tutorial	Python Debugging Tutorial
Python Data Types Tutorial	Reading and Writing CSV File Using Python
Python Indentation Tutorial	Writing to CSV in Python from String/List
Python Comments and Documentation Tutorial	Python Dynamic Code Execution Tutorial
Python Date And Time Tutorial	Python Code Distributing using Pyinstaller
Python Date Formatting Tutorial	Python Data Visualization Tutorial
Python Enum Tutorial	Python Interpreter Tutorial
Python Set Tutorial	Python Args and Kwargs
Python Mathematical Operators Tutorial	Python Garbage Collection Tutorial
Python Bitwise Operators Tutorial	Python Pickle Data Serialisation
Python Bolean Operators Tutorial	Python Binary Data Tutorial
Python Operator Precedance Tutorial	Python Idioms Tutorial
Python Variable Scope And Binding Tutorial	Python Data Serialization Tutorial
Python Conditionals Tutorial	Python Multiprocessing Tutorial
Python Comparisons Tutorial	Python Multithreading Tutorial
Python Loops Tutorial	Python Processes and Threads
Python Arrays Tutorial	Python Concurrency Tutorial
Python Multidimensional Arrays Tutorial	Python Parallel Computation Tutorial
Python List Tutorial	Python Sockets Module Tutorial
Python List Comprehensions Tutorial	Python Websockets Tutorial
Python List Slicing Tutorial	Sockets Encryption Decryption in Python
Python Grouby() Tutorial	Python Networking Tutorial
Python Linked Lists Tutorial	Python http Server Tutorial
Linked List Node Tutorial	Python Flask Tutorial
Python Filter Tutorial	Introduction to Rabbitmq using Amqpstorm Python
Python Heapq Tutorial	Python Descriptor Tutorial
Python Tuple Tutorial	Python Tempflile Tutorial
Python Basic Input And Output Tutorial	Input Subset and Output External Data Files using Pandas in Python
Python Files And Folders I/O Tutorial	Unzipping Files in Python Tutorial
Python os.path Tutorial	Working with Zip Archives in Python
Python Iterables And Iterators Tutorial	gzip in Python Tutorial
Python Functions Tutorial	Stack in Python Tutorial
Defining Functions With List Arguments In Python	Working with Global Interpreter Lock (GIL)
Functional Programming In Python	Python Deployment Tutorial
Partial Functions In Python	Python Logging Tutorial
Decorators Function In Python	Python Server Sent Events Tutorial
Python Classes Tutorial	Python Web Server Gateway Interface (WSGI)
Python Metaclasses Tutorial	Python Alternatives to Switch Statement
Python String Formatting Tutorial	Python Packing and Unpacking Tutorial
Python String Methods Tutorial	Accessing Python Sourcecode and Bytecode
Using Loops Within Functions In Python	Python Mixins Tutorial
Python Importing Modules Tutorial	Python Attribute Access Tutorial
Difference Betweeb Module And Package In Python	Python Arcpy Tutorial
Python Math Module Tutorial	Python Abstract Base Class Tutorial
Python Complex Math Tutorial	Python Plugin and Extension Classes
Python Collections Module Tutorial	Python Immutable Datatypes Tutorial
Python Operator Module Tutorial	Python Incompatibilities Moving from Python 2 to Python 3
Python JSON Module Tutorial	Python 2to3 Tool Tutorial
Python Sqlite3 Module Tutorial	Non-Official Python implementations
Python os Module Tutorial	Python Abstract Syntax Tree
Python Locale Module Tutorial	Python Unicode and Bytes
Python Itertools Module Tutorial	Python Serial Communication (pyserial)
Python Asyncio Module Tutorial	Neo4j and Cypher using Py2Neo
Python Random Module Tutorial	Basic Curses with Python
Python Functools Module Tutorial	Templates in Python
Python dis Module Tutorial	Python Pillow
Python Base64 Module Tutorial	Python CLI subcommands with precise help output
Python Queue Module Tutorial	Python Database Access
Python Deque Module Tutorial	Connecting Python to SQL Server
Python Webbrowser Module Tutorial	Python and Excel
Python tkinter Tutorial	Python Turtle Graphics
Python pyautogui Module Tutorial	Python Persistence
Python Indexing And Slicing Tutorial	Python Design Patterns
Python Plotting With Matplotlib Tutorial	Python hashlib
Python Graph Tool Tutorial	Creating a Windows Service Using Python
Python Generators Tutorial	Mutable vs Immutable (and Hashable) in Python
Python Reduce Tutorial	Python configparser
Python Map Function Tutorial	Python Optical Character Recognition
Python Exponentiation Tutorial	Python Virtual Environments
Python Searching Tutorial	Python Virtual Environment – virtualenv
Sorting Minimum And Maximum In Python	Python Virtual environment with virtualenvwrapper
Python Print Function Tutorial	Create virtual environment with virtualenvwrapper in windows
Python Regular Expressions Regex Tutorial	Python sys Tutorial
Copying Data In Python Tutorial	ChemPy – Python package
Python Context Managers (“with” Statement) Tutorial	Python pygame
Python Name Special Variable Tutorial	Python pyglet
Checking Path Existence And Permissions In Python	Working with Audio in Python
Creating Python Packages Tutorial	Python pyaudio
Usage of pip Module In Python Tutorial	Python shelve
Python PyPi Package Manager Tutorial	IoT Programming with Python and Raspberry PI
Parsing Command Line Arguments In Python	kivy – Cross-platform Python Framework for NUI Development
Python Subprocess Library Tutorial	Pandas Transform
Python setup.py Tutorial	Python vs. JavaScript
Python Recursion Tutorial	Call Python from C#
Python Type Hints Tutorial	Python Writing Extensions
Python Exceptions Tutorial	Python Lex-Yacc
Raise Custom Exceptions In Python	Python Unit Testing
Python Commonwealth Exceptions Tutorial	Python py.test
Python urllib Tutorial	Python Profiling
Web Scraping With Python Tutorial	Python Speed of Program
Python HTML Parsing Tutorial	Python Performance Optimization
Manipulating XML In Python	Python Security and Cryptography
Python Requests Post Tutorial	Secure Shell Connection in Python
Python Distribution Tutorial	Python Anti Patterns
Python Property Objects Tutorial	Python Common Pitfalls
Python Overloading Tutorial	Python Hidden Features
Python Polymorphism Tutorial	Python For Machine Learning
Python Method Overriding Tutorial	Python Interview Questions And Answers For Experienced
Python User Defined Methods Tutorial	Python Coding Interview Questions And Answers

Other Python Tutorials

• What is Python?
• Python Advantages
• Python For Beginners
• Python For Machine Learning
• Machine Learning For Beginners
• 130+ Python Projects With Source Code On GitHub