CONTRIBUTING.rst 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065
  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 and kombu.
  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, OS X, 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), dtruss (OSX) and ktrace(BSD),
  163. ltrace_ and lsof_.
  164. D) Include the output from the `celery report` command:
  165. ::
  166. $ celery -A proj report
  167. This will also include your configuration settings and it try to
  168. remove values for keys known to be sensitive, but make sure you also
  169. verify the information before submitting so that it doesn't contain
  170. confidential information like API tokens and authentication
  171. credentials.
  172. 6) **Submit the bug.**
  173. By default `GitHub`_ will email you to let you know when new comments have
  174. been made on your bug. In the event you've turned this feature off, you
  175. should check back on occasion to ensure you don't miss any questions a
  176. developer trying to fix the bug might ask.
  177. .. _`GitHub`: http://github.com
  178. .. _`strace`: http://en.wikipedia.org/wiki/Strace
  179. .. _`ltrace`: http://en.wikipedia.org/wiki/Ltrace
  180. .. _`lsof`: http://en.wikipedia.org/wiki/Lsof
  181. .. _issue-trackers:
  182. Issue Trackers
  183. --------------
  184. Bugs for a package in the Celery ecosystem should be reported to the relevant
  185. issue tracker.
  186. * Celery: http://github.com/celery/celery/issues/
  187. * Kombu: http://github.com/celery/kombu/issues
  188. * pyamqp: http://github.com/celery/pyamqp/issues
  189. * librabbitmq: http://github.com/celery/librabbitmq/issues
  190. * Django-Celery: http://github.com/celery/django-celery/issues
  191. If you are unsure of the origin of the bug you can ask the
  192. `mailing-list`_, or just use the Celery issue tracker.
  193. Contributors guide to the codebase
  194. ==================================
  195. There's a separate section for internal details,
  196. including details about the codebase and a style guide.
  197. Read `internals-guide`_ for more!
  198. .. _versions:
  199. Versions
  200. ========
  201. Version numbers consists of a major version, minor version and a release number.
  202. Since version 2.1.0 we use the versioning semantics described by
  203. semver: http://semver.org.
  204. Stable releases are published at PyPI
  205. while development releases are only available in the GitHub git repository as tags.
  206. All version tags starts with "v", so version 0.8.0 is the tag v0.8.0.
  207. .. _git-branches:
  208. Branches
  209. ========
  210. Current active version branches:
  211. * master (http://github.com/celery/celery/tree/master)
  212. * 3.1 (http://github.com/celery/celery/tree/3.1)
  213. * 3.0 (http://github.com/celery/celery/tree/3.0)
  214. You can see the state of any branch by looking at the Changelog:
  215. https://github.com/celery/celery/blob/master/Changelog
  216. If the branch is in active development the topmost version info should
  217. contain metadata like::
  218. 2.4.0
  219. ======
  220. :release-date: TBA
  221. :status: DEVELOPMENT
  222. :branch: master
  223. The ``status`` field can be one of:
  224. * ``PLANNING``
  225. The branch is currently experimental and in the planning stage.
  226. * ``DEVELOPMENT``
  227. The branch is in active development, but the test suite should
  228. be passing and the product should be working and possible for users to test.
  229. * ``FROZEN``
  230. The branch is frozen, and no more features will be accepted.
  231. When a branch is frozen the focus is on testing the version as much
  232. as possible before it is released.
  233. ``master`` branch
  234. -----------------
  235. The master branch is where development of the next version happens.
  236. Maintenance branches
  237. --------------------
  238. Maintenance branches are named after the version, e.g. the maintenance branch
  239. for the 2.2.x series is named ``2.2``. Previously these were named
  240. ``releaseXX-maint``.
  241. The versions we currently maintain is:
  242. * 3.1
  243. This is the current series.
  244. * 3.0
  245. This is the previous series, and the last version to support Python 2.5.
  246. Archived branches
  247. -----------------
  248. Archived branches are kept for preserving history only,
  249. and theoretically someone could provide patches for these if they depend
  250. on a series that is no longer officially supported.
  251. An archived version is named ``X.Y-archived``.
  252. Our currently archived branches are:
  253. * 2.5-archived
  254. * 2.4-archived
  255. * 2.3-archived
  256. * 2.1-archived
  257. * 2.0-archived
  258. * 1.0-archived
  259. Feature branches
  260. ----------------
  261. Major new features are worked on in dedicated branches.
  262. There is no strict naming requirement for these branches.
  263. Feature branches are removed once they have been merged into a release branch.
  264. Tags
  265. ====
  266. Tags are used exclusively for tagging releases. A release tag is
  267. named with the format ``vX.Y.Z``, e.g. ``v2.3.1``.
  268. Experimental releases contain an additional identifier ``vX.Y.Z-id``, e.g.
  269. ``v3.0.0-rc1``. Experimental tags may be removed after the official release.
  270. .. _contributing-changes:
  271. Working on Features & Patches
  272. =============================
  273. .. note::
  274. Contributing to Celery should be as simple as possible,
  275. so none of these steps should be considered mandatory.
  276. You can even send in patches by email if that is your preferred
  277. work method. We won't like you any less, any contribution you make
  278. is always appreciated!
  279. However following these steps may make maintainers life easier,
  280. and may mean that your changes will be accepted sooner.
  281. Forking and setting up the repository
  282. -------------------------------------
  283. First you need to fork the Celery repository, a good introduction to this
  284. is in the Github Guide: `Fork a Repo`_.
  285. After you have cloned the repository you should checkout your copy
  286. to a directory on your machine:
  287. ::
  288. $ git clone git@github.com:username/celery.git
  289. When the repository is cloned enter the directory to set up easy access
  290. to upstream changes:
  291. ::
  292. $ cd celery
  293. $ git remote add upstream git://github.com/celery/celery.git
  294. $ git fetch upstream
  295. If you need to pull in new changes from upstream you should
  296. always use the ``--rebase`` option to ``git pull``:
  297. ::
  298. git pull --rebase upstream master
  299. With this option you don't clutter the history with merging
  300. commit notes. See `Rebasing merge commits in git`_.
  301. If you want to learn more about rebasing see the `Rebase`_
  302. section in the Github guides.
  303. If you need to work on a different branch than ``master`` you can
  304. fetch and checkout a remote branch like this::
  305. git checkout --track -b 3.0-devel origin/3.0-devel
  306. .. _`Fork a Repo`: http://help.github.com/fork-a-repo/
  307. .. _`Rebasing merge commits in git`:
  308. http://notes.envato.com/developers/rebasing-merge-commits-in-git/
  309. .. _`Rebase`: http://help.github.com/rebase/
  310. .. _contributing-testing:
  311. Running the unit test suite
  312. ---------------------------
  313. To run the Celery test suite you need to install a few dependencies.
  314. A complete list of the dependencies needed are located in
  315. ``requirements/test.txt``.
  316. Installing the test requirements:
  317. ::
  318. $ pip install -U -r requirements/test.txt
  319. When installation of dependencies is complete you can execute
  320. the test suite by calling ``nosetests``:
  321. ::
  322. $ nosetests
  323. Some useful options to ``nosetests`` are:
  324. * ``-x``
  325. Stop running the tests at the first test that fails.
  326. * ``-s``
  327. Don't capture output
  328. * ``--nologcapture``
  329. Don't capture log output.
  330. * ``-v``
  331. Run with verbose output.
  332. If you want to run the tests for a single test file only
  333. you can do so like this:
  334. ::
  335. $ nosetests celery.tests.test_worker.test_worker_job
  336. .. _contributing-pull-requests:
  337. Creating pull requests
  338. ----------------------
  339. When your feature/bugfix is complete you may want to submit
  340. a pull requests so that it can be reviewed by the maintainers.
  341. Creating pull requests is easy, and also let you track the progress
  342. of your contribution. Read the `Pull Requests`_ section in the Github
  343. Guide to learn how this is done.
  344. You can also attach pull requests to existing issues by following
  345. the steps outlined here: http://bit.ly/koJoso
  346. .. _`Pull Requests`: http://help.github.com/send-pull-requests/
  347. .. _contributing-coverage:
  348. Calculating test coverage
  349. ~~~~~~~~~~~~~~~~~~~~~~~~~
  350. To calculate test coverage you must first install the ``coverage`` module.
  351. Installing the ``coverage`` module:
  352. ::
  353. $ pip install -U coverage
  354. Code coverage in HTML:
  355. ::
  356. $ nosetests --with-coverage --cover-html
  357. The coverage output will then be located at
  358. ``celery/tests/cover/index.html``.
  359. Code coverage in XML (Cobertura-style):
  360. ::
  361. $ nosetests --with-coverage --cover-xml --cover-xml-file=coverage.xml
  362. The coverage XML output will then be located at ``coverage.xml``
  363. .. _contributing-tox:
  364. Running the tests on all supported Python versions
  365. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  366. There is a ``tox`` configuration file in the top directory of the
  367. distribution.
  368. To run the tests for all supported Python versions simply execute:
  369. ::
  370. $ tox
  371. If you only want to test specific Python versions use the ``-e``
  372. option:
  373. ::
  374. $ tox -e py26
  375. Building the documentation
  376. --------------------------
  377. To build the documentation you need to install the dependencies
  378. listed in ``requirements/docs.txt``:
  379. ::
  380. $ pip install -U -r requirements/docs.txt
  381. After these dependencies are installed you should be able to
  382. build the docs by running:
  383. ::
  384. $ cd docs
  385. $ rm -rf .build
  386. $ make html
  387. Make sure there are no errors or warnings in the build output.
  388. After building succeeds the documentation is available at ``.build/html``.
  389. .. _contributing-verify:
  390. Verifying your contribution
  391. ---------------------------
  392. To use these tools you need to install a few dependencies. These dependencies
  393. can be found in ``requirements/pkgutils.txt``.
  394. Installing the dependencies:
  395. ::
  396. $ pip install -U -r requirements/pkgutils.txt
  397. pyflakes & PEP8
  398. ~~~~~~~~~~~~~~~
  399. To ensure that your changes conform to PEP8 and to run pyflakes
  400. execute:
  401. ::
  402. $ paver flake8
  403. To not return a negative exit code when this command fails use the
  404. ``-E`` option, this can be convenient while developing:
  405. ::
  406. $ paver flake8 -E
  407. API reference
  408. ~~~~~~~~~~~~~
  409. To make sure that all modules have a corresponding section in the API
  410. reference please execute:
  411. ::
  412. $ paver autodoc
  413. $ paver verifyindex
  414. If files are missing you can add them by copying an existing reference file.
  415. If the module is internal it should be part of the internal reference
  416. located in ``docs/internals/reference/``. If the module is public
  417. it should be located in ``docs/reference/``.
  418. For example if reference is missing for the module ``celery.worker.awesome``
  419. and this module is considered part of the public API, use the following steps:
  420. Use an existing file as a template:
  421. ::
  422. $ cd docs/reference/
  423. $ cp celery.schedules.rst celery.worker.awesome.rst
  424. Edit the file using your favorite editor:
  425. ::
  426. $ vim celery.worker.awesome.rst
  427. # change every occurance of ``celery.schedules`` to
  428. # ``celery.worker.awesome``
  429. Edit the index using your favorite editor:
  430. ::
  431. $ vim index.rst
  432. # Add ``celery.worker.awesome`` to the index.
  433. Commit your changes:
  434. ::
  435. # Add the file to git
  436. $ git add celery.worker.awesome.rst
  437. $ git add index.rst
  438. $ git commit celery.worker.awesome.rst index.rst \
  439. -m "Adds reference for celery.worker.awesome"
  440. .. _coding-style:
  441. Coding Style
  442. ============
  443. You should probably be able to pick up the coding style
  444. from surrounding code, but it is a good idea to be aware of the
  445. following conventions.
  446. * All Python code must follow the `PEP-8`_ guidelines.
  447. `pep8.py`_ is an utility you can use to verify that your code
  448. is following the conventions.
  449. .. _`PEP-8`: http://www.python.org/dev/peps/pep-0008/
  450. .. _`pep8.py`: http://pypi.python.org/pypi/pep8
  451. * Docstrings must follow the `PEP-257`_ conventions, and use the following
  452. style.
  453. Do this:
  454. ::
  455. def method(self, arg):
  456. """Short description.
  457. More details.
  458. """
  459. or:
  460. ::
  461. def method(self, arg):
  462. """Short description."""
  463. but not this:
  464. ::
  465. def method(self, arg):
  466. """
  467. Short description.
  468. """
  469. .. _`PEP-257`: http://www.python.org/dev/peps/pep-0257/
  470. * Lines should not exceed 78 columns.
  471. You can enforce this in ``vim`` by setting the ``textwidth`` option:
  472. ::
  473. set textwidth=78
  474. If adhering to this limit makes the code less readable, you have one more
  475. character to go on, which means 78 is a soft limit, and 79 is the hard
  476. limit :)
  477. * Import order
  478. * Python standard library (`import xxx`)
  479. * Python standard library ('from xxx import`)
  480. * Third party packages.
  481. * Other modules from the current package.
  482. or in case of code using Django:
  483. * Python standard library (`import xxx`)
  484. * Python standard library ('from xxx import`)
  485. * Third party packages.
  486. * Django packages.
  487. * Other modules from the current package.
  488. Within these sections the imports should be sorted by module name.
  489. Example:
  490. ::
  491. import threading
  492. import time
  493. from collections import deque
  494. from Queue import Queue, Empty
  495. from .datastructures import TokenBucket
  496. from .five import zip_longest, items, range
  497. from .utils import timeutils
  498. * Wildcard imports must not be used (`from xxx import *`).
  499. * For distributions where Python 2.5 is the oldest support version
  500. additional rules apply:
  501. * Absolute imports must be enabled at the top of every module::
  502. from __future__ import absolute_import
  503. * If the module uses the with statement and must be compatible
  504. with Python 2.5 (celery is not) then it must also enable that::
  505. from __future__ import with_statement
  506. * Every future import must be on its own line, as older Python 2.5
  507. releases did not support importing multiple features on the
  508. same future import line::
  509. # Good
  510. from __future__ import absolute_import
  511. from __future__ import with_statement
  512. # Bad
  513. from __future__ import absolute_import, with_statement
  514. (Note that this rule does not apply if the package does not include
  515. support for Python 2.5)
  516. * Note that we use "new-style` relative imports when the distribution
  517. does not support Python versions below 2.5
  518. This requires Python 2.5 or later:
  519. ::
  520. from . import submodule
  521. .. _feature-with-extras:
  522. Contributing features requiring additional libraries
  523. ====================================================
  524. Some features like a new result backend may require additional libraries
  525. that the user must install.
  526. We use setuptools `extra_requires` for this, and all new optional features
  527. that require 3rd party libraries must be added.
  528. 1) Add a new requirements file in `requirements/extras`
  529. E.g. for the Cassandra backend this is
  530. ``requirements/extras/cassandra.txt``, and the file looks like this::
  531. pycassa
  532. These are pip requirement files so you can have version specifiers and
  533. multiple packages are separated by newline. A more complex example could
  534. be:
  535. # pycassa 2.0 breaks Foo
  536. pycassa>=1.0,<2.0
  537. thrift
  538. 2) Modify ``setup.py``
  539. After the requirements file is added you need to add it as an option
  540. to ``setup.py`` in the ``extras_require`` section::
  541. extra['extras_require'] = {
  542. # ...
  543. 'cassandra': extras('cassandra.txt'),
  544. }
  545. 3) Document the new feature in ``docs/includes/installation.txt``
  546. You must add your feature to the list in the `bundles`_ section
  547. of ``docs/includes/installation.txt``.
  548. After you've made changes to this file you need to render
  549. the distro ``README`` file:
  550. ::
  551. $ pip install -U requirements/pkgutils.txt
  552. $ paver readme
  553. That's all that needs to be done, but remember that if your feature
  554. adds additional configuration options then these needs to be documented
  555. in ``docs/configuration.rst``. Also all settings need to be added to the
  556. ``celery/app/defaults.py`` module.
  557. Result backends require a separate section in the ``docs/configuration.rst``
  558. file.
  559. .. _contact_information:
  560. Contacts
  561. ========
  562. This is a list of people that can be contacted for questions
  563. regarding the official git repositories, PyPI packages
  564. Read the Docs pages.
  565. If the issue is not an emergency then it is better
  566. to `report an issue`_.
  567. Committers
  568. ----------
  569. Ask Solem
  570. ~~~~~~~~~
  571. :github: https://github.com/ask
  572. :twitter: http://twitter.com/#!/asksol
  573. Mher Movsisyan
  574. ~~~~~~~~~~~~~~
  575. :github: https://github.com/mher
  576. :twitter: http://twitter.com/#!/movsm
  577. Steeve Morin
  578. ~~~~~~~~~~~~
  579. :github: https://github.com/steeve
  580. :twitter: http://twitter.com/#!/steeve
  581. Website
  582. -------
  583. The Celery Project website is run and maintained by
  584. Mauro Rocco
  585. ~~~~~~~~~~~
  586. :github: https://github.com/fireantology
  587. :twitter: https://twitter.com/#!/fireantology
  588. with design by:
  589. Jan Henrik Helmers
  590. ~~~~~~~~~~~~~~~~~~
  591. :web: http://www.helmersworks.com
  592. :twitter: http://twitter.com/#!/helmers
  593. .. _packages:
  594. Packages
  595. ========
  596. celery
  597. ------
  598. :git: https://github.com/celery/celery
  599. :CI: http://travis-ci.org/#!/celery/celery
  600. :PyPI: http://pypi.python.org/pypi/celery
  601. :docs: http://docs.celeryproject.org
  602. kombu
  603. -----
  604. Messaging library.
  605. :git: https://github.com/celery/kombu
  606. :CI: http://travis-ci.org/#!/celery/kombu
  607. :PyPI: http://pypi.python.org/pypi/kombu
  608. :docs: http://kombu.readthedocs.org
  609. amqp
  610. ----
  611. Python AMQP 0.9.1 client.
  612. :git: https://github.com/celery/py-amqp
  613. :CI: http://travis-ci.org/#!/celery/py-amqp
  614. :PyPI: http://pypi.python.org/pypi/amqp
  615. :docs: http://amqp.readthedocs.org
  616. billiard
  617. --------
  618. Fork of multiprocessing containing improvements
  619. that will eventually be merged into the Python stdlib.
  620. :git: https://github.com/celery/billiard
  621. :PyPI: http://pypi.python.org/pypi/billiard
  622. librabbitmq
  623. -----------
  624. Very fast Python AMQP client written in C.
  625. :git: https://github.com/celery/librabbitmq
  626. :PyPI: http://pypi.python.org/pypi/librabbitmq
  627. celerymon
  628. ---------
  629. Celery monitor web-service.
  630. :git: https://github.com/celery/celerymon
  631. :PyPI: http://pypi.python.org/pypi/celerymon
  632. django-celery
  633. -------------
  634. Django <-> Celery Integration.
  635. :git: https://github.com/celery/django-celery
  636. :PyPI: http://pypi.python.org/pypi/django-celery
  637. :docs: http://docs.celeryproject.org/en/latest/django
  638. cl
  639. --
  640. Actor library.
  641. :git: https://github.com/celery/cl
  642. :PyPI: http://pypi.python.org/pypi/cl
  643. cyme
  644. ----
  645. Distributed Celery Instance manager.
  646. :git: https://github.com/celery/cyme
  647. :PyPI: http://pypi.python.org/pypi/cyme
  648. :docs: http://cyme.readthedocs.org/
  649. Deprecated
  650. ----------
  651. - Flask-Celery
  652. :git: https://github.com/ask/Flask-Celery
  653. :PyPI: http://pypi.python.org/pypi/Flask-Celery
  654. - carrot
  655. :git: https://github.com/ask/carrot
  656. :PyPI: http://pypi.python.org/pypi/carrot
  657. - ghettoq
  658. :git: https://github.com/ask/ghettoq
  659. :PyPI: http://pypi.python.org/pypi/ghettoq
  660. - kombu-sqlalchemy
  661. :git: https://github.com/ask/kombu-sqlalchemy
  662. :PyPI: http://pypi.python.org/pypi/kombu-sqlalchemy
  663. - django-kombu
  664. :git: https://github.com/ask/django-kombu
  665. :PyPI: http://pypi.python.org/pypi/django-kombu
  666. - pylibrabbitmq
  667. Old name for ``librabbitmq``.
  668. :git: ``None``
  669. :PyPI: http://pypi.python.org/pypi/pylibrabbitmq
  670. .. _release-procedure:
  671. Release Procedure
  672. =================
  673. Updating the version number
  674. ---------------------------
  675. The version number must be updated two places:
  676. * ``celery/__init__.py``
  677. * ``docs/include/introduction.txt``
  678. After you have changed these files you must render
  679. the ``README`` files. There is a script to convert sphinx syntax
  680. to generic reStructured Text syntax, and the paver task `readme`
  681. does this for you:
  682. ::
  683. $ paver readme
  684. Now commit the changes:
  685. ::
  686. $ git commit -a -m "Bumps version to X.Y.Z"
  687. and make a new version tag:
  688. ::
  689. $ git tag vX.Y.Z
  690. $ git push --tags
  691. Releasing
  692. ---------
  693. Commands to make a new public stable release::
  694. $ paver releaseok # checks pep8, autodoc index, runs tests and more
  695. $ paver removepyc # Remove .pyc files
  696. $ git clean -xdn # Check that there's no left-over files in the repo
  697. $ python setup.py sdist upload # Upload package to PyPI
  698. If this is a new release series then you also need to do the
  699. following:
  700. * Go to the Read The Docs management interface at:
  701. http://readthedocs.org/projects/celery/?fromdocs=celery
  702. * Enter "Edit project"
  703. Change default branch to the branch of this series, e.g. ``2.4``
  704. for series 2.4.
  705. * Also add the previous version under the "versions" tab.
  706. .. _`mailing-list`: http://groups.google.com/group/celery-users
  707. .. _`irc-channel`: http://docs.celeryproject.org/en/latest/getting-started/resources.html#irc
  708. .. _`internals-guide`: http://docs.celeryproject.org/en/latest/internals/guide.html
  709. .. _`bundles`: http://docs.celeryproject.org/en/latest/getting-started/introduction.html#bundles
  710. .. _`report an issue`: http://docs.celeryproject.org/en/latest/contributing.html#reporting-bugs