METADATA 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. Metadata-Version: 2.1
  2. Name: aiosignal
  3. Version: 1.3.1
  4. Summary: aiosignal: a list of registered asynchronous callbacks
  5. Home-page: https://github.com/aio-libs/aiosignal
  6. Maintainer: aiohttp team <team@aiohttp.org>
  7. Maintainer-email: team@aiohttp.org
  8. License: Apache 2.0
  9. Project-URL: Chat: Gitter, https://gitter.im/aio-libs/Lobby
  10. Project-URL: CI: GitHub Actions, https://github.com/aio-libs/aiosignal/actions
  11. Project-URL: Coverage: codecov, https://codecov.io/github/aio-libs/aiosignal
  12. Project-URL: Docs: RTD, https://docs.aiosignal.org
  13. Project-URL: GitHub: issues, https://github.com/aio-libs/aiosignal/issues
  14. Project-URL: GitHub: repo, https://github.com/aio-libs/aiosignal
  15. Classifier: License :: OSI Approved :: Apache Software License
  16. Classifier: Intended Audience :: Developers
  17. Classifier: Programming Language :: Python
  18. Classifier: Programming Language :: Python :: 3
  19. Classifier: Programming Language :: Python :: 3 :: Only
  20. Classifier: Programming Language :: Python :: 3.7
  21. Classifier: Programming Language :: Python :: 3.8
  22. Classifier: Programming Language :: Python :: 3.9
  23. Classifier: Programming Language :: Python :: 3.10
  24. Classifier: Programming Language :: Python :: 3.11
  25. Classifier: Development Status :: 5 - Production/Stable
  26. Classifier: Operating System :: POSIX
  27. Classifier: Operating System :: MacOS :: MacOS X
  28. Classifier: Operating System :: Microsoft :: Windows
  29. Classifier: Framework :: AsyncIO
  30. Requires-Python: >=3.7
  31. Description-Content-Type: text/x-rst
  32. License-File: LICENSE
  33. Requires-Dist: frozenlist (>=1.1.0)
  34. =========
  35. aiosignal
  36. =========
  37. .. image:: https://github.com/aio-libs/aiosignal/workflows/CI/badge.svg
  38. :target: https://github.com/aio-libs/aiosignal/actions?query=workflow%3ACI
  39. :alt: GitHub status for master branch
  40. .. image:: https://codecov.io/gh/aio-libs/aiosignal/branch/master/graph/badge.svg
  41. :target: https://codecov.io/gh/aio-libs/aiosignal
  42. :alt: codecov.io status for master branch
  43. .. image:: https://badge.fury.io/py/aiosignal.svg
  44. :target: https://pypi.org/project/aiosignal
  45. :alt: Latest PyPI package version
  46. .. image:: https://readthedocs.org/projects/aiosignal/badge/?version=latest
  47. :target: https://aiosignal.readthedocs.io/
  48. :alt: Latest Read The Docs
  49. .. image:: https://img.shields.io/discourse/topics?server=https%3A%2F%2Faio-libs.discourse.group%2F
  50. :target: https://aio-libs.discourse.group/
  51. :alt: Discourse group for io-libs
  52. .. image:: https://badges.gitter.im/Join%20Chat.svg
  53. :target: https://gitter.im/aio-libs/Lobby
  54. :alt: Chat on Gitter
  55. Introduction
  56. ============
  57. A project to manage callbacks in `asyncio` projects.
  58. ``Signal`` is a list of registered asynchronous callbacks.
  59. The signal's life-cycle has two stages: after creation its content
  60. could be filled by using standard list operations: ``sig.append()``
  61. etc.
  62. After you call ``sig.freeze()`` the signal is *frozen*: adding, removing
  63. and dropping callbacks is forbidden.
  64. The only available operation is calling the previously registered
  65. callbacks by using ``await sig.send(data)``.
  66. For concrete usage examples see the `Signals
  67. <https://docs.aiohttp.org/en/stable/web_advanced.html#aiohttp-web-signals>
  68. section of the `Web Server Advanced
  69. <https://docs.aiohttp.org/en/stable/web_advanced.html>` chapter of the `aiohttp
  70. documentation`_.
  71. Installation
  72. ------------
  73. ::
  74. $ pip install aiosignal
  75. The library requires Python 3.6 or newer.
  76. Documentation
  77. =============
  78. https://aiosignal.readthedocs.io/
  79. Communication channels
  80. ======================
  81. *gitter chat* https://gitter.im/aio-libs/Lobby
  82. Requirements
  83. ============
  84. - Python >= 3.6
  85. - frozenlist >= 1.0.0
  86. License
  87. =======
  88. ``aiosignal`` is offered under the Apache 2 license.
  89. Source code
  90. ===========
  91. The project is hosted on GitHub_
  92. Please file an issue in the `bug tracker
  93. <https://github.com/aio-libs/aiosignal/issues>`_ if you have found a bug
  94. or have some suggestions to improve the library.
  95. .. _GitHub: https://github.com/aio-libs/aiosignal
  96. .. _aiohttp documentation: https://docs.aiohttp.org/