我已经将一个软件包上传到PyPI,该软件包含file1和file2,用户可以针对这些软件包进行特定配置的编辑。
现在,当我对此软件包进行更改并且用户决定使用pip install - U package
更新其安装时,是否有办法将该文件1和文件2保留原样,因为如果它确实升级,则用户将拥有重做他们的配置。
我可以在setup.py中引入一些可以产生预期效果的代码吗?以下是我的setup.py
# Always prefer setuptools over distutils
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path
pwd = path.abspath(path.dirname(__file__))
with open(path.join(pwd, 'LICENSE.txt'), encoding='utf-8') as f:
long_description = f.read()
setup(
name='mypackage',
# Using version number from git tag
# use_scm_version={"root": "..", "relative_to": __file__},
use_scm_version=True,
setup_requires=['setuptools_scm'],
description='XYZ',
long_description=long_description,
# The project's main homepage.
url='https://www.google.com/',
# Author details
author='XYZ',
author_email='xyz@xyz.com',
# Choose your license
license='See package description',
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers=[
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 3 - Alpha',
# Keep updating supported frameworks here
'Framework :: Django',
# Indicate who your project is intended for
'Intended Audience :: Developers',
'Intended Audience :: System Administrators',
'Intended Audience :: Information Technology',
# Pick your license as you wish (should match "license" above)
'License :: Other/Proprietary License',
# Specify the Python versions you support here. In particular, ensure
# that you indicate whether you support Python 2, Python 3 or both.
'Programming Language :: Python :: 2.7',
],
# Project associated keywords - space separated
keywords='ca_apm_agent performance-monitoring development APM',
# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
packages=find_packages(exclude=['docs', 'tests']),
# Alternatively, if you want to distribute just a my_module.py, uncomment
# this:
# py_modules=["my_module"],
# List run-time dependencies here. These will be installed by pip when
# your project is installed. For an analysis of "install_requires" vs pip's
# requirements files see:
# https://packaging.python.org/en/latest/requirements.html
install_requires=[],
# List additional groups of dependencies here (e.g. development
# dependencies). You can install these using the following syntax,
# for example:
# $ pip install -e .[dev,test]
extras_require={
'dev': ['check-manifest'],
'test': ['coverage'],
},
# If there are data files included in your packages that need to be
# installed, specify them here. If using Python 2.6 or less, then these
# have to be included in MANIFEST.in as well.
include_package_data=True,
package_data={
'mypackage': ['directives/file1, directives/file2'],
},
# Although 'package_data' is the preferred approach, in some case you may
# need to place data files outside of your packages. See:
# http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
# data_files=[('my_data', ['data/data_file'])],
data_files=[],
# To provide executable scripts, use entry points in preference to the
# "scripts" keyword. Entry points provide cross-platform support and allow
# pip to create the appropriate form of executable for the target platform.
entry_points={
'console_scripts': [
'mypackage-run=mypackage:main',
],
},
)
答案 0 :(得分:2)
用户不应编辑您的发行版中包含的文件,也不应在安装发行版的目录中创建任何新文件。
一种常见的模式是使用homedir中的文件,例如~/.myapp.cfg
用于任何自定义,然后只需在您的应用中分发一些合理的默认配置。
您的应用会检查是否存在用户配置,但该应用不应要求存在自定义配置才能运行。您可以决定是否要在默认配置之上“分层”用户配置,或者只是优先使用默认配置。
确保明确记录用户配置的文件格式和预期位置。