Django 关于Packaging your app的基础总结

预准备:安装setuptools和pip工具

  • 1.在工程目录外,创建app的一个父目录,目录名你可以命名为:django-polls.
  • 2.将app目录移动到django-polls中。
  • 3.创建一个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.
  • 4.创建一个django-polls/LICENSE文件
  • 5.接下来,我们要创建一个setup.py文件,它提供了怎样编译和安装app的细节。创建django-polls/setup.py文件,内容如下:
import os
from setuptools import find_packages, 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=find_packages(),
  include_package_data=True,
  license='BSD License', # example license
  description='A simple Django app to conduct Web-based polls.',
  long_description=README,
  url='https://www.example.com/',
  author='Your Name',
  author_email='yourname@example.com',
  classifiers=[
    'Environment :: Web Environment',
    'Framework :: Django',
    'Framework :: Django :: X.Y', # replace "X.Y" as appropriate
    '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.4',
    'Programming Language :: Python :: 3.5',
    'Topic :: Internet :: WWW/HTTP',
    'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
  ],
)
  • 6.默认情况下,只有Python的模块和包,包含在包里面。为了包含其他的文件,我们需要创建一个MANIFEST.in文件,为了包含 templates, README.rst 和LICENSE 文件, 创建一个
    django-polls/MANIFEST.in 文件,内容如下:
include LICENSE
include README.rst
recursive-include polls/static *
recursive-include polls/templates *
  • 7.可选的一步,但是强烈建议,app最好包含一些细节文档,创建一个空目录django-polls/docs,为以后使用,另外,在django-polls/MANIFEST.in文件中,新增一行:recursive-include docs *
  • 8.尝试使用命令python setup.py sdist来编译你的包,这将会创建一个称为dist的目录并会编译成新的包django-polls-0.1.tar.gz.

补充说明:

  • 1.安装我们app 包,使用pip命令:
    pip install --user django-polls/dist/django-polls-0.1.tar.gz
  • 2.卸载包,使用下面的命令
    pip uninstall django-polls
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,284评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,115评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,614评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,671评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,699评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,562评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,309评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,223评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,668评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,859评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,981评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,705评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,310评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,904评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,023评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,146评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,933评论 2 355

推荐阅读更多精彩内容