将应用打包需要安装: setuptools
安装和卸载应用需要安装: pip
举例polls是一个应用包。 polls文件夹中包含所有有关应用的文件。
打包应用:
- 首先,在你的Django项目之外,为polls创建一个父目录。称这个目录为django-polls。
为你的应用选择一个名字
当为你的包选择一个名字时,检查一下PyPI中的资源以避免与已经存在的包有名字冲突。当创建一个要发布的包时,在你的模块名字前面加上django-通常很有用。 这有助于其他正在查找Django应用的人区分你的应用是专门用于Django的。
应用的标签(应用的包的点分路径的最后部分)在INSTALLED_APPS中必须唯一。避免使用与Django的contrib 包 中任何一个使用相同的标签,例如auth、admin和messages。
- 将polls 目录移动到django-polls目录。
- 创建一个包含一些内容的文件django-polls/README.rst:
django-polls/README.rst
===== Polls ===== Polls is a simple Django app to conduct Web-based polls. For each question, visitors can choose between a fixed number of answers. Detailed documentation is in the "docs" directory. Quick start ----------- 1. Add "polls" to your INSTALLED_APPS setting like this:: INSTALLED_APPS = ( ... ‘polls‘, ) 2. Include the polls URLconf in your project urls.py like this:: url(r‘^polls/‘, include(‘polls.urls‘)), 3. Run `python manage.py migrate` to create the polls models. 4. Start the development server and visit http://127.0.0.1:8000/admin/ to create a poll (you‘ll need the Admin app enabled). 5. Visit http://127.0.0.1:8000/polls/ to participate in the poll.
- 创建一个django-polls/LICENSE文件。选择License超出本教程的范围,但值得一说的是公开发布的代码如果没有License是毫无用处的。Django和许多与Django兼容的应用以BSD License 发布;然而,你可以随便挑选自己的License。只需要知道你的License的选择将影响谁能够使用你的代码。
- 下一步我们将创建一个setup.py 文件,它提供如何构建和安装该应用的详细信息。该文件完整的解释超出本教程的范围,setuptools 文档 有很好的解释。创建一个文件django-polls/setup.py,其内容如下:
django-polls/setup.py
import os from setuptools import setup with open(os.path.join(os.path.dirname(__file__), ‘README.rst‘)) as readme: README = readme.read() # allow setup.py to be run from any path os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir))) setup( name=‘django-polls‘, version=‘0.1‘, packages=[‘polls‘], include_package_data=True, license=‘BSD License‘, # example license description=‘A simple Django app to conduct Web-based polls.‘, long_description=README, url=‘http://www.example.com/‘, author=‘Your Name‘, author_email=‘[email protected]‘, classifiers=[ ‘Environment :: Web Environment‘, ‘Framework :: Django‘, ‘Intended Audience :: Developers‘, ‘License :: OSI Approved :: BSD License‘, # example license ‘Operating System :: OS Independent‘, ‘Programming Language :: Python‘, # Replace these appropriately if you are stuck on Python 2. ‘Programming Language :: Python :: 3‘, ‘Programming Language :: Python :: 3.2‘, ‘Programming Language :: Python :: 3.3‘, ‘Topic :: Internet :: WWW/HTTP‘, ‘Topic :: Internet :: WWW/HTTP :: Dynamic Content‘, ], )
- 默认只有Python模块和包会包含进包中。如果需要包含额外的文件,我们需要创建一个MANIFEST.in文件。上一步提到的setuptools 文档对这个文件有更详细的讨论。如果要包含模板、README.rst和我们的LICENSE 文件,创建一个文件django-polls/MANIFEST.in,其内容如下:
django-polls/MANIFEST.in
include LICENSE include README.rst recursive-include polls/static * recursive-include polls/templates *
- 将详细的文档包含进你的应用中,它是可选的,但建议你这样做。创建一个空的目录django-polls/docs用于将来存放文档。向django-polls/MANIFEST.in添加另外一行:
recursive-include docs *
注意docs不会包含进你的包中除非你添加一些文件到它下面。许多Django应用还通过类似readthedocs.org这样的站点提供它们的在线文档.
- 试着通过python setup.py sdist 构建你的包(从django-polls的内部运行)。这会创建一个dist目录并构建一个新包:django-polls-0.1.tar.gz。
更多关于打包的信息,参见Python 的 打包和分发项目的教程。
安装和卸载自己的包:
因为,我们将polls 目录移到项目的目录之外,它不再工作了。我们将通过安装我们的新的django-polls包来修复它。
安装成某个用户的库
以下的步骤将安装django-polls 成某个用户的库。用户级别的安装比系统级别的安装有许多优点,例如将包运行在普通用户级别上不但不会影响系统服务还不会影响其他用户
注意根据用户的安装仍然可以影响以该用户身份运行的系统工具,所以virtualenv 是更健壮的解决办法(见下文)。
- 安装这个包,使用pip(你已经安装好它了,对吧?):
pip install --user django-polls/dist/django-polls-0.1.tar.gz
- 幸运的话,你的Django 项目现在应该又能正常工作了。请重新运行服务器以证实这点。
- 若要卸载这个包,使用pip:
pip uninstall django-polls
时间: 2024-10-05 05:00:36