Distribute a Python App via Setup.py File

The Evolution of a Script (9 Part Series)

1 Aspects of Writing Solid Python Applications
2 Create a Python Command Line App with Sys Module
… 5 more parts…
3 Create a Python Command Line App with Argparse
4 Distribute a Python App via Bash Script
5 Distribute a Python App via Setup.py File
6 Tools to automate Python Tests
7 How to Write Documentation in the Python World!
8 How to Release and Publish Python Apps at PyPI
9 Publishing Python Apps at Anaconda and further Automation

Heya fellows,

The code of this post can be found on Github (see here).

We have seen that it’s tedious and unclear how to distribute a project with a bash script. So I’ll show you in this post the way to go: using a setup.py file!

We have to create a setup.py file, put it into the root directory and then we can use pip to install our project locally. This installs the project into the active virtual environment. But how does a setup.py file looks like? Here’s a template containing the most important key-value pairs:


<span>import</span> <span>setuptools</span>
<span>setuptools</span><span>.</span><span>setup</span><span>(</span>
    <span>name</span><span>=</span><span>"</span><span>tihttp</span><span>"</span><span>,</span>
    <span>version</span><span>=</span><span>"</span><span>0.1.0</span><span>"</span><span>,</span>
    <span>package_dir</span><span>=</span><span>{</span><span>""</span><span>:</span> <span>"</span><span>src</span><span>"</span><span>},</span>
    <span>packages</span><span>=</span><span>setuptools</span><span>.</span><span>find_packages</span><span>(</span><span>where</span><span>=</span><span>"</span><span>src</span><span>"</span><span>),</span>
    <span>install_requires</span><span>=</span><span>[</span>
        <span>"</span><span>requests>=2.21</span><span>"</span><span>,</span>
    <span>],</span>
    <span>entry_points</span><span>=</span><span>{</span>
        <span>"</span><span>console_scripts</span><span>"</span><span>:</span>
        <span>[</span><span>"</span><span>tihttp=tihttp.main:run_main</span><span>"</span><span>]</span>
        <span>},</span>
<span>)</span>
<span>import</span> <span>setuptools</span>

<span>setuptools</span><span>.</span><span>setup</span><span>(</span>
    <span>name</span><span>=</span><span>"</span><span>tihttp</span><span>"</span><span>,</span>
    <span>version</span><span>=</span><span>"</span><span>0.1.0</span><span>"</span><span>,</span>

    <span>package_dir</span><span>=</span><span>{</span><span>""</span><span>:</span> <span>"</span><span>src</span><span>"</span><span>},</span>
    <span>packages</span><span>=</span><span>setuptools</span><span>.</span><span>find_packages</span><span>(</span><span>where</span><span>=</span><span>"</span><span>src</span><span>"</span><span>),</span>

    <span>install_requires</span><span>=</span><span>[</span>
        <span>"</span><span>requests>=2.21</span><span>"</span><span>,</span>
    <span>],</span>

    <span>entry_points</span><span>=</span><span>{</span>
        <span>"</span><span>console_scripts</span><span>"</span><span>:</span>
        <span>[</span><span>"</span><span>tihttp=tihttp.main:run_main</span><span>"</span><span>]</span>
        <span>},</span>
<span>)</span>
import setuptools

setuptools.setup(
    name="tihttp",
    version="0.1.0",

    package_dir={"": "src"},
    packages=setuptools.find_packages(where="src"),

    install_requires=[
        "requests>=2.21",
    ],

    entry_points={
        "console_scripts":
        ["tihttp=tihttp.main:run_main"]
        },
)

Enter fullscreen mode Exit fullscreen mode

The package_dir and packages values are necessary when a source layout is used, so that setup.py knows where to look for the packages. We used here a source layout to show these key-values and how they affect the entry_points section. The entry_points section tells pip where the command line tool is invoked from.

The command (in this case tihttp) is mapped to the starting point of the command line tool (here the run_main() function). Now tihttp can be installed and the command should return a proper help interface.


$ pip install .
$ tihttp --help
$ pip install .

$ tihttp --help
$ pip install .

$ tihttp --help

Enter fullscreen mode Exit fullscreen mode

Another big advantage of this setup is that pip allows to install packages in editable mode:


$ pip install -e .
$ pip install -e .
$ pip install -e .

Enter fullscreen mode Exit fullscreen mode

Your project is then installed into your currently activated virtual environment and every change to the code immediately affects this installed dependency. This allows to continue developing while testing the package comfortably. Furthermore, the setup.py file allows to download and install your project directly from github.


$ pip install https://github.com/NiklasTiede/tinyHTTPie/archive/5-Distributing-by-Setup-File.zip
$ pip install https://github.com/NiklasTiede/tinyHTTPie/archive/5-Distributing-by-Setup-File.zip
$ pip install https://github.com/NiklasTiede/tinyHTTPie/archive/5-Distributing-by-Setup-File.zip

Enter fullscreen mode Exit fullscreen mode

Direct installations from github can take time especially for projects which are bigger (large git history) and use non-Python languages. Therefore PyPI and Anaconda are usually the preferred places to go for installing packages.

I want to note that many developers in the python community store project metadata and settings used for linting/testing within a setup.cfg file instead of a setup.py file but this is a topic for another post.

The Evolution of a Script (9 Part Series)

原文链接：Distribute a Python App via Setup.py File

展开阅读全文

文章版权声明 1、本网站名称：拾光赋
2、本站永久网址：https://www.blogs.ink
3、本网站的文章部分内容可能来源于网络，仅供大家学习与参考，如有侵权，请联系站长QQ：805375623进行删除处理。
4、本站一切资源不代表本站立场，并不代表本站赞同其观点和对其真实性负责。
5、本站一律禁止以任何方式发布或转载任何违法的相关信息，访客发现请向站长举报
6、本站资源大多存储在云盘，如发现链接失效，请联系我们我们会第一时间更新。

THE END