如何使用 setuptools 和 setup.py 从包中排除单个文件

2022-01-13 00:00:00 python setuptools pypi package

问题描述

我正在研究 blowdrycss.存储库在这里.

I am working on blowdrycss. The repository is here.

我希望将 blowdrycss_settings.py 的设置文件从 pypi 的最终包中排除.目的是动态构建一个自定义设置文件，该文件将放置在用户 virtualenv/项目文件夹中.

I want the settings file for blowdrycss_settings.py to be excluded from the final package on pypi. The intention is to dynamically build a custom settings file that will be placed in the users virtualenv / project folder.

在 setup.py 中，我有以下内容:

In setup.py, I have the following:

packages=find_packages(exclude=['blowdrycss_settings.py', ]),

我也试过 exclude_package_data:

exclude_package_data={
    '': ['blowdrycss_settings.py'],
    '': ['blowdrycss/blowdrycss_settings.py'],
    'blowdrycss': ['blowdrycss_settings.py'],
},

然后我运行 python setup.py sdist bdist.

但是，当我查看构建文件夹时，我仍然看到 blowdrycss_settings.py:

However, when I look in the build folder I still see blowdrycss_settings.py:

- build 
    - lib
        - blowdrycss_settings.py

似乎只排除一个文件应该很简单.

It seems like it should be simple to just exclude a file.

如何从分布式包中排除blowdrycss_settings.py?

How do I exclude blowdrycss_settings.py from the distributed package?

解决方案

这是我的解决方案.

在 blowdrycss 下，我创建了一个名为 settings 的新模块，因此目录结构现在如下所示:

Underneath of blowdrycss, I created a new module called settings so the directory structure now looks like this:

blowdrycss
    blowdrycss
        settings
            blowdrycss_settings.py

基于此参考，在setup.py 我有以下内容:

Based on this reference, inside of setup.py I have the following:

packages=find_packages(exclude=['*.settings', ]),

构建发行版:

  1. 删除 build、dist 和 .egg-info 文件夹.
  2. 运行python setup.py sdist bdist
  1. Delete the build, dist, and .egg-info folders.
  2. Run python setup.py sdist bdist

回想起来，我无法做我最初尝试的事情是件好事.新结构感觉更干净，更模块化.

In retrospect, it is good that I was unable to do what I was originally attempting. The new structure feels cleaner and is more modular.

相关文章