pyrefdev 2025.3__tar.gz → 2025.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. {pyrefdev-2025.3 → pyrefdev-2025.5}/.gitignore +3 -0
  2. pyrefdev-2025.5/CHANGELOG.md +109 -0
  3. {pyrefdev-2025.3 → pyrefdev-2025.5}/PKG-INFO +12 -4
  4. {pyrefdev-2025.3 → pyrefdev-2025.5}/README.md +10 -3
  5. pyrefdev-2025.5/index.html +556 -0
  6. {pyrefdev-2025.3 → pyrefdev-2025.5}/pyproject.toml +1 -0
  7. pyrefdev-2025.5/src/pyrefdev/_version.py +1 -0
  8. pyrefdev-2025.5/src/pyrefdev/config.py +132 -0
  9. {pyrefdev-2025.3 → pyrefdev-2025.5}/src/pyrefdev/indexer/__main__.py +6 -0
  10. pyrefdev-2025.5/src/pyrefdev/indexer/add_docs.py +44 -0
  11. pyrefdev-2025.5/src/pyrefdev/indexer/crawl_docs.py +264 -0
  12. {pyrefdev-2025.3 → pyrefdev-2025.5}/src/pyrefdev/indexer/parse_docs.py +173 -46
  13. pyrefdev-2025.5/src/pyrefdev/indexer/requests.py +58 -0
  14. pyrefdev-2025.5/src/pyrefdev/indexer/schema.py +16 -0
  15. pyrefdev-2025.5/src/pyrefdev/indexer/update_docs.py +31 -0
  16. pyrefdev-2025.5/src/pyrefdev/indexer/update_landing_page.py +50 -0
  17. {pyrefdev-2025.3 → pyrefdev-2025.5}/src/pyrefdev/mapping/__init__.py +6 -2
  18. {pyrefdev-2025.3 → pyrefdev-2025.5}/src/pyrefdev/mapping/__python__.py +56 -3
  19. pyrefdev-2025.5/src/pyrefdev/mapping/aiohttp.py +646 -0
  20. pyrefdev-2025.5/src/pyrefdev/mapping/aioitertools.py +47 -0
  21. pyrefdev-2025.5/src/pyrefdev/mapping/aiosignal.py +9 -0
  22. pyrefdev-2025.5/src/pyrefdev/mapping/anyio.py +302 -0
  23. pyrefdev-2025.5/src/pyrefdev/mapping/apache-beam.py +6066 -0
  24. pyrefdev-2025.5/src/pyrefdev/mapping/arrow.py +857 -0
  25. pyrefdev-2025.5/src/pyrefdev/mapping/attrs.py +99 -0
  26. pyrefdev-2025.5/src/pyrefdev/mapping/azure-identity.py +182 -0
  27. pyrefdev-2025.5/src/pyrefdev/mapping/boto3.py +154 -0
  28. pyrefdev-2025.5/src/pyrefdev/mapping/botocore.py +58 -0
  29. pyrefdev-2025.5/src/pyrefdev/mapping/cachetools.py +41 -0
  30. pyrefdev-2025.5/src/pyrefdev/mapping/cattrs.py +239 -0
  31. pyrefdev-2025.5/src/pyrefdev/mapping/charset-normalizer.py +68 -0
  32. pyrefdev-2025.5/src/pyrefdev/mapping/click.py +219 -0
  33. pyrefdev-2025.5/src/pyrefdev/mapping/coverage.py +113 -0
  34. pyrefdev-2025.5/src/pyrefdev/mapping/cryptography.py +1188 -0
  35. pyrefdev-2025.5/src/pyrefdev/mapping/distlib.py +197 -0
  36. pyrefdev-2025.5/src/pyrefdev/mapping/fastapi.py +897 -0
  37. pyrefdev-2025.5/src/pyrefdev/mapping/fastjsonschema.py +11 -0
  38. pyrefdev-2025.5/src/pyrefdev/mapping/filelock.py +35 -0
  39. pyrefdev-2025.5/src/pyrefdev/mapping/flask.py +502 -0
  40. pyrefdev-2025.5/src/pyrefdev/mapping/frozenlist.py +8 -0
  41. pyrefdev-2025.5/src/pyrefdev/mapping/fsspec.py +248 -0
  42. pyrefdev-2025.5/src/pyrefdev/mapping/google-api-core.py +250 -0
  43. pyrefdev-2025.5/src/pyrefdev/mapping/google-auth.py +670 -0
  44. pyrefdev-2025.5/src/pyrefdev/mapping/grpcio.py +282 -0
  45. pyrefdev-2025.5/src/pyrefdev/mapping/h11.py +61 -0
  46. pyrefdev-2025.5/src/pyrefdev/mapping/h5py.py +120 -0
  47. pyrefdev-2025.5/src/pyrefdev/mapping/httplib2.py +38 -0
  48. pyrefdev-2025.5/src/pyrefdev/mapping/ipython.py +5 -0
  49. pyrefdev-2025.5/src/pyrefdev/mapping/jinja2.py +268 -0
  50. pyrefdev-2025.5/src/pyrefdev/mapping/jsonschema.py +184 -0
  51. pyrefdev-2025.5/src/pyrefdev/mapping/jupyter-core.py +83 -0
  52. pyrefdev-2025.5/src/pyrefdev/mapping/libcst.py +939 -0
  53. pyrefdev-2025.5/src/pyrefdev/mapping/markupsafe.py +12 -0
  54. pyrefdev-2025.5/src/pyrefdev/mapping/matplotlib.py +6351 -0
  55. pyrefdev-2025.5/src/pyrefdev/mapping/more-itertools.py +161 -0
  56. pyrefdev-2025.5/src/pyrefdev/mapping/multidict.py +41 -0
  57. pyrefdev-2025.5/src/pyrefdev/mapping/nbformat.py +38 -0
  58. pyrefdev-2025.5/src/pyrefdev/mapping/networkx.py +1490 -0
  59. pyrefdev-2025.5/src/pyrefdev/mapping/numba.py +48 -0
  60. {pyrefdev-2025.3 → pyrefdev-2025.5}/src/pyrefdev/mapping/numpy.py +43 -0
  61. pyrefdev-2025.5/src/pyrefdev/mapping/oauthlib.py +248 -0
  62. pyrefdev-2025.5/src/pyrefdev/mapping/packaging.py +144 -0
  63. pyrefdev-2025.5/src/pyrefdev/mapping/pandas.py +2140 -0
  64. pyrefdev-2025.5/src/pyrefdev/mapping/pathspec.py +88 -0
  65. pyrefdev-2025.5/src/pyrefdev/mapping/pillow.py +1364 -0
  66. pyrefdev-2025.5/src/pyrefdev/mapping/platformdirs.py +163 -0
  67. pyrefdev-2025.5/src/pyrefdev/mapping/pluggy.py +74 -0
  68. pyrefdev-2025.5/src/pyrefdev/mapping/propcache.py +8 -0
  69. pyrefdev-2025.5/src/pyrefdev/mapping/protobuf.py +2011 -0
  70. pyrefdev-2025.5/src/pyrefdev/mapping/psutil.py +176 -0
  71. pyrefdev-2025.5/src/pyrefdev/mapping/pyOpenSSL.py +274 -0
  72. pyrefdev-2025.5/src/pyrefdev/mapping/pyarrow.py +5194 -0
  73. pyrefdev-2025.5/src/pyrefdev/mapping/pyasn1.py +442 -0
  74. pyrefdev-2025.5/src/pyrefdev/mapping/pydantic-core.py +158 -0
  75. pyrefdev-2025.5/src/pyrefdev/mapping/pydantic.py +417 -0
  76. pyrefdev-2025.5/src/pyrefdev/mapping/pygments.py +60 -0
  77. pyrefdev-2025.5/src/pyrefdev/mapping/pyjwt.py +29 -0
  78. pyrefdev-2025.5/src/pyrefdev/mapping/pyparsing.py +403 -0
  79. pyrefdev-2025.5/src/pyrefdev/mapping/pytest.py +547 -0
  80. pyrefdev-2025.5/src/pyrefdev/mapping/python-dateutil.py +101 -0
  81. pyrefdev-2025.5/src/pyrefdev/mapping/requests-oauthlib.py +26 -0
  82. pyrefdev-2025.5/src/pyrefdev/mapping/requests-toolbelt.py +89 -0
  83. pyrefdev-2025.5/src/pyrefdev/mapping/requests.py +161 -0
  84. pyrefdev-2025.5/src/pyrefdev/mapping/rich.py +556 -0
  85. pyrefdev-2025.5/src/pyrefdev/mapping/rpds-py.py +44 -0
  86. pyrefdev-2025.5/src/pyrefdev/mapping/s3fs.py +121 -0
  87. pyrefdev-2025.5/src/pyrefdev/mapping/scikit-learn.py +63 -0
  88. pyrefdev-2025.5/src/pyrefdev/mapping/scipy.py +4151 -0
  89. pyrefdev-2025.5/src/pyrefdev/mapping/semver.py +5 -0
  90. pyrefdev-2025.5/src/pyrefdev/mapping/setuptools.py +26 -0
  91. pyrefdev-2025.5/src/pyrefdev/mapping/six.py +67 -0
  92. pyrefdev-2025.5/src/pyrefdev/mapping/sniffio.py +9 -0
  93. pyrefdev-2025.5/src/pyrefdev/mapping/sqlalchemy.py +6604 -0
  94. pyrefdev-2025.5/src/pyrefdev/mapping/tomlkit.py +159 -0
  95. pyrefdev-2025.5/src/pyrefdev/mapping/torch.py +5493 -0
  96. pyrefdev-2025.5/src/pyrefdev/mapping/tox.py +270 -0
  97. pyrefdev-2025.5/src/pyrefdev/mapping/trio.py +425 -0
  98. pyrefdev-2025.5/src/pyrefdev/mapping/typing-extensions.py +127 -0
  99. pyrefdev-2025.5/src/pyrefdev/mapping/urllib3.py +274 -0
  100. pyrefdev-2025.5/src/pyrefdev/mapping/werkzeug.py +567 -0
  101. pyrefdev-2025.5/src/pyrefdev/mapping/wrapt.py +5 -0
  102. pyrefdev-2025.5/src/pyrefdev/mapping/yarl.py +63 -0
  103. pyrefdev-2025.5/tests/test_pyrefdev.py +11 -0
  104. {pyrefdev-2025.3 → pyrefdev-2025.5}/uv.lock +2 -0
  105. pyrefdev-2025.3/CHANGELOG.md +0 -9
  106. pyrefdev-2025.3/index.html +0 -348
  107. pyrefdev-2025.3/src/pyrefdev/_version.py +0 -1
  108. pyrefdev-2025.3/src/pyrefdev/config.py +0 -39
  109. pyrefdev-2025.3/src/pyrefdev/indexer/crawl_docs.py +0 -185
  110. pyrefdev-2025.3/tests/test_mapping.py +0 -6
  111. {pyrefdev-2025.3 → pyrefdev-2025.5}/.github/workflows/ci.yml +0 -0
  112. {pyrefdev-2025.3 → pyrefdev-2025.5}/.github/workflows/pypi_upload.yml +0 -0
  113. {pyrefdev-2025.3 → pyrefdev-2025.5}/LICENSE +0 -0
  114. {pyrefdev-2025.3 → pyrefdev-2025.5}/pyrefdev.service +0 -0
  115. {pyrefdev-2025.3 → pyrefdev-2025.5}/src/pyrefdev/__init__.py +0 -0
  116. {pyrefdev-2025.3 → pyrefdev-2025.5}/src/pyrefdev/__main__.py +0 -0
  117. {pyrefdev-2025.3 → pyrefdev-2025.5}/src/pyrefdev/server.py +0 -0
@@ -1,3 +1,6 @@
1
+ .DS_Store
2
+ docs/
3
+
1
4
  # Hatch-managed version file
2
5
  src/pyrefdev/_version.py
3
6
 
@@ -0,0 +1,109 @@
1
+ # Changelog
2
+
3
+ ## [Unreleased]
4
+
5
+ Nothing noticeable unreleased.
6
+
7
+ ## v2025.5
8
+
9
+ - Added `add-docs`, `update-docs`, and `update-landing-page` commands to `pyrefdev-indexer`.
10
+ - Added missing module symbols.
11
+ - Support [aiohttp](https://docs.aiohttp.org/en/stable/).
12
+ - Support [aioitertools](https://aioitertools.omnilib.dev/en/stable/).
13
+ - Support [aiosignal](https://aiosignal.aio-libs.org/en/stable/).
14
+ - Support [anyio](https://anyio.readthedocs.io/en/stable/).
15
+ - Support [apache-beam](https://beam.apache.org/releases/pydoc/current/).
16
+ - Support [arrow](https://arrow.readthedocs.io/en/latest/).
17
+ - Support [attrs](https://www.attrs.org/en/stable/).
18
+ - Support [azure-identity](https://azuresdkdocs.z19.web.core.windows.net/python/azure-identity/latest/index.html).
19
+ - Support [boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html).
20
+ - Support [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html).
21
+ - Support [cachetools](https://cachetools.readthedocs.io/en/latest/).
22
+ - Support [cattrs](https://catt.rs/en/stable/).
23
+ - Support [charset-normalizer](https://charset-normalizer.readthedocs.io/en/latest/).
24
+ - Support [click](https://click.palletsprojects.com/en/stable/).
25
+ - Support [coverage](https://coverage.readthedocs.io/en/latest/).
26
+ - Support [cryptography](https://cryptography.io/en/latest/).
27
+ - Support [distlib](https://distlib.readthedocs.io/en/latest/).
28
+ - Support [fastapi](https://fastapi.tiangolo.com/reference/).
29
+ - Support [fastjsonschema](https://horejsek.github.io/python-fastjsonschema/).
30
+ - Support [filelock](https://py-filelock.readthedocs.io/en/latest/).
31
+ - Support [flask](https://flask.palletsprojects.com/en/stable/).
32
+ - Support [frozenlist](https://frozenlist.aio-libs.org/en/latest/).
33
+ - Support [fsspec](https://filesystem-spec.readthedocs.io/en/latest/).
34
+ - Support [google-api-core](https://googleapis.dev/python/google-api-core/latest/).
35
+ - Support [google-auth](https://googleapis.dev/python/google-auth/latest/).
36
+ - Support [grpcio](https://grpc.github.io/grpc/python/index.html).
37
+ - Support [h11](https://h11.readthedocs.io/en/latest/).
38
+ - Support [h5py](https://docs.h5py.org/en/stable/).
39
+ - Support [httplib2](https://httplib2.readthedocs.io/en/latest/).
40
+ - Support [ipython](https://ipython.readthedocs.io/en/stable/).
41
+ - Support [jinja2](https://jinja.palletsprojects.com/en/latest/).
42
+ - Support [jsonschema](https://python-jsonschema.readthedocs.io/en/stable/).
43
+ - Support [jupyter-core](https://jupyter-core.readthedocs.io/en/latest/).
44
+ - Support [markupsafe](https://markupsafe.palletsprojects.com/en/stable/).
45
+ - Support [matplotlib](https://matplotlib.org/stable/api/index.html).
46
+ - Support [more-itertools](https://more-itertools.readthedocs.io/en/stable/).
47
+ - Support [multidict](https://multidict.aio-libs.org/en/stable/).
48
+ - Support [nbformat](https://nbformat.readthedocs.io/en/latest/).
49
+ - Support [networkx](https://networkx.org/documentation/stable/reference/index.html).
50
+ - Support [numba](https://numba.readthedocs.io/en/stable/reference/index.html).
51
+ - Support [oauthlib](https://oauthlib.readthedocs.io/en/latest/).
52
+ - Support [packaging](https://packaging.pypa.io/en/stable/).
53
+ - Support [pathspec](https://python-path-specification.readthedocs.io/en/latest/index.html).
54
+ - Support [pillow](https://pillow.readthedocs.io/en/stable/).
55
+ - Support [platformdirs](https://platformdirs.readthedocs.io/en/latest/).
56
+ - Support [pluggy](https://pluggy.readthedocs.io/en/latest/).
57
+ - Support [propcache](https://propcache.aio-libs.org/en/latest/).
58
+ - Support [protobuf](https://googleapis.dev/python/protobuf/latest/).
59
+ - Support [psutil](https://psutil.readthedocs.io/en/latest/).
60
+ - Support [pyarrow](https://arrow.apache.org/docs/python/api.html).
61
+ - Support [pyasn1](https://pyasn1.readthedocs.io/en/latest/contents.html).
62
+ - Support [pydantic-core](https://docs.pydantic.dev/latest/).
63
+ - Support [pydantic](https://docs.pydantic.dev/latest/).
64
+ - Support [pygments](https://pygments.org/docs/api/).
65
+ - Support [pyjwt](https://pyjwt.readthedocs.io/en/stable/).
66
+ - Support [pyOpenSSL](https://www.pyopenssl.org/en/latest/).
67
+ - Support [pyparsing](https://pyparsing-docs.readthedocs.io/en/latest/).
68
+ - Support [pytest](https://docs.pytest.org/en/stable/reference/index.html).
69
+ - Support [requests-oauthlib](https://requests-oauthlib.readthedocs.io/en/latest/).
70
+ - Support [requests-toolbelt](https://toolbelt.readthedocs.io/en/latest/index.html).
71
+ - Support [rich](https://rich.readthedocs.io/en/latest/).
72
+ - Support [rpds-py](https://rpds.readthedocs.io/en/latest/).
73
+ - Support [s3fs](https://s3fs.readthedocs.io/en/latest/).
74
+ - Support [scikit-learn](https://scikit-learn.org/stable/api/index.html).
75
+ - Support [scipy](https://docs.scipy.org/doc/scipy/reference/index.html).
76
+ - Support [semver](https://python-semver.readthedocs.io/en/latest/).
77
+ - Support [setuptools](https://setuptools.pypa.io/en/latest/).
78
+ - Support [six](https://six.readthedocs.io/).
79
+ - Support [sniffio](https://sniffio.readthedocs.io/en/latest/).
80
+ - Support [sqlalchemy](https://docs.sqlalchemy.org/en/20/).
81
+ - Support [tomlkit](https://tomlkit.readthedocs.io/en/latest/).
82
+ - Support [torch](https://docs.pytorch.org/docs/stable/index.html).
83
+ - Support [tox](https://tox.wiki/en/stable/).
84
+ - Support [trio](https://trio.readthedocs.io/en/stable/).
85
+ - Support [typing-extensions](https://typing-extensions.readthedocs.io/en/latest/).
86
+ - Support [werkzeug](https://werkzeug.palletsprojects.com/en/stable/).
87
+ - Support [wrapt](https://wrapt.readthedocs.io/en/master/).
88
+ - Support [yarl](https://yarl.aio-libs.org/en/latest/).
89
+
90
+ ## v2025.4
91
+
92
+ - Fix a bug in the crawler where relative paths aren't joined correctly.
93
+ - Support [pandas](https://pandas.pydata.org/docs/reference/index.html).
94
+ - Support [python-dateutil](https://dateutil.readthedocs.io/en/stable/).
95
+ - Support [requests](https://requests.readthedocs.io/en/latest/).
96
+ - Support [urllib3](https://urllib3.readthedocs.io/en/stable/reference/index.html).
97
+
98
+ ## v2025.3
99
+
100
+ - Support [numpy](https://numpy.org/doc/stable/reference/index.html).
101
+
102
+ ## v2025.2
103
+
104
+ - Added a new `pyrefdev-indexer` CLI to `crawl-docs` and `parse-docs`. The `mapping.py` is now reproducible and easily updatable when Python 3.14 is released.
105
+ - Update the mappings.
106
+
107
+ ## v2025.1
108
+
109
+ Initial release.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pyrefdev
3
- Version: 2025.3
3
+ Version: 2025.5
4
4
  Summary: The entry point to Python reference docs
5
5
  Project-URL: Home, https://pyref.dev
6
6
  Project-URL: Source, https://github.com/mangoumbrella/pyref.dev
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3.14
22
22
  Classifier: Programming Language :: Python :: Free Threading
23
23
  Classifier: Topic :: Documentation
24
24
  Requires-Python: >=3.10
25
+ Requires-Dist: packaging>=25.0
25
26
  Requires-Dist: yib>=0.2.0
26
27
  Provides-Extra: indexer
27
28
  Requires-Dist: beautifulsoup4>=4.13.4; extra == 'indexer'
@@ -42,7 +43,7 @@ Description-Content-Type: text/markdown
42
43
  <a href="https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/pyrefdev.svg"></a>
43
44
  </p>
44
45
 
45
- It allows you to quickly jump to the official documentation for any Python standard library module, class, or function by using a simple URL pattern:
46
+ It allows you to quickly jump to the official documentation for Python standard library modules and popular packages by using a simple URL pattern:
46
47
 
47
48
  ```
48
49
  https://pyref.dev/<fully.qualified.symbol.name>
@@ -55,10 +56,17 @@ Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI
55
56
  * https://pyref.dev/json
56
57
  * https://pyref.dev/pathlib.Path
57
58
  * https://pyref.dev/datetime.datetime.strftime
59
+ * https://pyref.dev/numpy.array
58
60
 
59
- For now, the symbols are case-insensitive.
61
+ ## Supported packages
60
62
 
61
- ## Server Setup
63
+ See [pyref.dev](https://pyref.dev/#supported-packages) for the list of supported packages.
64
+
65
+ # Case sensitivity
66
+
67
+ For most of the cases, they are case-insensitive. However, for symbols like `typing.final` and `typing.Final`, you need to access them with the correct case.
68
+
69
+ ## Server setup
62
70
 
63
71
  To set up a new server:
64
72
 
@@ -8,7 +8,7 @@
8
8
  <a href="https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/pyrefdev.svg"></a>
9
9
  </p>
10
10
 
11
- It allows you to quickly jump to the official documentation for any Python standard library module, class, or function by using a simple URL pattern:
11
+ It allows you to quickly jump to the official documentation for Python standard library modules and popular packages by using a simple URL pattern:
12
12
 
13
13
  ```
14
14
  https://pyref.dev/<fully.qualified.symbol.name>
@@ -21,10 +21,17 @@ Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI
21
21
  * https://pyref.dev/json
22
22
  * https://pyref.dev/pathlib.Path
23
23
  * https://pyref.dev/datetime.datetime.strftime
24
+ * https://pyref.dev/numpy.array
24
25
 
25
- For now, the symbols are case-insensitive.
26
+ ## Supported packages
26
27
 
27
- ## Server Setup
28
+ See [pyref.dev](https://pyref.dev/#supported-packages) for the list of supported packages.
29
+
30
+ # Case sensitivity
31
+
32
+ For most of the cases, they are case-insensitive. However, for symbols like `typing.final` and `typing.Final`, you need to access them with the correct case.
33
+
34
+ ## Server setup
28
35
 
29
36
  To set up a new server:
30
37