README.rst 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. ========
  2. billiard
  3. ========
  4. :version: 3.5.0.4
  5. |build-status-lin| |build-status-win| |license| |wheel| |pyversion| |pyimp|
  6. .. |build-status-lin| image:: https://secure.travis-ci.org/celery/billiard.png?branch=master
  7. :alt: Build status on Linux
  8. :target: https://travis-ci.org/celery/billiard
  9. .. |build-status-win| image:: https://ci.appveyor.com/api/projects/status/github/celery/billiard?png=true&branch=master
  10. :alt: Build status on Windows
  11. :target: https://ci.appveyor.com/project/ask/billiard
  12. .. |license| image:: https://img.shields.io/pypi/l/billiard.svg
  13. :alt: BSD License
  14. :target: https://opensource.org/licenses/BSD-3-Clause
  15. .. |wheel| image:: https://img.shields.io/pypi/wheel/billiard.svg
  16. :alt: Billiard can be installed via wheel
  17. :target: https://pypi.org/project/billiard/
  18. .. |pyversion| image:: https://img.shields.io/pypi/pyversions/billiard.svg
  19. :alt: Supported Python versions.
  20. :target: https://pypi.org/project/billiard/
  21. .. |pyimp| image:: https://img.shields.io/pypi/implementation/billiard.svg
  22. :alt: Support Python implementations.
  23. :target: https://pypi.org/project/billiard/
  24. About
  25. -----
  26. `billiard` is a fork of the Python 2.7 `multiprocessing <https://docs.python.org/library/multiprocessing.html>`_
  27. package. The multiprocessing package itself is a renamed and updated version of
  28. R Oudkerk's `pyprocessing <https://pypi.org/project/processing/>`_ package.
  29. This standalone variant draws its fixes/improvements from python-trunk and provides
  30. additional bug fixes and improvements.
  31. - This package would not be possible if not for the contributions of not only
  32. the current maintainers but all of the contributors to the original pyprocessing
  33. package listed `here <http://pyprocessing.berlios.de/doc/THANKS.html>`_
  34. - Also it is a fork of the multiprocessing backport package by Christian Heims.
  35. - It includes the no-execv patch contributed by R. Oudkerk.
  36. - And the Pool improvements previously located in `Celery`_.
  37. - Billiard is used in and is a dependency for `Celery`_ and is maintained by the
  38. Celery team.
  39. .. _`Celery`: http://celeryproject.org
  40. Bug reporting
  41. -------------
  42. Please report bugs related to multiprocessing at the
  43. `Python bug tracker <https://bugs.python.org/>`_. Issues related to billiard
  44. should be reported at https://github.com/celery/billiard/issues.