pyrefdev 2025.1__tar.gz → 2025.2__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.
- pyrefdev-2025.2/.github/workflows/pypi_upload.yml +42 -0
- pyrefdev-2025.2/.gitignore +177 -0
- pyrefdev-2025.2/CHANGELOG.md +9 -0
- {pyrefdev-2025.1 → pyrefdev-2025.2}/PKG-INFO +26 -12
- {pyrefdev-2025.1 → pyrefdev-2025.2}/README.md +11 -1
- pyrefdev-2025.2/index.html +298 -0
- {pyrefdev-2025.1 → pyrefdev-2025.2}/pyproject.toml +20 -4
- pyrefdev-2025.2/pyrefdev.service +16 -0
- {pyrefdev-2025.1 → pyrefdev-2025.2/src}/pyrefdev/__init__.py +5 -0
- pyrefdev-2025.2/src/pyrefdev/_version.py +1 -0
- pyrefdev-2025.2/src/pyrefdev/indexer/__main__.py +20 -0
- pyrefdev-2025.2/src/pyrefdev/indexer/config.py +9 -0
- pyrefdev-2025.2/src/pyrefdev/indexer/crawl_docs.py +167 -0
- pyrefdev-2025.2/src/pyrefdev/indexer/parse_docs.py +263 -0
- {pyrefdev-2025.1 → pyrefdev-2025.2/src}/pyrefdev/mapping.py +1284 -1031
- {pyrefdev-2025.1 → pyrefdev-2025.2/src}/pyrefdev/server.py +0 -2
- pyrefdev-2025.2/uv.lock +750 -0
- {pyrefdev-2025.1 → pyrefdev-2025.2}/LICENSE +0 -0
- {pyrefdev-2025.1 → pyrefdev-2025.2/src}/pyrefdev/__main__.py +0 -0
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
name: Publish on PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
pull_request:
|
|
7
|
+
push:
|
|
8
|
+
branches:
|
|
9
|
+
- main
|
|
10
|
+
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
|
|
14
|
+
jobs:
|
|
15
|
+
pypi-publish:
|
|
16
|
+
name: Upload release to PyPI
|
|
17
|
+
runs-on: ubuntu-latest
|
|
18
|
+
environment:
|
|
19
|
+
name: pypi
|
|
20
|
+
url: https://pypi.org/p/pyrefdev
|
|
21
|
+
permissions:
|
|
22
|
+
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
|
|
23
|
+
if: github.event_name == 'release'
|
|
24
|
+
|
|
25
|
+
steps:
|
|
26
|
+
- uses: actions/checkout@v4
|
|
27
|
+
|
|
28
|
+
- name: Set up Python
|
|
29
|
+
uses: actions/setup-python@v5
|
|
30
|
+
with:
|
|
31
|
+
python-version: '*'
|
|
32
|
+
|
|
33
|
+
- name: Install latest pip, build
|
|
34
|
+
run: |
|
|
35
|
+
python -m pip install --upgrade --disable-pip-version-check pip
|
|
36
|
+
python -m pip install --upgrade build
|
|
37
|
+
|
|
38
|
+
- name: Build package
|
|
39
|
+
run: python -m build
|
|
40
|
+
|
|
41
|
+
- name: Publish package distributions to PyPI
|
|
42
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# Hatch-managed version file
|
|
2
|
+
src/pyrefdev/_version.py
|
|
3
|
+
|
|
4
|
+
# Byte-compiled / optimized / DLL files
|
|
5
|
+
__pycache__/
|
|
6
|
+
*.py[cod]
|
|
7
|
+
*$py.class
|
|
8
|
+
|
|
9
|
+
# C extensions
|
|
10
|
+
*.so
|
|
11
|
+
|
|
12
|
+
# Distribution / packaging
|
|
13
|
+
.Python
|
|
14
|
+
build/
|
|
15
|
+
develop-eggs/
|
|
16
|
+
dist/
|
|
17
|
+
downloads/
|
|
18
|
+
eggs/
|
|
19
|
+
.eggs/
|
|
20
|
+
lib/
|
|
21
|
+
lib64/
|
|
22
|
+
parts/
|
|
23
|
+
sdist/
|
|
24
|
+
var/
|
|
25
|
+
wheels/
|
|
26
|
+
share/python-wheels/
|
|
27
|
+
*.egg-info/
|
|
28
|
+
.installed.cfg
|
|
29
|
+
*.egg
|
|
30
|
+
MANIFEST
|
|
31
|
+
|
|
32
|
+
# PyInstaller
|
|
33
|
+
# Usually these files are written by a python script from a template
|
|
34
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
35
|
+
*.manifest
|
|
36
|
+
*.spec
|
|
37
|
+
|
|
38
|
+
# Installer logs
|
|
39
|
+
pip-log.txt
|
|
40
|
+
pip-delete-this-directory.txt
|
|
41
|
+
|
|
42
|
+
# Unit test / coverage reports
|
|
43
|
+
htmlcov/
|
|
44
|
+
.tox/
|
|
45
|
+
.nox/
|
|
46
|
+
.coverage
|
|
47
|
+
.coverage.*
|
|
48
|
+
.cache
|
|
49
|
+
nosetests.xml
|
|
50
|
+
coverage.xml
|
|
51
|
+
*.cover
|
|
52
|
+
*.py,cover
|
|
53
|
+
.hypothesis/
|
|
54
|
+
.pytest_cache/
|
|
55
|
+
cover/
|
|
56
|
+
|
|
57
|
+
# Translations
|
|
58
|
+
*.mo
|
|
59
|
+
*.pot
|
|
60
|
+
|
|
61
|
+
# Django stuff:
|
|
62
|
+
*.log
|
|
63
|
+
local_settings.py
|
|
64
|
+
db.sqlite3
|
|
65
|
+
db.sqlite3-journal
|
|
66
|
+
|
|
67
|
+
# Flask stuff:
|
|
68
|
+
instance/
|
|
69
|
+
.webassets-cache
|
|
70
|
+
|
|
71
|
+
# Scrapy stuff:
|
|
72
|
+
.scrapy
|
|
73
|
+
|
|
74
|
+
# Sphinx documentation
|
|
75
|
+
docs/_build/
|
|
76
|
+
|
|
77
|
+
# PyBuilder
|
|
78
|
+
.pybuilder/
|
|
79
|
+
target/
|
|
80
|
+
|
|
81
|
+
# Jupyter Notebook
|
|
82
|
+
.ipynb_checkpoints
|
|
83
|
+
|
|
84
|
+
# IPython
|
|
85
|
+
profile_default/
|
|
86
|
+
ipython_config.py
|
|
87
|
+
|
|
88
|
+
# pyenv
|
|
89
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
90
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
91
|
+
# .python-version
|
|
92
|
+
|
|
93
|
+
# pipenv
|
|
94
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
95
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
96
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
97
|
+
# install all needed dependencies.
|
|
98
|
+
#Pipfile.lock
|
|
99
|
+
|
|
100
|
+
# UV
|
|
101
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
102
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
103
|
+
# commonly ignored for libraries.
|
|
104
|
+
#uv.lock
|
|
105
|
+
|
|
106
|
+
# poetry
|
|
107
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
108
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
109
|
+
# commonly ignored for libraries.
|
|
110
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
111
|
+
#poetry.lock
|
|
112
|
+
|
|
113
|
+
# pdm
|
|
114
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
115
|
+
#pdm.lock
|
|
116
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
117
|
+
# in version control.
|
|
118
|
+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
|
119
|
+
.pdm.toml
|
|
120
|
+
.pdm-python
|
|
121
|
+
.pdm-build/
|
|
122
|
+
|
|
123
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
124
|
+
__pypackages__/
|
|
125
|
+
|
|
126
|
+
# Celery stuff
|
|
127
|
+
celerybeat-schedule
|
|
128
|
+
celerybeat.pid
|
|
129
|
+
|
|
130
|
+
# SageMath parsed files
|
|
131
|
+
*.sage.py
|
|
132
|
+
|
|
133
|
+
# Environments
|
|
134
|
+
.env
|
|
135
|
+
.venv
|
|
136
|
+
env/
|
|
137
|
+
venv/
|
|
138
|
+
ENV/
|
|
139
|
+
env.bak/
|
|
140
|
+
venv.bak/
|
|
141
|
+
|
|
142
|
+
# Spyder project settings
|
|
143
|
+
.spyderproject
|
|
144
|
+
.spyproject
|
|
145
|
+
|
|
146
|
+
# Rope project settings
|
|
147
|
+
.ropeproject
|
|
148
|
+
|
|
149
|
+
# mkdocs documentation
|
|
150
|
+
/site
|
|
151
|
+
|
|
152
|
+
# mypy
|
|
153
|
+
.mypy_cache/
|
|
154
|
+
.dmypy.json
|
|
155
|
+
dmypy.json
|
|
156
|
+
|
|
157
|
+
# Pyre type checker
|
|
158
|
+
.pyre/
|
|
159
|
+
|
|
160
|
+
# pytype static type analyzer
|
|
161
|
+
.pytype/
|
|
162
|
+
|
|
163
|
+
# Cython debug symbols
|
|
164
|
+
cython_debug/
|
|
165
|
+
|
|
166
|
+
# PyCharm
|
|
167
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
168
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
169
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
170
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
171
|
+
#.idea/
|
|
172
|
+
|
|
173
|
+
# Ruff stuff:
|
|
174
|
+
.ruff_cache/
|
|
175
|
+
|
|
176
|
+
# PyPI configuration file
|
|
177
|
+
.pypirc
|
|
@@ -1,35 +1,46 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: pyrefdev
|
|
3
|
-
Version: 2025.
|
|
3
|
+
Version: 2025.2
|
|
4
4
|
Summary: The entry point to Python reference docs
|
|
5
|
-
|
|
5
|
+
Project-URL: Home, https://pyref.dev
|
|
6
|
+
Project-URL: Source, https://github.com/mangoumbrella/pyref.dev
|
|
6
7
|
Author-email: Mango Umbrella LLC <hi@mangoumbrella.com>
|
|
7
|
-
Requires-Python: >=3.9
|
|
8
|
-
Description-Content-Type: text/markdown
|
|
9
8
|
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: documentation
|
|
10
11
|
Classifier: Development Status :: 4 - Beta
|
|
11
12
|
Classifier: Environment :: Console
|
|
12
13
|
Classifier: Intended Audience :: Developers
|
|
13
14
|
Classifier: Operating System :: OS Independent
|
|
14
15
|
Classifier: Programming Language :: Python
|
|
16
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
15
17
|
Classifier: Programming Language :: Python :: 3.9
|
|
16
18
|
Classifier: Programming Language :: Python :: 3.10
|
|
17
19
|
Classifier: Programming Language :: Python :: 3.11
|
|
18
20
|
Classifier: Programming Language :: Python :: 3.12
|
|
19
21
|
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
-
Classifier: Programming Language :: Python :: 3 :: Only
|
|
21
22
|
Classifier: Topic :: Documentation
|
|
22
|
-
|
|
23
|
-
Requires-Dist:
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
23
|
+
Requires-Python: >=3.10
|
|
24
|
+
Requires-Dist: yib>=0.2.0
|
|
25
|
+
Provides-Extra: indexer
|
|
26
|
+
Requires-Dist: beautifulsoup4>=4.13.4; extra == 'indexer'
|
|
27
|
+
Requires-Dist: cyclopts>=3.19.0; extra == 'indexer'
|
|
28
|
+
Requires-Dist: rich>=14.0.0; extra == 'indexer'
|
|
27
29
|
Provides-Extra: server
|
|
30
|
+
Requires-Dist: fastapi<1,>=0.115.12; extra == 'server'
|
|
31
|
+
Requires-Dist: uvicorn[standard]<1,>=0.34.2; extra == 'server'
|
|
32
|
+
Description-Content-Type: text/markdown
|
|
28
33
|
|
|
29
34
|
# pyref.dev
|
|
30
35
|
|
|
31
36
|
[pyref.dev](https://pyref.dev) is a fast, convenient way to access Python reference docs.
|
|
32
37
|
|
|
38
|
+
<p>
|
|
39
|
+
<a href="https://pypi.org/project/pyrefdev"><img alt="PyPI" src="https://img.shields.io/pypi/v/pyrefdev"></a>
|
|
40
|
+
<a href="https://pypi.org/project/pyrefdev"><img alt="Python veresions supported" src="https://img.shields.io/pypi/pyversions/pyrefdev"></a>
|
|
41
|
+
<a href="https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/pyrefdev.svg"></a>
|
|
42
|
+
</p>
|
|
43
|
+
|
|
33
44
|
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:
|
|
34
45
|
|
|
35
46
|
```
|
|
@@ -46,7 +57,10 @@ Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI
|
|
|
46
57
|
|
|
47
58
|
For now, the symbols are case-insensitive.
|
|
48
59
|
|
|
49
|
-
##
|
|
60
|
+
## Changelog
|
|
50
61
|
|
|
51
|
-
[
|
|
62
|
+
See [CHANGELOG.md](https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md).
|
|
63
|
+
|
|
64
|
+
## License
|
|
52
65
|
|
|
66
|
+
[pyref.dev](https://pyref.dev) is licensed under the terms of the Apache license. See [LICENSE](https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE) for more information.
|
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
[pyref.dev](https://pyref.dev) is a fast, convenient way to access Python reference docs.
|
|
4
4
|
|
|
5
|
+
<p>
|
|
6
|
+
<a href="https://pypi.org/project/pyrefdev"><img alt="PyPI" src="https://img.shields.io/pypi/v/pyrefdev"></a>
|
|
7
|
+
<a href="https://pypi.org/project/pyrefdev"><img alt="Python veresions supported" src="https://img.shields.io/pypi/pyversions/pyrefdev"></a>
|
|
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
|
+
</p>
|
|
10
|
+
|
|
5
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:
|
|
6
12
|
|
|
7
13
|
```
|
|
@@ -18,6 +24,10 @@ Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI
|
|
|
18
24
|
|
|
19
25
|
For now, the symbols are case-insensitive.
|
|
20
26
|
|
|
27
|
+
## Changelog
|
|
28
|
+
|
|
29
|
+
See [CHANGELOG.md](https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md).
|
|
30
|
+
|
|
21
31
|
## License
|
|
22
32
|
|
|
23
|
-
[pyref.dev](https://pyref.dev) is licensed under the terms of the Apache license. See [LICENSE](LICENSE) for more information.
|
|
33
|
+
[pyref.dev](https://pyref.dev) is licensed under the terms of the Apache license. See [LICENSE](https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE) for more information.
|
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>pyref.dev - Python Reference Docs</title>
|
|
7
|
+
<style>
|
|
8
|
+
:root {
|
|
9
|
+
--python-blue: #306998;
|
|
10
|
+
--python-yellow: #ffd43b;
|
|
11
|
+
--python-green: #3c873a;
|
|
12
|
+
--dark: #222;
|
|
13
|
+
--light: #f8f9fa;
|
|
14
|
+
--gray-100: #f0f0f0;
|
|
15
|
+
--gray-200: #e9ecef;
|
|
16
|
+
--gray-300: #dee2e6;
|
|
17
|
+
--gray-600: #6c757d;
|
|
18
|
+
--font-sans: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif;
|
|
19
|
+
--font-mono: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
|
20
|
+
--shadow-sm: 0 2px 4px rgba(0,0,0,0.05);
|
|
21
|
+
--shadow-md: 0 4px 6px rgba(0,0,0,0.1);
|
|
22
|
+
--shadow-lg: 0 10px 15px rgba(0,0,0,0.1);
|
|
23
|
+
--header-height: 60px;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
* {
|
|
27
|
+
margin: 0;
|
|
28
|
+
padding: 0;
|
|
29
|
+
box-sizing: border-box;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
body {
|
|
33
|
+
font-family: var(--font-sans);
|
|
34
|
+
background: var(--light);
|
|
35
|
+
color: var(--dark);
|
|
36
|
+
min-height: 100vh;
|
|
37
|
+
display: flex;
|
|
38
|
+
flex-direction: column;
|
|
39
|
+
line-height: 1.6;
|
|
40
|
+
position: relative;
|
|
41
|
+
padding-top: var(--header-height);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
.header {
|
|
45
|
+
position: fixed;
|
|
46
|
+
top: 0;
|
|
47
|
+
left: 0;
|
|
48
|
+
right: 0;
|
|
49
|
+
height: var(--header-height);
|
|
50
|
+
/* background-color: white; */
|
|
51
|
+
/* box-shadow: var(--shadow-sm); */
|
|
52
|
+
z-index: 100;
|
|
53
|
+
display: flex;
|
|
54
|
+
justify-content: flex-end;
|
|
55
|
+
align-items: center;
|
|
56
|
+
padding: 0 1.5rem;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
.container {
|
|
60
|
+
width: 90%;
|
|
61
|
+
max-width: 800px;
|
|
62
|
+
text-align: center;
|
|
63
|
+
padding: 2rem 1.5rem;
|
|
64
|
+
margin: 0 auto;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
.logo {
|
|
68
|
+
margin-bottom: 2rem;
|
|
69
|
+
position: relative;
|
|
70
|
+
display: inline-block;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
.logo::before {
|
|
74
|
+
content: '';
|
|
75
|
+
position: absolute;
|
|
76
|
+
width: 60px;
|
|
77
|
+
height: 60px;
|
|
78
|
+
background-color: var(--python-yellow);
|
|
79
|
+
border-radius: 50%;
|
|
80
|
+
top: -15px;
|
|
81
|
+
left: -25px;
|
|
82
|
+
z-index: -1;
|
|
83
|
+
opacity: 0.6;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
h1 {
|
|
87
|
+
font-size: 3.5rem;
|
|
88
|
+
font-weight: 800;
|
|
89
|
+
margin-bottom: 1rem;
|
|
90
|
+
letter-spacing: -0.05em;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
h1 .py-blue {
|
|
94
|
+
color: var(--python-blue);
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
h1 .py-yellow {
|
|
98
|
+
color: var(--python-yellow);
|
|
99
|
+
position: relative;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
.tagline {
|
|
103
|
+
font-size: 1.4rem;
|
|
104
|
+
margin-bottom: 2.5rem;
|
|
105
|
+
color: var(--gray-600);
|
|
106
|
+
font-weight: 500;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
p {
|
|
110
|
+
font-size: 1.2rem;
|
|
111
|
+
margin-bottom: 2rem;
|
|
112
|
+
color: var(--gray-600);
|
|
113
|
+
max-width: 700px;
|
|
114
|
+
margin-left: auto;
|
|
115
|
+
margin-right: auto;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
.url-pattern {
|
|
119
|
+
display: inline-block;
|
|
120
|
+
padding: 1rem 1.5rem;
|
|
121
|
+
background-color: var(--gray-100);
|
|
122
|
+
border-radius: 8px;
|
|
123
|
+
font-family: var(--font-mono);
|
|
124
|
+
font-size: 1.1rem;
|
|
125
|
+
color: var(--python-blue);
|
|
126
|
+
border-left: 4px solid var(--python-yellow);
|
|
127
|
+
margin-bottom: 2rem;
|
|
128
|
+
box-shadow: var(--shadow-sm);
|
|
129
|
+
word-break: break-all;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
.examples-title {
|
|
133
|
+
font-weight: 600;
|
|
134
|
+
color: var(--dark);
|
|
135
|
+
margin-bottom: 1rem;
|
|
136
|
+
font-size: 1.3rem;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
.examples-list {
|
|
140
|
+
list-style: none;
|
|
141
|
+
background-color: white;
|
|
142
|
+
border-radius: 10px;
|
|
143
|
+
padding: 1.5rem;
|
|
144
|
+
margin-bottom: 2.5rem;
|
|
145
|
+
box-shadow: var(--shadow-md);
|
|
146
|
+
text-align: left;
|
|
147
|
+
width: 100%;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
.examples-list li {
|
|
151
|
+
margin-bottom: 1rem;
|
|
152
|
+
padding-bottom: 1rem;
|
|
153
|
+
border-bottom: 1px solid var(--gray-200);
|
|
154
|
+
position: relative;
|
|
155
|
+
padding-left: 1.5rem;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
.examples-list li::before {
|
|
159
|
+
content: '→';
|
|
160
|
+
position: absolute;
|
|
161
|
+
left: 0;
|
|
162
|
+
color: var(--python-green);
|
|
163
|
+
font-weight: bold;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
.examples-list li:last-child {
|
|
167
|
+
margin-bottom: 0;
|
|
168
|
+
padding-bottom: 0;
|
|
169
|
+
border-bottom: none;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
.examples-list a {
|
|
173
|
+
color: var(--python-blue);
|
|
174
|
+
text-decoration: none;
|
|
175
|
+
font-family: var(--font-mono);
|
|
176
|
+
font-size: 0.95rem;
|
|
177
|
+
transition: color 0.2s ease;
|
|
178
|
+
word-break: break-all;
|
|
179
|
+
display: inline-block;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
.examples-list a:hover {
|
|
183
|
+
text-decoration: underline;
|
|
184
|
+
color: var(--python-green);
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
.github-link {
|
|
188
|
+
display: inline-flex;
|
|
189
|
+
align-items: center;
|
|
190
|
+
background: var(--python-blue);
|
|
191
|
+
color: white;
|
|
192
|
+
padding: 0.6rem 1.2rem;
|
|
193
|
+
border-radius: 6px;
|
|
194
|
+
text-decoration: none;
|
|
195
|
+
font-weight: 600;
|
|
196
|
+
font-size: 0.9rem;
|
|
197
|
+
transition: all 0.3s ease;
|
|
198
|
+
border: 1px solid var(--python-blue);
|
|
199
|
+
box-shadow: var(--shadow-sm);
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
.github-link:hover {
|
|
203
|
+
background: white;
|
|
204
|
+
color: var(--python-blue);
|
|
205
|
+
transform: translateY(-1px);
|
|
206
|
+
box-shadow: var(--shadow-md);
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
.github-link svg {
|
|
210
|
+
margin-right: 0.5rem;
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
.footer {
|
|
214
|
+
margin-top: 3rem;
|
|
215
|
+
color: var(--gray-600);
|
|
216
|
+
font-size: 0.9rem;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
@media (max-width: 600px) {
|
|
220
|
+
h1 {
|
|
221
|
+
font-size: 2.8rem;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
.tagline {
|
|
225
|
+
font-size: 1.2rem;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
p {
|
|
229
|
+
font-size: 1.1rem;
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
.url-pattern {
|
|
233
|
+
font-size: 0.9rem;
|
|
234
|
+
padding: 0.8rem 1rem;
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
.logo::before {
|
|
238
|
+
width: 50px;
|
|
239
|
+
height: 50px;
|
|
240
|
+
top: -12px;
|
|
241
|
+
left: -20px;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
.examples-list {
|
|
245
|
+
padding: 1.2rem 1rem;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
.examples-list a {
|
|
249
|
+
font-size: 0.85rem;
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
.examples-list li {
|
|
253
|
+
padding-left: 1.2rem;
|
|
254
|
+
margin-bottom: 0.8rem;
|
|
255
|
+
padding-bottom: 0.8rem;
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
.github-link {
|
|
259
|
+
padding: 0.5rem 0.8rem;
|
|
260
|
+
font-size: 0.8rem;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
.github-link svg {
|
|
264
|
+
width: 18px;
|
|
265
|
+
height: 18px;
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
.header {
|
|
269
|
+
padding: 0 1rem;
|
|
270
|
+
}
|
|
271
|
+
}
|
|
272
|
+
</style>
|
|
273
|
+
</head>
|
|
274
|
+
<body>
|
|
275
|
+
<header class="header">
|
|
276
|
+
<a href="https://github.com/mangoumbrella/pyref.dev" class="github-link">
|
|
277
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
|
|
278
|
+
<path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path>
|
|
279
|
+
</svg>
|
|
280
|
+
View on GitHub
|
|
281
|
+
</a>
|
|
282
|
+
</header>
|
|
283
|
+
<div class="container">
|
|
284
|
+
<div class="logo">
|
|
285
|
+
<h1><span class="py-blue">pyref</span>.<span class="py-yellow">dev</span></h1>
|
|
286
|
+
</div>
|
|
287
|
+
<p class="tagline">A fast, convenient way to access Python reference docs.</p>
|
|
288
|
+
<p>Quickly jump to the official documentation for any Python standard library module, class, or function by using a simple URL pattern:</p>
|
|
289
|
+
<div class="url-pattern">https://pyref.dev/<fully.qualified.symbol.name></div>
|
|
290
|
+
<p class="examples-title">Examples</p>
|
|
291
|
+
<ul class="examples-list">
|
|
292
|
+
<li><a href="https://pyref.dev/json">https://pyref.dev/json</a></li>
|
|
293
|
+
<li><a href="https://pyref.dev/pathlib.Path">https://pyref.dev/pathlib.Path</a></li>
|
|
294
|
+
<li><a href="https://pyref.dev/datetime.datetime.strftime">https://pyref.dev/datetime.datetime.strftime</a></li>
|
|
295
|
+
</ul>
|
|
296
|
+
</div>
|
|
297
|
+
</body>
|
|
298
|
+
</html>
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
[build-system]
|
|
2
|
-
requires = ["
|
|
3
|
-
build-backend = "
|
|
2
|
+
requires = ["hatchling", "hatch-vcs"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "pyrefdev"
|
|
7
|
-
version = "2025.1"
|
|
8
7
|
description = "The entry point to Python reference docs"
|
|
9
8
|
authors = [
|
|
10
9
|
{name = "Mango Umbrella LLC", email = "hi@mangoumbrella.com"},
|
|
@@ -28,9 +27,11 @@ classifiers = [
|
|
|
28
27
|
keywords = [
|
|
29
28
|
"documentation",
|
|
30
29
|
]
|
|
31
|
-
requires-python = ">=3.
|
|
30
|
+
requires-python = ">=3.10"
|
|
32
31
|
dependencies = [
|
|
32
|
+
"yib>=0.2.0",
|
|
33
33
|
]
|
|
34
|
+
dynamic = ["version"]
|
|
34
35
|
|
|
35
36
|
[project.urls]
|
|
36
37
|
Home = "https://pyref.dev"
|
|
@@ -41,6 +42,21 @@ server = [
|
|
|
41
42
|
"uvicorn[standard]>=0.34.2,<1",
|
|
42
43
|
"fastapi>=0.115.12,<1",
|
|
43
44
|
]
|
|
45
|
+
indexer = [
|
|
46
|
+
"cyclopts>=3.19.0",
|
|
47
|
+
"rich>=14.0.0",
|
|
48
|
+
"Beautifulsoup4>=4.13.4",
|
|
49
|
+
]
|
|
44
50
|
|
|
45
51
|
[project.scripts]
|
|
46
52
|
pyrefdev = "pyrefdev.__main__:main"
|
|
53
|
+
pyrefdev-indexer = "pyrefdev.indexer.__main__:app"
|
|
54
|
+
|
|
55
|
+
[tool.hatch.version]
|
|
56
|
+
source = "vcs"
|
|
57
|
+
|
|
58
|
+
[tool.hatch.build.hooks.vcs]
|
|
59
|
+
version-file = "src/pyrefdev/_version.py"
|
|
60
|
+
template = '''
|
|
61
|
+
version = "{version}"
|
|
62
|
+
'''
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
[Unit]
|
|
2
|
+
Description=Web server for pyref.dev
|
|
3
|
+
After=network.target
|
|
4
|
+
|
|
5
|
+
[Service]
|
|
6
|
+
User=root
|
|
7
|
+
WorkingDirectory=/root/pyref.dev
|
|
8
|
+
ExecStart=/root/pyref.dev/.venv/bin/uvicorn pyrefdev.server:app --host=0.0.0.0 --port=80
|
|
9
|
+
Restart=always
|
|
10
|
+
RestartSec=5
|
|
11
|
+
StandardOutput=syslog
|
|
12
|
+
StandardError=syslog
|
|
13
|
+
SyslogIdentifier=pyref.dev
|
|
14
|
+
|
|
15
|
+
[Install]
|
|
16
|
+
WantedBy=multi-user.target
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
version = "2025.2"
|