METADATA 3.7 KB

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