如何通过setup.py install安装Python项目敏感配置文件的dist版本？

Great question! Keeping sensitive configs out of your GitHub repo is a solid practice, and integrating that config/secrets.py-dist file into your setup.py install process is totally feasible with clean, Pythonic approaches. Let’s break down two straightforward methods:

1. Customize the Install Command (Most Seamless) #

This approach extends setuptools' default install command to automatically copy your dist config file after the standard installation completes. It avoids overwriting existing user configs, which is a key detail for usability.

Add this to your setup.py:

import os
import shutil
from setuptools import setup
from setuptools.command.install import install

class CustomInstall(install):
    def run(self):
        # Execute the standard install first
        install.run(self)
        
        # Define paths (replace `your_package_name` with your actual package name)
        src_dist_config = os.path.join(os.path.dirname(__file__), "config", "secrets.py-dist")
        dest_config_dir = os.path.join(self.install_lib, "your_package_name", "config")
        dest_config = os.path.join(dest_config_dir, "secrets.py")
        
        # Create destination directory if it doesn't exist
        os.makedirs(dest_config_dir, exist_ok=True)
        
        # Only copy if secrets.py doesn't already exist (protect user edits)
        if not os.path.exists(dest_config):
            shutil.copy(src_dist_config, dest_config)
            print(f"✅ Copied default secrets config to: {dest_config}")

setup(
    # ... your existing setup parameters (name, version, packages, etc.) ...
    cmdclass={"install": CustomInstall},
)

2. Data Files + Post-Install Hook (Alternative) #

If you prefer not to override the entire install command, you can package the dist file as data and use a lightweight post-install script to handle the copy.

Step 1: Include the dist file in your package data #

Update your setup.py to include the dist config as a data file:

setup(
    # ... existing params ...
    data_files=[("your_package_configs", ["config/secrets.py-dist"])],
)

Step 2: Create a post-install script #

Make a new file post_install.py in your project root:

import os
import shutil
from pkg_resources import get_distribution

def setup_secrets_config():
    dist = get_distribution("your_package_name")
    install_root = dist.location
    
    # Path to the installed dist file
    src_dist_config = os.path.join(install_root, "your_package_configs", "secrets.py-dist")
    # Path where the active config should live
    dest_config = os.path.join(install_root, "your_package_name", "config", "secrets.py")
    
    os.makedirs(os.path.dirname(dest_config), exist_ok=True)
    if not os.path.exists(dest_config):
        shutil.copy(src_dist_config, dest_config)
        print("✅ Default secrets config installed. Remember to update it with your values!")

if __name__ == "__main__":
    setup_secrets_config()

Step 3: Register the hook in setup.py #

Add an entry point to run the script automatically post-install:

setup(
    # ... existing params ...
    entry_points={
        "console_scripts": [
            "setup-your-package-secrets = post_install:setup_secrets_config",
        ],
    },
)

After installation, users can run setup-your-package-secrets to set up the config (or you can trigger it programmatically if needed).

Critical Notes #

• Never commit secrets.py! Add config/secrets.py to your .gitignore file immediately.
• Add clear comments in secrets.py-dist explaining which values users need to replace.
• For editable installs (pip install -e .), the first method will copy the config to your source directory— make sure you don’t accidentally commit that file.

内容的提问来源于stack exchange，提问作者Tom at FFI