CONTRIBUTING.rst 30 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108
  1. .. _contributing:
  2. ==============
  3. Contributing
  4. ==============
  5. Welcome!
  6. This document is fairly extensive and you are not really expected
  7. to study this in detail for small contributions;
  8. The most important rule is that contributing must be easy
  9. and that the community is friendly and not nitpicking on details
  10. such as coding style.
  11. If you're reporting a bug you should read the Reporting bugs section
  12. below to ensure that your bug report contains enough information
  13. to successfully diagnose the issue, and if you're contributing code
  14. you should try to mimic the conventions you see surrounding the code
  15. you are working on, but in the end all patches will be cleaned up by
  16. the person merging the changes so don't worry too much.
  17. .. contents::
  18. :local:
  19. .. _community-code-of-conduct:
  20. Community Code of Conduct
  21. =========================
  22. The goal is to maintain a diverse community that is pleasant for everyone.
  23. That is why we would greatly appreciate it if everyone contributing to and
  24. interacting with the community also followed this Code of Conduct.
  25. The Code of Conduct covers our behavior as members of the community,
  26. in any forum, mailing list, wiki, website, Internet relay chat (IRC), public
  27. meeting or private correspondence.
  28. The Code of Conduct is heavily based on the `Ubuntu Code of Conduct`_, and
  29. the `Pylons Code of Conduct`_.
  30. .. _`Ubuntu Code of Conduct`: http://www.ubuntu.com/community/conduct
  31. .. _`Pylons Code of Conduct`: http://docs.pylonshq.com/community/conduct.html
  32. Be considerate.
  33. ---------------
  34. Your work will be used by other people, and you in turn will depend on the
  35. work of others. Any decision you take will affect users and colleagues, and
  36. we expect you to take those consequences into account when making decisions.
  37. Even if it's not obvious at the time, our contributions to Celery will impact
  38. the work of others. For example, changes to code, infrastructure, policy,
  39. documentation and translations during a release may negatively impact
  40. others work.
  41. Be respectful.
  42. --------------
  43. The Celery community and its members treat one another with respect. Everyone
  44. can make a valuable contribution to Celery. We may not always agree, but
  45. disagreement is no excuse for poor behavior and poor manners. We might all
  46. experience some frustration now and then, but we cannot allow that frustration
  47. to turn into a personal attack. It's important to remember that a community
  48. where people feel uncomfortable or threatened is not a productive one. We
  49. expect members of the Celery community to be respectful when dealing with
  50. other contributors as well as with people outside the Celery project and with
  51. users of Celery.
  52. Be collaborative.
  53. -----------------
  54. Collaboration is central to Celery and to the larger free software community.
  55. We should always be open to collaboration. Your work should be done
  56. transparently and patches from Celery should be given back to the community
  57. when they are made, not just when the distribution releases. If you wish
  58. to work on new code for existing upstream projects, at least keep those
  59. projects informed of your ideas and progress. It many not be possible to
  60. get consensus from upstream, or even from your colleagues about the correct
  61. implementation for an idea, so don't feel obliged to have that agreement
  62. before you begin, but at least keep the outside world informed of your work,
  63. and publish your work in a way that allows outsiders to test, discuss and
  64. contribute to your efforts.
  65. When you disagree, consult others.
  66. ----------------------------------
  67. Disagreements, both political and technical, happen all the time and
  68. the Celery community is no exception. It is important that we resolve
  69. disagreements and differing views constructively and with the help of the
  70. community and community process. If you really want to go a different
  71. way, then we encourage you to make a derivative distribution or alternate
  72. set of packages that still build on the work we've done to utilize as common
  73. of a core as possible.
  74. When you are unsure, ask for help.
  75. ----------------------------------
  76. Nobody knows everything, and nobody is expected to be perfect. Asking
  77. questions avoids many problems down the road, and so questions are
  78. encouraged. Those who are asked questions should be responsive and helpful.
  79. However, when asking a question, care must be taken to do so in an appropriate
  80. forum.
  81. Step down considerately.
  82. ------------------------
  83. Developers on every project come and go and Celery is no different. When you
  84. leave or disengage from the project, in whole or in part, we ask that you do
  85. so in a way that minimizes disruption to the project. This means you should
  86. tell people you are leaving and take the proper steps to ensure that others
  87. can pick up where you leave off.
  88. .. _reporting-bugs:
  89. Reporting Bugs
  90. ==============
  91. .. _vulnsec:
  92. Security
  93. --------
  94. You must never report security related issues, vulnerabilities or bugs
  95. including sensitive information to the bug tracker, or elsewhere in public.
  96. Instead sensitive bugs must be sent by email to ``security@celeryproject.org``.
  97. If you'd like to submit the information encrypted our PGP key is::
  98. -----BEGIN PGP PUBLIC KEY BLOCK-----
  99. Version: GnuPG v1.4.15 (Darwin)
  100. mQENBFJpWDkBCADFIc9/Fpgse4owLNvsTC7GYfnJL19XO0hnL99sPx+DPbfr+cSE
  101. 9wiU+Wp2TfUX7pCLEGrODiEP6ZCZbgtiPgId+JYvMxpP6GXbjiIlHRw1EQNH8RlX
  102. cVxy3rQfVv8PGGiJuyBBjxzvETHW25htVAZ5TI1+CkxmuyyEYqgZN2fNd0wEU19D
  103. +c10G1gSECbCQTCbacLSzdpngAt1Gkrc96r7wGHBBSvDaGDD2pFSkVuTLMbIRrVp
  104. lnKOPMsUijiip2EMr2DvfuXiUIUvaqInTPNWkDynLoh69ib5xC19CSVLONjkKBsr
  105. Pe+qAY29liBatatpXsydY7GIUzyBT3MzgMJlABEBAAG0MUNlbGVyeSBTZWN1cml0
  106. eSBUZWFtIDxzZWN1cml0eUBjZWxlcnlwcm9qZWN0Lm9yZz6JATgEEwECACIFAlJp
  107. WDkCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOArFOUDCicIw1IH/26f
  108. CViDC7/P13jr+srRdjAsWvQztia9HmTlY8cUnbmkR9w6b6j3F2ayw8VhkyFWgYEJ
  109. wtPBv8mHKADiVSFARS+0yGsfCkia5wDSQuIv6XqRlIrXUyqJbmF4NUFTyCZYoh+C
  110. ZiQpN9xGhFPr5QDlMx2izWg1rvWlG1jY2Es1v/xED3AeCOB1eUGvRe/uJHKjGv7J
  111. rj0pFcptZX+WDF22AN235WYwgJM6TrNfSu8sv8vNAQOVnsKcgsqhuwomSGsOfMQj
  112. LFzIn95MKBBU1G5wOs7JtwiV9jefGqJGBO2FAvOVbvPdK/saSnB+7K36dQcIHqms
  113. 5hU4Xj0RIJiod5idlRC5AQ0EUmlYOQEIAJs8OwHMkrdcvy9kk2HBVbdqhgAREMKy
  114. gmphDp7prRL9FqSY/dKpCbG0u82zyJypdb7QiaQ5pfPzPpQcd2dIcohkkh7G3E+e
  115. hS2L9AXHpwR26/PzMBXyr2iNnNc4vTksHvGVDxzFnRpka6vbI/hrrZmYNYh9EAiv
  116. uhE54b3/XhXwFgHjZXb9i8hgJ3nsO0pRwvUAM1bRGMbvf8e9F+kqgV0yWYNnh6QL
  117. 4Vpl1+epqp2RKPHyNQftbQyrAHXT9kQF9pPlx013MKYaFTADscuAp4T3dy7xmiwS
  118. crqMbZLzfrxfFOsNxTUGE5vmJCcm+mybAtRo4aV6ACohAO9NevMx8pUAEQEAAYkB
  119. HwQYAQIACQUCUmlYOQIbDAAKCRDgKxTlAwonCNFbB/9esir/f7TufE+isNqErzR/
  120. aZKZo2WzZR9c75kbqo6J6DYuUHe6xI0OZ2qZ60iABDEZAiNXGulysFLCiPdatQ8x
  121. 8zt3DF9BMkEck54ZvAjpNSern6zfZb1jPYWZq3TKxlTs/GuCgBAuV4i5vDTZ7xK/
  122. aF+OFY5zN7ciZHkqLgMiTZ+RhqRcK6FhVBP/Y7d9NlBOcDBTxxE1ZO1ute6n7guJ
  123. ciw4hfoRk8qNN19szZuq3UU64zpkM2sBsIFM9tGF2FADRxiOaOWZHmIyVZriPFqW
  124. RUwjSjs7jBVNq0Vy4fCu/5+e+XLOUBOoqtM5W7ELt0t1w9tXebtPEetV86in8fU2
  125. =0chn
  126. -----END PGP PUBLIC KEY BLOCK-----
  127. Other bugs
  128. ----------
  129. Bugs can always be described to the `mailing-list`_, but the best
  130. way to report an issue and to ensure a timely response is to use the
  131. issue tracker.
  132. 1) **Create a GitHub account.**
  133. You need to `create a GitHub account`_ to be able to create new issues
  134. and participate in the discussion.
  135. .. _`create a GitHub account`: https://github.com/signup/free
  136. 2) **Determine if your bug is really a bug.**
  137. You should not file a bug if you are requesting support. For that you can use
  138. the `mailing-list`_, or `irc-channel`_.
  139. 3) **Make sure your bug hasn't already been reported.**
  140. Search through the appropriate Issue tracker. If a bug like yours was found,
  141. check if you have new information that could be reported to help
  142. the developers fix the bug.
  143. 4) **Check if you're using the latest version.**
  144. A bug could be fixed by some other improvements and fixes - it might not have an
  145. existing report in the bug tracker. Make sure you're using the latest releases of
  146. celery, billiard, kombu, amqp and vine.
  147. 5) **Collect information about the bug.**
  148. To have the best chance of having a bug fixed, we need to be able to easily
  149. reproduce the conditions that caused it. Most of the time this information
  150. will be from a Python traceback message, though some bugs might be in design,
  151. spelling or other errors on the website/docs/code.
  152. A) If the error is from a Python traceback, include it in the bug report.
  153. B) We also need to know what platform you're running (Windows, macOS, Linux,
  154. etc.), the version of your Python interpreter, and the version of Celery,
  155. and related packages that you were running when the bug occurred.
  156. C) If you are reporting a race condition or a deadlock, tracebacks can be
  157. hard to get or might not be that useful. Try to inspect the process to
  158. get more diagnostic data. Some ideas:
  159. * Enable celery's ``breakpoint_signal`` and use it
  160. to inspect the process's state. This will allow you to open a
  161. ``pdb`` session.
  162. * Collect tracing data using `strace`_(Linux),
  163. ``dtruss`` (macOS), and ``ktrace`` (BSD),
  164. `ltrace`_ and `lsof`_.
  165. D) Include the output from the ``celery report`` command:
  166. ::
  167. $ celery -A proj report
  168. This will also include your configuration settings and it try to
  169. remove values for keys known to be sensitive, but make sure you also
  170. verify the information before submitting so that it doesn't contain
  171. confidential information like API tokens and authentication
  172. credentials.
  173. 6) **Submit the bug.**
  174. By default `GitHub`_ will email you to let you know when new comments have
  175. been made on your bug. In the event you've turned this feature off, you
  176. should check back on occasion to ensure you don't miss any questions a
  177. developer trying to fix the bug might ask.
  178. .. _`GitHub`: https://github.com
  179. .. _`strace`: https://en.wikipedia.org/wiki/Strace
  180. .. _`ltrace`: https://en.wikipedia.org/wiki/Ltrace
  181. .. _`lsof`: https://en.wikipedia.org/wiki/Lsof
  182. .. _issue-trackers:
  183. Issue Trackers
  184. --------------
  185. Bugs for a package in the Celery ecosystem should be reported to the relevant
  186. issue tracker.
  187. * ``celery``: https://github.com/celery/celery/issues/
  188. * ``kombu``: https://github.com/celery/kombu/issues
  189. * ``amqp``: https://github.com/celery/py-amqp/issues
  190. * ``vine``: https://github.com/celery/vine/issues
  191. * ``librabbitmq``: https://github.com/celery/librabbitmq/issues
  192. * ``django-celery``: https://github.com/celery/django-celery/issues
  193. If you are unsure of the origin of the bug you can ask the
  194. `mailing-list`_, or just use the Celery issue tracker.
  195. Contributors guide to the code base
  196. ===================================
  197. There's a separate section for internal details,
  198. including details about the code base and a style guide.
  199. Read `internals-guide`_ for more!
  200. .. _versions:
  201. Versions
  202. ========
  203. Version numbers consists of a major version, minor version and a release number.
  204. Since version 2.1.0 we use the versioning semantics described by
  205. SemVer: http://semver.org.
  206. Stable releases are published at PyPI
  207. while development releases are only available in the GitHub git repository as tags.
  208. All version tags starts with “v”, so version 0.8.0 is the tag v0.8.0.
  209. .. _git-branches:
  210. Branches
  211. ========
  212. Current active version branches:
  213. * master (https://github.com/celery/celery/tree/master)
  214. * 3.1 (https://github.com/celery/celery/tree/3.1)
  215. * 3.0 (https://github.com/celery/celery/tree/3.0)
  216. You can see the state of any branch by looking at the Changelog:
  217. https://github.com/celery/celery/blob/master/Changelog
  218. If the branch is in active development the topmost version info should
  219. contain meta-data like:
  220. ::
  221. 2.4.0
  222. ======
  223. :release-date: TBA
  224. :status: DEVELOPMENT
  225. :branch: master
  226. The ``status`` field can be one of:
  227. * ``PLANNING``
  228. The branch is currently experimental and in the planning stage.
  229. * ``DEVELOPMENT``
  230. The branch is in active development, but the test suite should
  231. be passing and the product should be working and possible for users to test.
  232. * ``FROZEN``
  233. The branch is frozen, and no more features will be accepted.
  234. When a branch is frozen the focus is on testing the version as much
  235. as possible before it is released.
  236. ``master`` branch
  237. -----------------
  238. The master branch is where development of the next version happens.
  239. Maintenance branches
  240. --------------------
  241. Maintenance branches are named after the version, e.g. the maintenance branch
  242. for the 2.2.x series is named ``2.2``. Previously these were named
  243. ``releaseXX-maint``.
  244. The versions we currently maintain is:
  245. * 3.1
  246. This is the current series.
  247. * 3.0
  248. This is the previous series, and the last version to support Python 2.5.
  249. Archived branches
  250. -----------------
  251. Archived branches are kept for preserving history only,
  252. and theoretically someone could provide patches for these if they depend
  253. on a series that is no longer officially supported.
  254. An archived version is named ``X.Y-archived``.
  255. Our currently archived branches are:
  256. * ``2.5-archived``
  257. * ``2.4-archived``
  258. * ``2.3-archived``
  259. * ``2.1-archived``
  260. * ``2.0-archived``
  261. * ``1.0-archived``
  262. Feature branches
  263. ----------------
  264. Major new features are worked on in dedicated branches.
  265. There is no strict naming requirement for these branches.
  266. Feature branches are removed once they have been merged into a release branch.
  267. Tags
  268. ====
  269. Tags are used exclusively for tagging releases. A release tag is
  270. named with the format ``vX.Y.Z``, e.g. ``v2.3.1``.
  271. Experimental releases contain an additional identifier ``vX.Y.Z-id``, e.g.
  272. ``v3.0.0-rc1``. Experimental tags may be removed after the official release.
  273. .. _contributing-changes:
  274. Working on Features & Patches
  275. =============================
  276. .. note::
  277. Contributing to Celery should be as simple as possible,
  278. so none of these steps should be considered mandatory.
  279. You can even send in patches by email if that is your preferred
  280. work method. We won't like you any less, any contribution you make
  281. is always appreciated!
  282. However following these steps may make maintainers life easier,
  283. and may mean that your changes will be accepted sooner.
  284. Forking and setting up the repository
  285. -------------------------------------
  286. First you need to fork the Celery repository, a good introduction to this
  287. is in the GitHub Guide: `Fork a Repo`_.
  288. After you have cloned the repository you should checkout your copy
  289. to a directory on your machine:
  290. ::
  291. $ git clone git@github.com:username/celery.git
  292. When the repository is cloned enter the directory to set up easy access
  293. to upstream changes:
  294. ::
  295. $ cd celery
  296. $ git remote add upstream git://github.com/celery/celery.git
  297. $ git fetch upstream
  298. If you need to pull in new changes from upstream you should
  299. always use the ``--rebase`` option to ``git pull``:
  300. ::
  301. git pull --rebase upstream master
  302. With this option you don't clutter the history with merging
  303. commit notes. See `Rebasing merge commits in git`_.
  304. If you want to learn more about rebasing see the `Rebase`_
  305. section in the GitHub guides.
  306. If you need to work on a different branch than ``master`` you can
  307. fetch and checkout a remote branch like this::
  308. git checkout --track -b 3.0-devel origin/3.0-devel
  309. .. _`Fork a Repo`: http://help.github.com/fork-a-repo/
  310. .. _`Rebasing merge commits in git`:
  311. http://notes.envato.com/developers/rebasing-merge-commits-in-git/
  312. .. _`Rebase`: http://help.github.com/rebase/
  313. .. _contributing-testing:
  314. Running the unit test suite
  315. ---------------------------
  316. To run the Celery test suite you need to install a few dependencies.
  317. A complete list of the dependencies needed are located in
  318. ``requirements/test.txt``.
  319. If you're working on the development version, then you need to
  320. install the development requirements first:
  321. ::
  322. $ pip install -U -r requirements/dev.txt
  323. Both the stable and the development version have testing related
  324. dependencies, so install these next:
  325. ::
  326. $ pip install -U -r requirements/test.txt
  327. $ pip install -U -r requirements/default.txt
  328. After installing the dependencies required, you can now execute
  329. the test suite by calling ``nosetests <nose>``:
  330. ::
  331. $ nosetests
  332. Some useful options to ``nosetests`` are:
  333. * ``-x``
  334. Stop running the tests at the first test that fails.
  335. * ``-s``
  336. Don't capture output
  337. * ``-nologcapture``
  338. Don't capture log output.
  339. * ``-v``
  340. Run with verbose output.
  341. If you want to run the tests for a single test file only
  342. you can do so like this:
  343. ::
  344. $ nosetests celery.tests.test_worker.test_worker_job
  345. .. _contributing-pull-requests:
  346. Creating pull requests
  347. ----------------------
  348. When your feature/bugfix is complete you may want to submit
  349. a pull requests so that it can be reviewed by the maintainers.
  350. Creating pull requests is easy, and also let you track the progress
  351. of your contribution. Read the `Pull Requests`_ section in the GitHub
  352. Guide to learn how this is done.
  353. You can also attach pull requests to existing issues by following
  354. the steps outlined here: http://bit.ly/koJoso
  355. .. _`Pull Requests`: http://help.github.com/send-pull-requests/
  356. .. _contributing-coverage:
  357. Calculating test coverage
  358. ~~~~~~~~~~~~~~~~~~~~~~~~~
  359. To calculate test coverage you must first install the ``coverage`` module.
  360. Installing the ``coverage`` module:
  361. ::
  362. $ pip install -U coverage
  363. Code coverage in HTML:
  364. ::
  365. $ nosetests --with-coverage --cover-html
  366. The coverage output will then be located at
  367. ``celery/tests/cover/index.html``.
  368. Code coverage in XML (Cobertura-style):
  369. ::
  370. $ nosetests --with-coverage --cover-xml --cover-xml-file=coverage.xml
  371. The coverage XML output will then be located at ``coverage.xml``
  372. .. _contributing-tox:
  373. Running the tests on all supported Python versions
  374. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  375. There is a ``tox`` configuration file in the top directory of the
  376. distribution.
  377. To run the tests for all supported Python versions simply execute:
  378. ::
  379. $ tox
  380. Use the ``tox -e`` option if you only want to test specific Python versions:
  381. ::
  382. $ tox -e 2.7
  383. Building the documentation
  384. --------------------------
  385. To build the documentation you need to install the dependencies
  386. listed in ``requirements/docs.txt``:
  387. ::
  388. $ pip install -U -r requirements/docs.txt
  389. After these dependencies are installed you should be able to
  390. build the docs by running:
  391. ::
  392. $ cd docs
  393. $ rm -rf _build
  394. $ make html
  395. Make sure there are no errors or warnings in the build output.
  396. After building succeeds the documentation is available at ``_build/html``.
  397. .. _contributing-verify:
  398. Verifying your contribution
  399. ---------------------------
  400. To use these tools you need to install a few dependencies. These dependencies
  401. can be found in ``requirements/pkgutils.txt``.
  402. Installing the dependencies:
  403. ::
  404. $ pip install -U -r requirements/pkgutils.txt
  405. pyflakes & PEP8
  406. ~~~~~~~~~~~~~~~
  407. To ensure that your changes conform to PEP8 and to run pyflakes
  408. execute:
  409. ::
  410. $ make flakecheck
  411. To not return a negative exit code when this command fails use
  412. the ``flakes`` target instead:
  413. ::
  414. $ make flakes§
  415. API reference
  416. ~~~~~~~~~~~~~
  417. To make sure that all modules have a corresponding section in the API
  418. reference please execute:
  419. ::
  420. $ make apicheck
  421. $ make indexcheck
  422. If files are missing you can add them by copying an existing reference file.
  423. If the module is internal it should be part of the internal reference
  424. located in ``docs/internals/reference/``. If the module is public
  425. it should be located in ``docs/reference/``.
  426. For example if reference is missing for the module ``celery.worker.awesome``
  427. and this module is considered part of the public API, use the following steps:
  428. Use an existing file as a template:
  429. ::
  430. $ cd docs/reference/
  431. $ cp celery.schedules.rst celery.worker.awesome.rst
  432. Edit the file using your favorite editor:
  433. ::
  434. $ vim celery.worker.awesome.rst
  435. # change every occurrence of ``celery.schedules`` to
  436. # ``celery.worker.awesome``
  437. Edit the index using your favorite editor:
  438. ::
  439. $ vim index.rst
  440. # Add ``celery.worker.awesome`` to the index.
  441. Commit your changes:
  442. ::
  443. # Add the file to git
  444. $ git add celery.worker.awesome.rst
  445. $ git add index.rst
  446. $ git commit celery.worker.awesome.rst index.rst \
  447. -m "Adds reference for celery.worker.awesome"
  448. .. _coding-style:
  449. Coding Style
  450. ============
  451. You should probably be able to pick up the coding style
  452. from surrounding code, but it is a good idea to be aware of the
  453. following conventions.
  454. * All Python code must follow the `PEP-8`_ guidelines.
  455. `pep8.py`_ is an utility you can use to verify that your code
  456. is following the conventions.
  457. .. _`PEP-8`: http://www.python.org/dev/peps/pep-0008/
  458. .. _`pep8.py`: http://pypi.python.org/pypi/pep8
  459. * Docstrings must follow the `PEP-257`_ conventions, and use the following
  460. style.
  461. Do this:
  462. ::
  463. def method(self, arg):
  464. """Short description.
  465. More details.
  466. """
  467. or:
  468. ::
  469. def method(self, arg):
  470. """Short description."""
  471. but not this:
  472. ::
  473. def method(self, arg):
  474. """
  475. Short description.
  476. """
  477. .. _`PEP-257`: http://www.python.org/dev/peps/pep-0257/
  478. * Lines should not exceed 78 columns.
  479. You can enforce this in ``vim`` by setting the ``textwidth`` option:
  480. ::
  481. set textwidth=78
  482. If adhering to this limit makes the code less readable, you have one more
  483. character to go on, which means 78 is a soft limit, and 79 is the hard
  484. limit :)
  485. * Import order
  486. * Python standard library (`import xxx`)
  487. * Python standard library ('from xxx import`)
  488. * Third-party packages.
  489. * Other modules from the current package.
  490. or in case of code using Django:
  491. * Python standard library (`import xxx`)
  492. * Python standard library ('from xxx import`)
  493. * Third-party packages.
  494. * Django packages.
  495. * Other modules from the current package.
  496. Within these sections the imports should be sorted by module name.
  497. Example:
  498. ::
  499. import threading
  500. import time
  501. from collections import deque
  502. from Queue import Queue, Empty
  503. from .platforms import Pidfile
  504. from .five import zip_longest, items, range
  505. from .utils import timeutils
  506. * Wild-card imports must not be used (`from xxx import *`).
  507. * For distributions where Python 2.5 is the oldest support version
  508. additional rules apply:
  509. * Absolute imports must be enabled at the top of every module::
  510. from __future__ import absolute_import
  511. * If the module uses the ``with`` statement and must be compatible
  512. with Python 2.5 (celery is not) then it must also enable that::
  513. from __future__ import with_statement
  514. * Every future import must be on its own line, as older Python 2.5
  515. releases did not support importing multiple features on the
  516. same future import line::
  517. # Good
  518. from __future__ import absolute_import
  519. from __future__ import with_statement
  520. # Bad
  521. from __future__ import absolute_import, with_statement
  522. (Note that this rule does not apply if the package does not include
  523. support for Python 2.5)
  524. * Note that we use "new-style` relative imports when the distribution
  525. does not support Python versions below 2.5
  526. This requires Python 2.5 or later:
  527. ::
  528. from . import submodule
  529. .. _feature-with-extras:
  530. Contributing features requiring additional libraries
  531. ====================================================
  532. Some features like a new result backend may require additional libraries
  533. that the user must install.
  534. We use setuptools `extra_requires` for this, and all new optional features
  535. that require third-party libraries must be added.
  536. 1) Add a new requirements file in `requirements/extras`
  537. E.g. for the Cassandra backend this is
  538. ``requirements/extras/cassandra.txt``, and the file looks like this:
  539. ::
  540. pycassa
  541. These are pip requirement files so you can have version specifiers and
  542. multiple packages are separated by newline. A more complex example could
  543. be:
  544. ::
  545. # pycassa 2.0 breaks Foo
  546. pycassa>=1.0,<2.0
  547. thrift
  548. 2) Modify ``setup.py``
  549. After the requirements file is added you need to add it as an option
  550. to ``setup.py`` in the ``extras_require`` section::
  551. extra['extras_require'] = {
  552. # ...
  553. 'cassandra': extras('cassandra.txt'),
  554. }
  555. 3) Document the new feature in ``docs/includes/installation.txt``
  556. You must add your feature to the list in the `bundles`_ section
  557. of ``docs/includes/installation.txt``.
  558. After you've made changes to this file you need to render
  559. the distro ``README`` file:
  560. ::
  561. $ pip install -U requirements/pkgutils.txt
  562. $ make readme
  563. That's all that needs to be done, but remember that if your feature
  564. adds additional configuration options then these needs to be documented
  565. in ``docs/configuration.rst``. Also all settings need to be added to the
  566. ``celery/app/defaults.py`` module.
  567. Result backends require a separate section in the ``docs/configuration.rst``
  568. file.
  569. .. _contact_information:
  570. Contacts
  571. ========
  572. This is a list of people that can be contacted for questions
  573. regarding the official git repositories, PyPI packages
  574. Read the Docs pages.
  575. If the issue is not an emergency then it is better
  576. to `report an issue`_.
  577. Committers
  578. ----------
  579. Ask Solem
  580. ~~~~~~~~~
  581. :github: https://github.com/ask
  582. :twitter: http://twitter.com/#!/asksol
  583. Dmitry Malinovsky
  584. ~~~~~~~~~~~~~~~~~
  585. :github: https://github.com/malinoff
  586. :twitter: https://twitter.com/__malinoff__
  587. Ionel Cristian Mărieș
  588. ~~~~~~~~~~~~~~~~~~~~~
  589. :github: https://github.com/ionelmc
  590. :twitter: https://twitter.com/ionelmc
  591. Mher Movsisyan
  592. ~~~~~~~~~~~~~~
  593. :github: https://github.com/mher
  594. :twitter: http://twitter.com/#!/movsm
  595. Omer Katz
  596. ~~~~~~~~~
  597. :github: https://github.com/thedrow
  598. :twitter: https://twitter.com/the_drow
  599. Steeve Morin
  600. ~~~~~~~~~~~~
  601. :github: https://github.com/steeve
  602. :twitter: http://twitter.com/#!/steeve
  603. Website
  604. -------
  605. The Celery Project website is run and maintained by
  606. Mauro Rocco
  607. ~~~~~~~~~~~
  608. :github: https://github.com/fireantology
  609. :twitter: https://twitter.com/#!/fireantology
  610. with design by:
  611. Jan Henrik Helmers
  612. ~~~~~~~~~~~~~~~~~~
  613. :web: http://www.helmersworks.com
  614. :twitter: http://twitter.com/#!/helmers
  615. .. _packages:
  616. Packages
  617. ========
  618. ``celery``
  619. ----------
  620. :git: https://github.com/celery/celery
  621. :CI: http://travis-ci.org/#!/celery/celery
  622. :Windows-CI: https://ci.appveyor.com/project/ask/celery
  623. :PyPI: http://pypi.python.org/pypi/celery
  624. :docs: http://docs.celeryproject.org
  625. ``kombu``
  626. ---------
  627. Messaging library.
  628. :git: https://github.com/celery/kombu
  629. :CI: http://travis-ci.org/#!/celery/kombu
  630. :Windows-CI: https://ci.appveyor.com/project/ask/kombu
  631. :PyPI: http://pypi.python.org/pypi/kombu
  632. :docs: https://kombu.readthedocs.io
  633. ``amqp``
  634. --------
  635. Python AMQP 0.9.1 client.
  636. :git: https://github.com/celery/py-amqp
  637. :CI: http://travis-ci.org/#!/celery/py-amqp
  638. :Windows-CI: https://ci.appveyor.com/project/ask/py-amqp
  639. :PyPI: http://pypi.python.org/pypi/amqp
  640. :docs: https://amqp.readthedocs.io
  641. ``vine``
  642. --------
  643. Promise/deferred implementation.
  644. :git: https://github.com/celery/vine/
  645. :CI: http://travis-ci.org/#!/celery/vine/
  646. :Windows-CI: https://ci.appveyor.com/project/ask/vine
  647. :PyPI: http://pypi.python.org/pypi/vine
  648. :docs: https://vine.readthedocs.io
  649. ``billiard``
  650. ------------
  651. Fork of multiprocessing containing improvements
  652. that will eventually be merged into the Python stdlib.
  653. :git: https://github.com/celery/billiard
  654. :CI: http://travis-ci.org/#!/celery/billiard/
  655. :Windows-CI: https://ci.appveyor.com/project/ask/billiard
  656. :PyPI: http://pypi.python.org/pypi/billiard
  657. ``librabbitmq``
  658. ---------------
  659. Very fast Python AMQP client written in C.
  660. :git: https://github.com/celery/librabbitmq
  661. :PyPI: http://pypi.python.org/pypi/librabbitmq
  662. ``django-celery``
  663. -----------------
  664. Django <-> Celery Integration.
  665. :git: https://github.com/celery/django-celery
  666. :PyPI: http://pypi.python.org/pypi/django-celery
  667. :docs: http://docs.celeryproject.org/en/latest/django
  668. ``cell``
  669. --------
  670. Actor library.
  671. :git: https://github.com/celery/cell
  672. :PyPI: http://pypi.python.org/pypi/cell
  673. ``cyme``
  674. --------
  675. Distributed Celery Instance manager.
  676. :git: https://github.com/celery/cyme
  677. :PyPI: http://pypi.python.org/pypi/cyme
  678. :docs: https://cyme.readthedocs.io/
  679. Deprecated
  680. ----------
  681. - ``Flask-Celery``
  682. :git: https://github.com/ask/Flask-Celery
  683. :PyPI: http://pypi.python.org/pypi/Flask-Celery
  684. - ``celerymon``
  685. :git: https://github.com/celery/celerymon
  686. :PyPI: http://pypi.python.org/pypi/celerymon
  687. - ``carrot``
  688. :git: https://github.com/ask/carrot
  689. :PyPI: http://pypi.python.org/pypi/carrot
  690. - ``ghettoq``
  691. :git: https://github.com/ask/ghettoq
  692. :PyPI: http://pypi.python.org/pypi/ghettoq
  693. - ``kombu-sqlalchemy``
  694. :git: https://github.com/ask/kombu-sqlalchemy
  695. :PyPI: http://pypi.python.org/pypi/kombu-sqlalchemy
  696. - ``django-kombu``
  697. :git: https://github.com/ask/django-kombu
  698. :PyPI: http://pypi.python.org/pypi/django-kombu
  699. - ``pylibrabbitmq``
  700. Old name for ``librabbitmq``.
  701. :git: ``None``
  702. :PyPI: http://pypi.python.org/pypi/pylibrabbitmq
  703. .. _release-procedure:
  704. Release Procedure
  705. =================
  706. Updating the version number
  707. ---------------------------
  708. The version number must be updated two places:
  709. * ``celery/__init__.py``
  710. * ``docs/include/introduction.txt``
  711. After you have changed these files you must render
  712. the ``README`` files. There is a script to convert sphinx syntax
  713. to generic reStructured Text syntax, and the make target `readme`
  714. does this for you:
  715. ::
  716. $ make readme
  717. Now commit the changes:
  718. ::
  719. $ git commit -a -m "Bumps version to X.Y.Z"
  720. and make a new version tag:
  721. ::
  722. $ git tag vX.Y.Z
  723. $ git push --tags
  724. Releasing
  725. ---------
  726. Commands to make a new public stable release:
  727. ::
  728. $ make distcheck # checks pep8, autodoc index, runs tests and more
  729. $ make dist # NOTE: Runs git clean -xdf and removes files not in the repo.
  730. $ python setup.py sdist upload --sign --identity='Celery Security Team'
  731. $ python setup.py bdist_wheel upload --sign --identity='Celery Security Team'
  732. If this is a new release series then you also need to do the
  733. following:
  734. * Go to the Read The Docs management interface at:
  735. http://readthedocs.org/projects/celery/?fromdocs=celery
  736. * Enter "Edit project"
  737. Change default branch to the branch of this series, e.g. ``2.4``
  738. for series 2.4.
  739. * Also add the previous version under the "versions" tab.
  740. .. _`mailing-list`: http://groups.google.com/group/celery-users
  741. .. _`irc-channel`: http://docs.celeryproject.org/en/latest/getting-started/resources.html#irc
  742. .. _`internals-guide`: http://docs.celeryproject.org/en/latest/internals/guide.html
  743. .. _`bundles`: http://docs.celeryproject.org/en/latest/getting-started/introduction.html#bundles
  744. .. _`report an issue`: http://docs.celeryproject.org/en/latest/contributing.html#reporting-bugs