1. requirements.txt

简介

Python项目中必须包含一个 requirements.txt 文件，用于记录所有依赖包及其精确的版本号。以便新环境部署。

主要的写法如下所示

pip freeze > requirements.txt # 生成requirements.txt
pip install -r requirements.txt # 从requirements.txt安装依赖

支持的写法

-r base.txt # base.txt下面的所有包
pypinyin==0.12.0 # 指定版本（最日常的写法）
django-querycount>=0.5.0 # 大于某个版本
django-debug-toolbar>=1.3.1,<=1.3.3 # 版本范围
ipython # 默认（存在不替换，不存在安装最新版）

推荐用法

一般项目会分为开发环境，测试环境，生产环境等……依赖的包会不同。推荐在文件夹下为每个环境建立一个requirements.txt文件。公有的包存在base.txt供引用

➜ meeting git:(sync) ✗ tree requirements -h
requirements
├── [ 286] base.txt
├── [ 80] local.txt
└── [ 28] production.txt

推荐手动维护依赖列表。

2. setup.py

编写python的第三方库，最终要的一个工作就是编写setup.py了，其实如果我们下载过一些第三库的源代码文件，打开之后一般就会有一个setup.py,执行python setup.py install 就可以安装这个库了。

import os

from setuptools import setup, find_packages

here = os.path.abspath(os.path.dirname(__file__))

# Avoids IDE errors, but actual version is read from version.py
__version__ = None
with open("rasa/version.py") as f:
    exec (f.read())

# Get the long description from the README file
with open(os.path.join(here, "README.md"), encoding="utf-8") as f:
    long_description = f.read()

tests_requires = [
    "pytest~=4.5",
    "pytest-cov~=2.7",
    "pytest-localserver~=0.5.0",
    "pytest-sanic~=1.0.0",
    "responses~=0.9.0",
    "freezegun~=0.3.0",
    "nbsphinx>=0.3",
    "aioresponses~=0.6.0",
    "moto~=1.3.8",
]

install_requires = [
    "requests~=2.22",
    "boto3~=1.9",
    "matplotlib~=3.0",
    "simplejson~=3.16",
    "attrs>=18",
    "jsonpickle~=1.1",
    "redis~=3.2",
    "fakeredis~=1.0",
    "pymongo~=3.8",
    "numpy~=1.16",
    "scipy~=1.2",
    "tensorflow~=1.13.0",
    "apscheduler~=3.0",
    "tqdm~=4.0",
    "networkx~=2.3",
    "fbmessenger~=6.0",
    "pykwalify~=1.7.0",
    "coloredlogs~=10.0",
    "scikit-learn~=0.20.2",
    "ruamel.yaml~=0.15.0",
    "scikit-learn~=0.20.0",
    "slackclient~=1.3",
    "python-telegram-bot~=11.0",
    "twilio~=6.0",
    "webexteamssdk~=1.1",
    "mattermostwrapper~=2.0",
    "rocketchat_API~=0.6.0",
    "colorhash~=1.0",
    "pika~=1.0.0",
    "jsonschema~=2.6",
    "packaging~=19.0",
    "gevent~=1.4",
    "pytz~=2019.1",
    "python-dateutil~=2.8",
    "rasa-sdk~=1.0.0rc4",
    "colorclass~=2.2",
    "terminaltables~=3.1",
    "sanic~=19.3.1",
    "sanic-cors~=0.9.0",
    "sanic-jwt~=1.3",
    "aiohttp~=3.5",
    "questionary>=1.1.0",
    "python-socketio~=4.0",
    "pydot~=1.4",
    "async_generator~=1.10",
    "SQLAlchemy~=1.3.0",
    "kafka-python~=1.4",
    "sklearn-crfsuite~=0.3.6",
    # temporary dependency, until https://github.com/boto/botocore/issues/1733 is fixed
    "urllib3<1.25",
]

extras_requires = {
    "test": tests_requires,
    "spacy": ["spacy>=2.1,<2.2"],
    "mitie": ["mitie"],
    "sql": ["psycopg2~=2.8.2", "SQLAlchemy~=1.3"],
}
# 启动入口
setup(
    name="rasa", # 包名称
    classifiers=[ # 程序所属分类列表
        "Development Status :: 4 - Beta",
        "Intended Audience :: Developers",
        "License :: OSI Approved :: Apache Software License",
        # supported python versions
        "Programming Language :: Python",
        "Programming Language :: Python :: 3.5",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        "Topic :: Software Development :: Libraries",
    ],
    packages=find_packages(exclude=["tests", "tools", "docs", "contrib"]), # 需要处理的包目录
    entry_points={"console_scripts": ["rasa=rasa.__main__:main"]}, # 动态发现服务和插件
    version=__version__, # 包版本
    install_requires=install_requires, # 需要安装的依赖包
    tests_require=tests_requires,
    extras_require=extras_requires,
    include_package_data=True,
    description="Open source machine learning framework to automate text- and " # 包详细描述
    "voice-based conversations: NLU, dialogue management, connect to "
    "Slack, Facebook, and more - Create chatbots and voice assistants",
    long_description=long_description, # 长描述，通常是readme，打包到PiPy需要
    long_description_content_type="text/markdown", # 长描述文档类型
    author="Rasa Technologies GmbH", # 作者名称
    author_email="hi@rasa.com", # 作者邮箱
    maintainer="Tom Bocklisch", # 维护人员名称
    maintainer_email="tom@rasa.com", # 维护人员邮箱
    license="Apache 2.0", # 版权信息
    keywords="nlp machine-learning machine-learning-library bot bots "
    "botkit rasa conversational-agents conversational-ai chatbot"
    "chatbot-framework bot-framework", # 关键词
    url="https://rasa.com", # 项目官网
    download_url="https://github.com/RasaHQ/rasa/archive/{}.tar.gz"
    "".format(__version__), # 下载地址
    project_urls={
        "Bug Reports": "https://github.com/rasahq/rasa/issues",
        "Source": "https://github.com/rasahq/rasa",
    }, # 项目工程地址
)

print ("\nWelcome to Rasa!")
print (
    "If you have any questions, please visit our documentation page: https://rasa.com/docs/"
)
print ("or join the community discussions on https://forum.rasa.com/")

参数概述

setup 函数常用的参数如下：