贡献¶

Contributing

中文

欢迎！

本文档内容相当详尽，但对于一些小型贡献，你其实无需深入阅读全部内容；

最重要的规则是：贡献应该是轻松的，社区应当友好，且不应在细枝末节上吹毛求疵，比如代码风格问题。

如果你要报告一个 bug，请阅读下方的 “报告 Bug” 一节，以确保你的报告中包含足够的信息，以便我们能成功诊断问题；如果你要贡献代码，建议你尽量遵循你所修改代码周围已有的编码习惯，但最终，合并变更的人会清理所有补丁内容，因此不必过于担心细节。

英文

Welcome!

This document is fairly extensive and you aren't really expected to study this in detail for small contributions;

The most important rule is that contributing must be easy and that the community is friendly and not nitpicking on details, such as coding style.

If you're reporting a bug you should read the Reporting bugs section below to ensure that your bug report contains enough information to successfully diagnose the issue, and if you're contributing code you should try to mimic the conventions you see surrounding the code you're working on, but in the end all patches will be cleaned up by the person merging the changes so don't worry too much.

报告错误¶

Reporting Bugs

安全¶

Security

中文

你 绝不能 将涉及安全的问题、漏洞或包含敏感信息的错误报告到 Bug 追踪器或其他公共平台。此类敏感 Bug 应通过电子邮件发送至 security@celeryproject.org。

如果你希望加密发送信息，我们的 PGP 公钥如下:

-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1.4.15 (Darwin)

mQENBFJpWDkBCADFIc9/Fpgse4owLNvsTC7GYfnJL19XO0hnL99sPx+DPbfr+cSE
9wiU+Wp2TfUX7pCLEGrODiEP6ZCZbgtiPgId+JYvMxpP6GXbjiIlHRw1EQNH8RlX
cVxy3rQfVv8PGGiJuyBBjxzvETHW25htVAZ5TI1+CkxmuyyEYqgZN2fNd0wEU19D
+c10G1gSECbCQTCbacLSzdpngAt1Gkrc96r7wGHBBSvDaGDD2pFSkVuTLMbIRrVp
lnKOPMsUijiip2EMr2DvfuXiUIUvaqInTPNWkDynLoh69ib5xC19CSVLONjkKBsr
Pe+qAY29liBatatpXsydY7GIUzyBT3MzgMJlABEBAAG0MUNlbGVyeSBTZWN1cml0
eSBUZWFtIDxzZWN1cml0eUBjZWxlcnlwcm9qZWN0Lm9yZz6JATgEEwECACIFAlJp
WDkCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOArFOUDCicIw1IH/26f
CViDC7/P13jr+srRdjAsWvQztia9HmTlY8cUnbmkR9w6b6j3F2ayw8VhkyFWgYEJ
wtPBv8mHKADiVSFARS+0yGsfCkia5wDSQuIv6XqRlIrXUyqJbmF4NUFTyCZYoh+C
ZiQpN9xGhFPr5QDlMx2izWg1rvWlG1jY2Es1v/xED3AeCOB1eUGvRe/uJHKjGv7J
rj0pFcptZX+WDF22AN235WYwgJM6TrNfSu8sv8vNAQOVnsKcgsqhuwomSGsOfMQj
LFzIn95MKBBU1G5wOs7JtwiV9jefGqJGBO2FAvOVbvPdK/saSnB+7K36dQcIHqms
5hU4Xj0RIJiod5idlRC5AQ0EUmlYOQEIAJs8OwHMkrdcvy9kk2HBVbdqhgAREMKy
gmphDp7prRL9FqSY/dKpCbG0u82zyJypdb7QiaQ5pfPzPpQcd2dIcohkkh7G3E+e
hS2L9AXHpwR26/PzMBXyr2iNnNc4vTksHvGVDxzFnRpka6vbI/hrrZmYNYh9EAiv
uhE54b3/XhXwFgHjZXb9i8hgJ3nsO0pRwvUAM1bRGMbvf8e9F+kqgV0yWYNnh6QL
4Vpl1+epqp2RKPHyNQftbQyrAHXT9kQF9pPlx013MKYaFTADscuAp4T3dy7xmiwS
crqMbZLzfrxfFOsNxTUGE5vmJCcm+mybAtRo4aV6ACohAO9NevMx8pUAEQEAAYkB
HwQYAQIACQUCUmlYOQIbDAAKCRDgKxTlAwonCNFbB/9esir/f7TufE+isNqErzR/
aZKZo2WzZR9c75kbqo6J6DYuUHe6xI0OZ2qZ60iABDEZAiNXGulysFLCiPdatQ8x
8zt3DF9BMkEck54ZvAjpNSern6zfZb1jPYWZq3TKxlTs/GuCgBAuV4i5vDTZ7xK/
aF+OFY5zN7ciZHkqLgMiTZ+RhqRcK6FhVBP/Y7d9NlBOcDBTxxE1ZO1ute6n7guJ
ciw4hfoRk8qNN19szZuq3UU64zpkM2sBsIFM9tGF2FADRxiOaOWZHmIyVZriPFqW
RUwjSjs7jBVNq0Vy4fCu/5+e+XLOUBOoqtM5W7ELt0t1w9tXebtPEetV86in8fU2
=0chn
-----END PGP PUBLIC KEY BLOCK-----

英文

You must never report security related issues, vulnerabilities or bugs including sensitive information to the bug tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to security@celeryproject.org.

If you'd like to submit the information encrypted our PGP key is:

-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1.4.15 (Darwin)

mQENBFJpWDkBCADFIc9/Fpgse4owLNvsTC7GYfnJL19XO0hnL99sPx+DPbfr+cSE
9wiU+Wp2TfUX7pCLEGrODiEP6ZCZbgtiPgId+JYvMxpP6GXbjiIlHRw1EQNH8RlX
cVxy3rQfVv8PGGiJuyBBjxzvETHW25htVAZ5TI1+CkxmuyyEYqgZN2fNd0wEU19D
+c10G1gSECbCQTCbacLSzdpngAt1Gkrc96r7wGHBBSvDaGDD2pFSkVuTLMbIRrVp
lnKOPMsUijiip2EMr2DvfuXiUIUvaqInTPNWkDynLoh69ib5xC19CSVLONjkKBsr
Pe+qAY29liBatatpXsydY7GIUzyBT3MzgMJlABEBAAG0MUNlbGVyeSBTZWN1cml0
eSBUZWFtIDxzZWN1cml0eUBjZWxlcnlwcm9qZWN0Lm9yZz6JATgEEwECACIFAlJp
WDkCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOArFOUDCicIw1IH/26f
CViDC7/P13jr+srRdjAsWvQztia9HmTlY8cUnbmkR9w6b6j3F2ayw8VhkyFWgYEJ
wtPBv8mHKADiVSFARS+0yGsfCkia5wDSQuIv6XqRlIrXUyqJbmF4NUFTyCZYoh+C
ZiQpN9xGhFPr5QDlMx2izWg1rvWlG1jY2Es1v/xED3AeCOB1eUGvRe/uJHKjGv7J
rj0pFcptZX+WDF22AN235WYwgJM6TrNfSu8sv8vNAQOVnsKcgsqhuwomSGsOfMQj
LFzIn95MKBBU1G5wOs7JtwiV9jefGqJGBO2FAvOVbvPdK/saSnB+7K36dQcIHqms
5hU4Xj0RIJiod5idlRC5AQ0EUmlYOQEIAJs8OwHMkrdcvy9kk2HBVbdqhgAREMKy
gmphDp7prRL9FqSY/dKpCbG0u82zyJypdb7QiaQ5pfPzPpQcd2dIcohkkh7G3E+e
hS2L9AXHpwR26/PzMBXyr2iNnNc4vTksHvGVDxzFnRpka6vbI/hrrZmYNYh9EAiv
uhE54b3/XhXwFgHjZXb9i8hgJ3nsO0pRwvUAM1bRGMbvf8e9F+kqgV0yWYNnh6QL
4Vpl1+epqp2RKPHyNQftbQyrAHXT9kQF9pPlx013MKYaFTADscuAp4T3dy7xmiwS
crqMbZLzfrxfFOsNxTUGE5vmJCcm+mybAtRo4aV6ACohAO9NevMx8pUAEQEAAYkB
HwQYAQIACQUCUmlYOQIbDAAKCRDgKxTlAwonCNFbB/9esir/f7TufE+isNqErzR/
aZKZo2WzZR9c75kbqo6J6DYuUHe6xI0OZ2qZ60iABDEZAiNXGulysFLCiPdatQ8x
8zt3DF9BMkEck54ZvAjpNSern6zfZb1jPYWZq3TKxlTs/GuCgBAuV4i5vDTZ7xK/
aF+OFY5zN7ciZHkqLgMiTZ+RhqRcK6FhVBP/Y7d9NlBOcDBTxxE1ZO1ute6n7guJ
ciw4hfoRk8qNN19szZuq3UU64zpkM2sBsIFM9tGF2FADRxiOaOWZHmIyVZriPFqW
RUwjSjs7jBVNq0Vy4fCu/5+e+XLOUBOoqtM5W7ELt0t1w9tXebtPEetV86in8fU2
=0chn
-----END PGP PUBLIC KEY BLOCK-----

其他错误¶

Other bugs

中文

你也可以在 mailing-list 中描述 Bug，但确保及时回应和跟进的最佳方式是使用问题追踪器。

创建 GitHub 账号

你需要创建一个 GitHub 账号才能创建新的 Issue 并参与讨论。

确认你报告的问题确实是 Bug

如果你是请求支持，而不是报告 Bug，请使用 mailing-list 或 irc-channel。如果你仍然需要通过 GitHub 提问，请在标题前加上 [QUESTION]。

确保该 Bug 尚未被报告过

请在相关 Issue 追踪器中搜索是否已有类似问题，如果找到，请确认是否可以提供更多新信息来帮助开发者修复该问题。

检查你是否使用的是最新版本

有些 Bug 可能已在后续修复中被解决，但没有被单独报告。请确保你使用的是 celery、billiard、kombu、amqp 和 vine 的最新版本。

收集与 Bug 相关的信息

为了尽可能高效地重现问题，我们需要完整的触发条件。大多数情况下是 Python 的回溯信息，但也可能是设计、拼写或网站/文档/代码中的其他错误。

如果是 Python 异常，请将回溯信息包含在报告中。

我们还需要知道你所使用的平台（Windows、macOS、Linux 等）、Python 解释器的版本、Celery 及其依赖包的版本。

如果你报告的是竞争条件或死锁，这类错误的回溯信息可能难以获取，或没有帮助。请尽可能收集进程诊断信息。例如：

启用 Celery 的 breakpoint signal，用于检查进程状态，并打开 pdb 会话。

使用如下工具收集追踪信息： strace （Linux）、 dtruss`（macOS）、 :command:`ktrace （BSD）、 ltrace、 lsof。
包含 celery report 命令的输出：
$ celery -A proj report
这将包括你的配置设定，并尝试清除已知敏感键的值。但请在提交前确认这些信息不包含如 API Token 和认证凭据等机密信息。
你的 Issue 可能会被标记为 Needs Test Case。测试用例代表复现问题所需的所有信息，可能是最小复现代码或完整的复现步骤和配置参数。

提交 Bug

默认情况下，GitHub 会在你的 Bug 有新评论时通过邮件通知你。如果你关闭了这个功能，请记得定期查看 Issue，以免错过开发者可能提出的问题。

英文

Bugs can always be described to the mailing-list, but the best way to report an issue and to ensure a timely response is to use the issue tracker.

Create a GitHub account.

You need to create a GitHub account to be able to create new issues and participate in the discussion.

Determine if your bug is really a bug.

You shouldn't file a bug if you're requesting support. For that you can use the mailing-list, or irc-channel. If you still need support you can open a github issue, please prepend the title with [QUESTION].

Make sure your bug hasn't already been reported.

Search through the appropriate Issue tracker. If a bug like yours was found, check if you have new information that could be reported to help the developers fix the bug.

Check if you're using the latest version.

A bug could be fixed by some other improvements and fixes - it might not have an existing report in the bug tracker. Make sure you're using the latest releases of celery, billiard, kombu, amqp, and vine.

Collect information about the bug.

To have the best chance of having a bug fixed, we need to be able to easily reproduce the conditions that caused it. Most of the time this information will be from a Python traceback message, though some bugs might be in design, spelling or other errors on the website/docs/code.

If the error is from a Python traceback, include it in the bug report.

B) We also need to know what platform you're running (Windows, macOS, Linux, etc.), the version of your Python interpreter, and the version of Celery, and related packages that you were running when the bug occurred.

C) If you're reporting a race condition or a deadlock, tracebacks can be hard to get or might not be that useful. Try to inspect the process to get more diagnostic data. Some ideas:

Enable Celery's breakpoint signal and use it
to inspect the process's state. This will allow you to open a pdb session.

Collect tracing data using `strace`_(Linux),
dtruss (macOS), and ktrace (BSD), ltrace, and lsof.
Include the output from the celery report command:
$ celery -A proj report
This will also include your configuration settings and it will try to remove values for keys known to be sensitive, but make sure you also verify the information before submitting so that it doesn't contain confidential information like API tokens and authentication credentials.
E) Your issue might be tagged as Needs Test Case. A test case represents all the details needed to reproduce what your issue is reporting. A test case can be some minimal code that reproduces the issue or detailed instructions and configuration values that reproduces said issue.

Submit the bug.

By default GitHub will email you to let you know when new comments have been made on your bug. In the event you've turned this feature off, you should check back on occasion to ensure you don't miss any questions a developer trying to fix the bug might ask.

问题跟踪器¶

Issue Trackers

中文

Celery 生态系统中的软件包如果出现错误，应将其报告到相应的问题跟踪器。

如果你不确定错误的来源，可以在 mailing-list 上提问，或者直接使用 Celery 的问题跟踪器。

英文

Bugs for a package in the Celery ecosystem should be reported to the relevant issue tracker.

If you're unsure of the origin of the bug you can ask the mailing-list, or just use the Celery issue tracker.

代码库贡献者指南¶

Contributors guide to the code base

中文

另有一个专门部分介绍内部实现细节，包括代码库细节和编码风格指南。

阅读代码贡献指南获取更多信息！

英文

There's a separate section for internal details, including details about the code base and a style guide.

Read 代码贡献指南 for more!

版本¶

Versions

中文

版本号由主版本号、次版本号和发行号组成。自 2.1.0 版本以来，我们采用 SemVer 所描述的版本语义： http://semver.org。

稳定版本会发布到 PyPI，而开发版本仅作为 GitHub 上的标签存在于 git 仓库中。所有版本标签都以 "v" 开头，例如版本 0.8.0 的标签是 v0.8.0。

英文

Version numbers consists of a major version, minor version and a release number. Since version 2.1.0 we use the versioning semantics described by SemVer: http://semver.org.

Stable releases are published at PyPI while development releases are only available in the GitHub git repository as tags. All version tags starts with “v”, so version 0.8.0 has the tag v0.8.0.

标签¶

编码风格¶

Coding Style

中文

你应该能够从周围的代码中获得编码风格，但了解以下约定是个好主意。

所有 Python 代码必须遵循 PEP 8 指南。

https://pypi.org/project/pep8/ 是一个可以用来验证你的代码是否符合约定的工具。

文档字符串必须遵循 PEP 257 指南，并使用以下风格。

这样做：

def method(self, arg):
    """简短描述。

    更多详细信息。

    """

或者：

def method(self, arg):
    """简短描述。"""

但不要这样做：

def method(self, arg):
    """
    简短描述。
    """

行长度不应超过 78 列。

你可以通过在 vim 中设置 textwidth 选项来强制执行：
```
set textwidth=78
```
如果遵守此限制会使代码变得不易读，则可以多用一个字符。这意味着 78 是软限制，79 是硬限制 :)
导入顺序
- Python 标准库（import xxx）
- Python 标准库（from xxx import）
- 第三方包。
- 当前包的其他模块。
或者，如果代码使用 Django：
- Python 标准库（import xxx）
- Python 标准库（from xxx import）
- 第三方包。
- Django 包。
- 当前包的其他模块。
在这些部分中，导入应按模块名排序。

示例：
import threading import time from collections import deque from Queue import Queue, Empty from .platforms import Pidfile from .utils.time import maybe_timedelta
不得使用通配符导入（from xxx import *）。
对于支持 Python 2.5 的最早版本的分发，适用以下额外规则：
- 每个模块的顶部必须启用绝对导入:
  from __future__ import absolute_import
- 如果模块使用 with 语句并且必须兼容 Python 2.5（celery 不需要），则还必须启用它:
  from __future__ import with_statement
- 每个未来导入必须单独写在一行，因为早期的 Python 2.5 版本不支持在同一行导入多个特性:
  # 好 from __future__ import absolute_import from __future__ import with_statement # 不好 from __future__ import absolute_import, with_statement
（注意，如果包不包括对 Python 2.5 的支持，则此规则不适用）
请注意，当分发版不支持 Python 2.5 以下版本时，我们使用 "新风格" 的相对导入。
这需要 Python 2.5 或更高版本：
from . import submodule

英文

You should probably be able to pick up the coding style from surrounding code, but it is a good idea to be aware of the following conventions.

All Python code must follow the PEP 8 guidelines.

https://pypi.org/project/pep8/ is a utility you can use to verify that your code is following the conventions.

Docstrings must follow the PEP 257 conventions, and use the following style.

Do this:

def method(self, arg):
    """Short description.

    More details.

    """

or:

def method(self, arg):
    """Short description."""

but not this:

def method(self, arg):
    """
    Short description.
    """

Lines shouldn't exceed 78 columns.

You can enforce this in vim by setting the textwidth option:
```
set textwidth=78
```
If adhering to this limit makes the code less readable, you have one more character to go on. This means 78 is a soft limit, and 79 is the hard limit :)
Import order
- Python standard library (import xxx)
- Python standard library (from xxx import)
- Third-party packages.
- Other modules from the current package.
or in case of code using Django:
- Python standard library (import xxx)
- Python standard library (from xxx import)
- Third-party packages.
- Django packages.
- Other modules from the current package.
Within these sections the imports should be sorted by module name.

Example:
import threading import time from collections import deque from Queue import Queue, Empty from .platforms import Pidfile from .utils.time import maybe_timedelta
Wild-card imports must not be used (from xxx import *).
For distributions where Python 2.5 is the oldest support version, additional rules apply:
- Absolute imports must be enabled at the top of every module:
  from __future__ import absolute_import
- If the module uses the with statement and must be compatible with Python 2.5 (celery isn't), then it must also enable that:
  from __future__ import with_statement
- Every future import must be on its own line, as older Python 2.5 releases didn't support importing multiple features on the same future import line:
  # Good from __future__ import absolute_import from __future__ import with_statement # Bad from __future__ import absolute_import, with_statement
(Note that this rule doesn't apply if the package doesn't include support for Python 2.5)
Note that we use "new-style" relative imports when the distribution doesn't support Python versions below 2.5
This requires Python 2.5 or later:
from . import submodule

贡献需要额外库的功能¶

Contributing features requiring additional libraries

中文

某些功能，如新的结果后端，可能需要用户安装额外的库。

我们使用 setuptools extra_requires 来处理这个问题，所有需要第三方库的新可选功能都必须添加。

在 requirements/extras 中添加一个新的要求文件
对于 Cassandra 后端，这是 requirements/extras/cassandra.txt，该文件内容如下：
pycassa
这些是 pip 要求文件，因此你可以包含版本指定符，并且多个包通过换行分隔。一个更复杂的示例如下：
# pycassa 2.0 会破坏 Foo pycassa>=1.0,<2.0 thrift
修改 setup.py
添加要求文件后，你需要将其作为选项添加到 setup.py 的 extras_require 部分:
extra['extras_require'] = { # ... 'cassandra': extras('cassandra.txt'), }
在 docs/includes/installation.txt 中记录新功能
你必须将你的功能添加到 docs/includes/installation.txt 文件中的软件包部分。

在你对该文件进行更改后，需要渲染分发版 README 文件：
$ pip install -U -r requirements/pkgutils.txt $ make readme

以上是你需要做的全部工作，但请记住，如果你的功能添加了额外的配置选项，则这些选项需要在 docs/configuration.rst 中进行文档化。此外，所有设置都需要添加到 celery/app/defaults.py 模块中。

结果后端需要在 docs/configuration.rst 文件中单独的章节进行记录。

英文

Some features like a new result backend may require additional libraries that the user must install.

We use setuptools extra_requires for this, and all new optional features that require third-party libraries must be added.

Add a new requirements file in requirements/extras
For the Cassandra backend this is requirements/extras/cassandra.txt, and the file looks like this:
pycassa
These are pip requirement files, so you can have version specifiers and multiple packages are separated by newline. A more complex example could be:
# pycassa 2.0 breaks Foo pycassa>=1.0,<2.0 thrift
Modify setup.py
After the requirements file is added, you need to add it as an option to setup.py in the extras_require section:
extra['extras_require'] = { # ... 'cassandra': extras('cassandra.txt'), }
Document the new feature in docs/includes/installation.txt
You must add your feature to the list in the 软件包 section of docs/includes/installation.txt.

After you've made changes to this file, you need to render the distro README file:
$ pip install -U -r requirements/pkgutils.txt $ make readme

That's all that needs to be done, but remember that if your feature adds additional configuration options, then these needs to be documented in docs/configuration.rst. Also, all settings need to be added to the celery/app/defaults.py module.

Result backends require a separate section in the docs/configuration.rst file.

联系方式¶

Contacts

中文

这是可以联系的人员列表，适用于有关官方 Git 仓库、PyPI 包和 Read the Docs 页面的问题。

如果问题不是紧急的，最好是报告一个问题。

英文

This is a list of people that can be contacted for questions regarding the official git repositories, PyPI packages Read the Docs pages.

If the issue isn't an emergency then it's better to report an issue.

Committers¶

Website¶

The Celery Project website is run and maintained by

Mauro Rocco¶

github:: https://github.com/fireantology
twitter:: https://twitter.com/#!/fireantology

with design by:

Jan Henrik Helmers¶

web:: http://www.helmersworks.com
twitter:: https://twitter.com/#!/helmers

Packages¶

`celery`¶

git:: https://github.com/celery/celery
CI:: https://travis-ci.org/#!/celery/celery
Windows-CI:: https://ci.appveyor.com/project/ask/celery
PyPI:: https://pypi.org/project/celery/
docs:: https://docs.celeryq.dev

`kombu`¶

Messaging library.

git:: https://github.com/celery/kombu
CI:: https://travis-ci.org/#!/celery/kombu
Windows-CI:: https://ci.appveyor.com/project/ask/kombu
PyPI:: https://pypi.org/project/kombu/
docs:: https://kombu.readthedocs.io

`amqp`¶

Python AMQP 0.9.1 client.

git:: https://github.com/celery/py-amqp
CI:: https://travis-ci.org/#!/celery/py-amqp
Windows-CI:: https://ci.appveyor.com/project/ask/py-amqp
PyPI:: https://pypi.org/project/amqp/
docs:: https://amqp.readthedocs.io

`vine`¶

Promise/deferred implementation.

git:: https://github.com/celery/vine/
CI:: https://travis-ci.org/#!/celery/vine/
Windows-CI:: https://ci.appveyor.com/project/ask/vine
PyPI:: https://pypi.org/project/vine/
docs:: https://vine.readthedocs.io

`pytest-celery`¶

Pytest plugin for Celery.

git:: https://github.com/celery/pytest-celery
PyPI:: https://pypi.org/project/pytest-celery/
docs:: https://pytest-celery.readthedocs.io

`billiard`¶

Fork of multiprocessing containing improvements that'll eventually be merged into the Python stdlib.

git:: https://github.com/celery/billiard
CI:: https://travis-ci.org/#!/celery/billiard/
Windows-CI:: https://ci.appveyor.com/project/ask/billiard
PyPI:: https://pypi.org/project/billiard/

`django-celery-beat`¶

Database-backed Periodic Tasks with admin interface using the Django ORM.

git:: https://github.com/celery/django-celery-beat
CI:: https://travis-ci.org/#!/celery/django-celery-beat
Windows-CI:: https://ci.appveyor.com/project/ask/django-celery-beat
PyPI:: https://pypi.org/project/django-celery-beat/

`django-celery-results`¶

Store task results in the Django ORM, or using the Django Cache Framework.

git:: https://github.com/celery/django-celery-results
CI:: https://travis-ci.org/#!/celery/django-celery-results
Windows-CI:: https://ci.appveyor.com/project/ask/django-celery-results
PyPI:: https://pypi.org/project/django-celery-results/

`librabbitmq`¶

Very fast Python AMQP client written in C.

git:: https://github.com/celery/librabbitmq
PyPI:: https://pypi.org/project/librabbitmq/

`cell`¶

Actor library.

git:: https://github.com/celery/cell
PyPI:: https://pypi.org/project/cell/

`cyme`¶

Distributed Celery Instance manager.

git:: https://github.com/celery/cyme
PyPI:: https://pypi.org/project/cyme/
docs:: https://cyme.readthedocs.io/

Deprecated¶

django-celery

git:: https://github.com/celery/django-celery
PyPI:: https://pypi.org/project/django-celery/
docs:: https://docs.celeryq.dev/en/latest/django

Flask-Celery

git:: https://github.com/ask/Flask-Celery
PyPI:: https://pypi.org/project/Flask-Celery/

celerymon

git:: https://github.com/celery/celerymon
PyPI:: https://pypi.org/project/celerymon/

carrot

git:: https://github.com/ask/carrot
PyPI:: https://pypi.org/project/carrot/

ghettoq

git:: https://github.com/ask/ghettoq
PyPI:: https://pypi.org/project/ghettoq/

kombu-sqlalchemy

git:: https://github.com/ask/kombu-sqlalchemy
PyPI:: https://pypi.org/project/kombu-sqlalchemy/

django-kombu

git:: https://github.com/ask/django-kombu
PyPI:: https://pypi.org/project/django-kombu/

pylibrabbitmq

Old name for https://pypi.org/project/librabbitmq/.

git:: None
PyPI:: https://pypi.org/project/pylibrabbitmq/

发布流程¶

Release Procedure

更新版本号¶

Updating the version number

中文

版本号必须在三个地方进行更新：

celery/__init__.py

docs/include/introduction.txt

README.rst

对前述文件的更改可以使用 [bumpversion 命令行工具] (https://pypi.org/project/bumpversion/) 来处理。相应的配置文件位于 .bumpversion.cfg。进行必要的更改，运行：

$ bumpversion

在更改了这些文件后，您必须渲染 README 文件。这里有一个脚本可以将 sphinx 语法转换为通用的 reStructured Text 语法，make readme 目标会为您完成此操作：

$ make readme

现在提交这些更改：

$ git commit -a -m "Bumps version to X.Y.Z"

并创建一个新的版本标签：

$ git tag vX.Y.Z
$ git push --tags

英文

The version number must be updated in three places:

celery/__init__.py

docs/include/introduction.txt

README.rst

The changes to the previous files can be handled with the [bumpversion command line tool] (https://pypi.org/project/bumpversion/). The corresponding configuration lives in .bumpversion.cfg. To do the necessary changes, run:

$ bumpversion

After you have changed these files, you must render the README files. There's a script to convert sphinx syntax to generic reStructured Text syntax, and the make target readme does this for you:

$ make readme

Now commit the changes:

$ git commit -a -m "Bumps version to X.Y.Z"

and make a new version tag:

$ git tag vX.Y.Z
$ git push --tags

发布¶

Releasing

中文

发布新的公共稳定版本的命令：

$ make distcheck  # 检查 pep8、自动文档索引、运行测试等
$ make dist  # 注意：执行 git clean -xdf 并删除未在仓库中的文件。
$ python setup.py sdist upload --sign --identity='Celery Security Team'
$ python setup.py bdist_wheel upload --sign --identity='Celery Security Team'

如果这是一个新的发布系列，则还需要执行以下操作：

进入 Read The Docs 管理界面：
https://readthedocs.org/projects/celery/?fromdocs=celery
选择“编辑项目”

将默认分支更改为此系列的分支，例如，使用 2.4 分支用于 2.4 系列。
还需要在“版本”选项卡下添加前一个版本。

英文

Commands to make a new public stable release:

$ make distcheck  # checks pep8, autodoc index, runs tests and more
$ make dist  # NOTE: Runs git clean -xdf and removes files not in the repo.
$ python setup.py sdist upload --sign --identity='Celery Security Team'
$ python setup.py bdist_wheel upload --sign --identity='Celery Security Team'

If this is a new release series then you also need to do the following:

Go to the Read The Docs management interface at:
https://readthedocs.org/projects/celery/?fromdocs=celery
Enter "Edit project"

Change default branch to the branch of this series, for example, use the 2.4 branch for the 2.4 series.
Also add the previous version under the "versions" tab.

贡献¶

社区行为准则¶

体谅他人¶

尊重他人¶

合作共事¶

意见不合时，请咨询他人¶

不确定时，请寻求帮助¶

谨慎行事¶

报告错误¶

安全¶

其他错误¶

问题跟踪器¶

代码库贡献者指南¶

版本¶

分支¶

开发分支¶

维护分支¶

已归档分支¶

功能分支¶

标签¶

功能和补丁开发¶

分叉和设置代码库¶

使用 Docker 进行开发和测试¶

运行单元测试套件¶

计算测试覆盖率¶

HTML 格式的代码覆盖率¶

XML 格式的代码覆盖率（Cobertura 风格）¶

在所有支持的 Python 版本上运行测试¶

构建文档¶

使用 Docker 构建文档¶

验证您的贡献¶

pyflakes 和 PEP-8¶

API 参考¶

Isort¶

创建拉取请求¶

状态标签¶

编码风格¶

贡献需要额外库的功能¶

联系方式¶

Committers¶

Ask Solem¶

Asif Saif Uddin¶

Dmitry Malinovsky¶

Ionel Cristian Mărieș¶

Mher Movsisyan¶

Omer Katz¶

Steeve Morin¶

Josue Balandrano Coronel¶

Tomer Nosrati¶

Website¶

Mauro Rocco¶

Jan Henrik Helmers¶

Packages¶

celery¶

kombu¶

amqp¶

vine¶

pytest-celery¶

billiard¶

django-celery-beat¶

django-celery-results¶

librabbitmq¶

cell¶

cyme¶