METADATA 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  1. Metadata-Version: 2.0
  2. Name: bidict
  3. Version: 0.17.2
  4. Summary: Efficient, Pythonic bidirectional map implementation and related functionality
  5. Home-page: https://bidict.readthedocs.io
  6. Author: Joshua Bronson
  7. Author-email: jab@math.brown.edu
  8. License: MPL 2.0
  9. Keywords: dict dictionary mapping datastructure bimap bijection bijective injective inverse reverse bidirectional two-way 2-way
  10. Platform: UNKNOWN
  11. Classifier: Development Status :: 4 - Beta
  12. Classifier: Intended Audience :: Developers
  13. Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
  14. Classifier: Operating System :: OS Independent
  15. Classifier: Programming Language :: Python :: 2.7
  16. Classifier: Programming Language :: Python :: 3
  17. Classifier: Programming Language :: Python :: 3.4
  18. Classifier: Programming Language :: Python :: 3.5
  19. Classifier: Programming Language :: Python :: 3.6
  20. Classifier: Programming Language :: Python :: 3.7
  21. Classifier: Programming Language :: Python :: Implementation :: CPython
  22. Classifier: Programming Language :: Python :: Implementation :: PyPy
  23. Classifier: Topic :: Software Development :: Libraries :: Python Modules
  24. Provides-Extra: coverage
  25. Requires-Dist: coverage (<5); extra == 'coverage'
  26. Requires-Dist: pytest-cov (<3); extra == 'coverage'
  27. Provides-Extra: dev
  28. Requires-Dist: Sphinx (<2); extra == 'dev'
  29. Requires-Dist: coverage (<5); extra == 'dev'
  30. Requires-Dist: flake8 (<3.6); extra == 'dev'
  31. Requires-Dist: hypothesis (<4); extra == 'dev'
  32. Requires-Dist: hypothesis-pytest (<1); extra == 'dev'
  33. Requires-Dist: pre-commit (<2); extra == 'dev'
  34. Requires-Dist: py (<2); extra == 'dev'
  35. Requires-Dist: pydocstyle (<2.2); extra == 'dev'
  36. Requires-Dist: pylint (<1.9); extra == 'dev'
  37. Requires-Dist: pytest (<4); extra == 'dev'
  38. Requires-Dist: pytest-benchmark (<4); extra == 'dev'
  39. Requires-Dist: pytest-cov (<3); extra == 'dev'
  40. Requires-Dist: pytest-runner; extra == 'dev'
  41. Requires-Dist: setuptools-scm; extra == 'dev'
  42. Requires-Dist: sortedcollections (<1); extra == 'dev'
  43. Requires-Dist: sortedcontainers (<2); extra == 'dev'
  44. Requires-Dist: tox (<4); extra == 'dev'
  45. Provides-Extra: docs
  46. Requires-Dist: Sphinx (<2); extra == 'docs'
  47. Provides-Extra: test
  48. Requires-Dist: hypothesis (<4); extra == 'test'
  49. Requires-Dist: hypothesis-pytest (<1); extra == 'test'
  50. Requires-Dist: py (<2); extra == 'test'
  51. Requires-Dist: pytest (<4); extra == 'test'
  52. Requires-Dist: pytest-benchmark (<4); extra == 'test'
  53. Requires-Dist: sortedcollections (<1); extra == 'test'
  54. Requires-Dist: sortedcontainers (<2); extra == 'test'
  55. .. Forward declarations for all the custom interpreted text roles that
  56. Sphinx defines and that are used below. This helps Sphinx-unaware tools
  57. (e.g. rst2html, PyPI's and GitHub's renderers, etc.).
  58. .. role:: doc
  59. bidict
  60. ======
  61. Efficient, Pythonic bidirectional map implementation and related functionality.
  62. .. image:: https://raw.githubusercontent.com/jab/bidict/master/assets/logo.png
  63. :target: https://bidict.readthedocs.io/
  64. :alt: bidict logo
  65. Status
  66. ------
  67. .. Hide until https://github.com/badges/shields/issues/716 is fixed
  68. .. image:: https://img.shields.io/pypi/dm/bidict.svg
  69. :target: https://pypi.org/project/bidict
  70. :alt: Downloads per month
  71. .. image:: https://img.shields.io/pypi/v/bidict.svg
  72. :target: https://pypi.org/project/bidict
  73. :alt: Latest release
  74. .. image:: https://img.shields.io/readthedocs/bidict/master.svg
  75. :target: https://bidict.readthedocs.io/en/master/
  76. :alt: Documentation
  77. .. image:: https://api.travis-ci.org/jab/bidict.svg?branch=master
  78. :target: https://travis-ci.org/jab/bidict
  79. :alt: Travis-CI build status
  80. .. image:: https://ci.appveyor.com/api/projects/status/gk133415udncwto3/branch/master?svg=true
  81. :target: https://ci.appveyor.com/project/jab/bidict
  82. :alt: AppVeyor (Windows) build status
  83. .. image:: https://codecov.io/gh/jab/bidict/branch/master/graph/badge.svg
  84. :target: https://codecov.io/gh/jab/bidict
  85. :alt: Test coverage
  86. .. image:: https://api.codacy.com/project/badge/Grade/6628756a73254cd895656348236833b8
  87. :target: https://www.codacy.com/app/jab/bidict
  88. :alt: Codacy grade
  89. .. Hide to reduce clutter
  90. .. image:: https://img.shields.io/pypi/pyversions/bidict.svg
  91. :target: https://pypi.org/project/bidict
  92. :alt: Supported Python versions
  93. .. image:: https://img.shields.io/pypi/implementation/bidict.svg
  94. :target: https://pypi.org/project/bidict
  95. :alt: Supported Python implementations
  96. .. image:: https://img.shields.io/badge/lgtm-👍-blue.svg
  97. :target: https://lgtm.com/projects/g/jab/bidict/
  98. :alt: LGTM
  99. .. image:: https://img.shields.io/pypi/l/bidict.svg
  100. :target: https://raw.githubusercontent.com/jab/bidict/master/LICENSE
  101. :alt: License
  102. Bidict:
  103. ^^^^^^^
  104. - is in use by several teams at Google, Venmo, CERN, Bank of America Merrill Lynch,
  105. Two Sigma, and many others,
  106. - has carefully designed APIs for
  107. safety, simplicity, flexibility, and ergonomics,
  108. - is CPython-, PyPy-, Python 2-, and Python 3-compatible,
  109. - has extensive `test coverage <https://codecov.io/gh/jab/bidict>`__,
  110. including property-based tests and benchmarks,
  111. which are run continuously on all supported Python versions and OSes,
  112. - integrates with Python’s collections interfaces and abstract base classes,
  113. - has mature, well-factored, well-documented code.
  114. Installation
  115. ------------
  116. ``pip install bidict``
  117. Quick Start
  118. -----------
  119. .. code:: python
  120. >>> from bidict import bidict
  121. >>> element_by_symbol = bidict({'H': 'hydrogen'})
  122. >>> element_by_symbol['H']
  123. 'hydrogen'
  124. >>> element_by_symbol.inv['hydrogen']
  125. 'H'
  126. For more usage documentation,
  127. head to the :doc:`intro` [#fn-intro]_
  128. and proceed from there.
  129. Community and Support
  130. ---------------------
  131. .. image:: https://img.shields.io/badge/chat-on%20gitter-5AB999.svg?logo=gitter-white
  132. :target: https://gitter.im/jab/bidict
  133. :alt: Chat
  134. If you are thinking of using bidict in your work,
  135. or if you have any questions, comments, or suggestions,
  136. I'd love to know about your use case
  137. and provide as much support for it as possible.
  138. Please feel free to leave a message in the
  139. `chatroom <https://gitter.im/jab/bidict>`__
  140. or to open a new issue on GitHub.
  141. You can search through
  142. `existing issues <https://github.com/jab/bidict/issues>`__
  143. before creating a new one
  144. in case your questions or concerns have been adressed there already.
  145. Notice of Usage
  146. ---------------
  147. If you use bidict,
  148. and especially if your usage or your organization is significant in some way,
  149. please let me know.
  150. You can:
  151. - quickly +1 `this issue <https://github.com/jab/bidict/issues/62>`__
  152. - create your own `dedicated issue <https://github.com/jab/bidict/issues/new?title=Notice+of+Usage&body=I+am+using+bidict+for...>`__
  153. - leave a message in the `chat room <https://gitter.im/jab/bidict>`__
  154. - `email me <mailto:jab@math.brown.edu?subject=bidict&body=I%20am%20using%20bidict%20for...>`__
  155. Changelog
  156. ---------
  157. See the :doc:`changelog` [#fn-changelog]_
  158. for a history of notable changes to bidict.
  159. Release Notifications
  160. ---------------------
  161. .. duplicated in CHANGELOG.rst:
  162. (would use `.. include::` but GitHub doesn't understand it)
  163. .. image:: https://img.shields.io/badge/libraries.io-subscribe-5BC0DF.svg
  164. :target: https://libraries.io/pypi/bidict
  165. :alt: Follow on libraries.io
  166. Tip: `Subscribe to bidict releases <https://libraries.io/pypi/bidict>`__
  167. on libraries.io to be notified when new versions of bidict are released.
  168. Learning from bidict
  169. --------------------
  170. One of the most rewarding things about bidict
  171. is the outsized amount of advanced Python
  172. it covers in light of its small codebase.
  173. Check out :doc:`learning-from-bidict` [#fn-learning]_
  174. if you're interested in learning more.
  175. Contributing
  176. ------------
  177. Bidict is currently a one-person operation
  178. maintained on a voluntary basis
  179. with no other sponsorship.
  180. Your help would be most welcome!
  181. Reviewers Wanted!
  182. ^^^^^^^^^^^^^^^^^
  183. One of the most valuable ways to contribute to bidict
  184. and to :doc:`explore some advanced Python <learning-from-bidict>`
  185. while you're at it
  186. is to review bidict's relatively small codebase.
  187. Please create an issue or pull request with any improvements you'd propose
  188. or any other results you found.
  189. (Submitting a "Nothing-to-merge" PR with feedback in inline code comments or a
  190. `Review results <https://github.com/jab/bidict/issues/new?title=Review+results>`__
  191. issue both work well.)
  192. You can also
  193. +1 `this issue <https://github.com/jab/bidict/issues/63>`__
  194. to sign up to give feedback on future proposed changes
  195. that are in need of a reviewer.
  196. Funding
  197. ^^^^^^^
  198. .. duplicated in CONTRIBUTING.rst
  199. (would use `.. include::` but GitHub doesn't understand it)
  200. If bidict has helped you accomplish your work,
  201. especially work you've been paid for,
  202. please consider chipping in toward the costs
  203. of bidict's maintenance and development
  204. and/or ask your organization to do the same.
  205. Any amount contributed is gratefully received.
  206. .. image:: https://raw.githubusercontent.com/jab/bidict/master/assets/support-on-gumroad.png
  207. :target: https://gumroad.com/l/bidict
  208. :alt: Support bidict
  209. Finding Documentation
  210. ---------------------
  211. If you're viewing this on `<https://bidict.readthedocs.io>`__,
  212. note that multiple versions of the documentation are available,
  213. and you can choose a different version using the popup menu at the bottom-right.
  214. Please make sure you're viewing the version of the documentation
  215. that corresponds to the version of bidict you'd like to use.
  216. If you're viewing this on GitHub, PyPI, or some other place
  217. that can't render and link this documentation properly
  218. and are seeing broken links,
  219. try these alternate links instead:
  220. .. [#fn-intro] `<docs/intro.rst>`__ | `<https://bidict.readthedocs.io/intro.html>`__
  221. .. [#fn-changelog] `<CHANGELOG.rst>`__ | `<https://bidict.readthedocs.io/changelog.html>`__
  222. .. [#fn-learning] `<docs/learning-from-bidict.rst>`__ | `<https://bidict.readthedocs.io/learning-from-bidict.html>`__
  223. ----
  224. Next: :doc:`intro` [#fn-intro]_