pyrefdev 2025.1__tar.gz → 2025.3__tar.gz

pyrefdev-2025.3/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions: {}
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.13t"
+          - "3.14"
+          - "3.14t"
+    steps:
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Build pyrefdev
+        run: uv sync --locked --dev
+      - name: Run pytest
+        run: uv run pytest

pyrefdev-2025.3/.github/workflows/pypi_upload.yml

@@ -0,0 +1,42 @@
+name: Publish on PyPI
+
+on:
+  release:
+    types: [published]
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyrefdev
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    if: github.event_name == 'release'
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '*'
+
+    - name: Install latest pip, build
+      run: |
+        python -m pip install --upgrade --disable-pip-version-check pip
+        python -m pip install --upgrade build
+
+    - name: Build package
+      run: python -m build
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

pyrefdev-2025.3/.gitignore

@@ -0,0 +1,177 @@
+# Hatch-managed version file
+src/pyrefdev/_version.py
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

pyrefdev-2025.3/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [Unreleased]
+
+Nothing noticeable unreleased.
+
+## v2025.1
+
+Initial release.

{pyrefdev-2025.1 → pyrefdev-2025.3}/PKG-INFO

@@ -1,35 +1,47 @@
 Metadata-Version: 2.4
 Name: pyrefdev
-Version: 2025.1
+Version: 2025.3
 Summary: The entry point to Python reference docs
-Keywords: documentation
+Project-URL: Home, https://pyref.dev
+Project-URL: Source, https://github.com/mangoumbrella/pyref.dev
 Author-email: Mango Umbrella LLC <hi@mangoumbrella.com>
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
 License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: documentation
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading
 Classifier: Topic :: Documentation
-License-File: LICENSE
-Requires-Dist: uvicorn[standard]>=0.34.2,<1 ; extra == "server"
-Requires-Dist: fastapi>=0.115.12,<1 ; extra == "server"
-Project-URL: Home, https://pyref.dev
-Project-URL: Source, https://github.com/mangoumbrella/pyref.dev
+Requires-Python: >=3.10
+Requires-Dist: yib>=0.2.0
+Provides-Extra: indexer
+Requires-Dist: beautifulsoup4>=4.13.4; extra == 'indexer'
+Requires-Dist: cyclopts>=3.19.0; extra == 'indexer'
+Requires-Dist: rich>=14.0.0; extra == 'indexer'
 Provides-Extra: server
+Requires-Dist: fastapi<1,>=0.115.12; extra == 'server'
+Requires-Dist: uvicorn[standard]<1,>=0.34.2; extra == 'server'
+Description-Content-Type: text/markdown
 
 # pyref.dev
 
 [pyref.dev](https://pyref.dev) is a fast, convenient way to access Python reference docs.
 
+<p>
+<a href="https://pypi.org/project/pyrefdev"><img alt="PyPI" src="https://img.shields.io/pypi/v/pyrefdev"></a>
+<a href="https://pypi.org/project/pyrefdev"><img alt="Python veresions supported" src="https://img.shields.io/pypi/pyversions/pyrefdev"></a>
+<a href="https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/pyrefdev.svg"></a>
+</p>
+
 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,7 +58,30 @@ Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI
 
 For now, the symbols are case-insensitive.
 
-## License
+## Server Setup
+
+To set up a new server:
+
+```bash
+> git clone https://github.com/mangoumbrella/pyref.dev
+> cd pyref.dev
+> sudo cp pyrefdev.service /etc/systemd/system/pyrefdev.service
+> systemctl start pyrefdev.service
+```
+
+To update to a new version:
 
-[pyref.dev](https://pyref.dev) is licensed under the terms of the Apache license. See [LICENSE](LICENSE) for more information.
+```bash
+> cd pyref.dev
+> git pull
+> uv sync --all-extras
+> systemctl restart pyrefdev.service
+```
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md).
+
+## License
 
+[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.

pyrefdev-2025.3/README.md

@@ -0,0 +1,53 @@
+# pyref.dev
+
+[pyref.dev](https://pyref.dev) is a fast, convenient way to access Python reference docs.
+
+<p>
+<a href="https://pypi.org/project/pyrefdev"><img alt="PyPI" src="https://img.shields.io/pypi/v/pyrefdev"></a>
+<a href="https://pypi.org/project/pyrefdev"><img alt="Python veresions supported" src="https://img.shields.io/pypi/pyversions/pyrefdev"></a>
+<a href="https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/pyrefdev.svg"></a>
+</p>
+
+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:
+
+```
+https://pyref.dev/<fully.qualified.symbol.name>
+```
+
+Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI tool.
+
+## Examples
+
+* https://pyref.dev/json
+* https://pyref.dev/pathlib.Path
+* https://pyref.dev/datetime.datetime.strftime
+
+For now, the symbols are case-insensitive.
+
+## Server Setup
+
+To set up a new server:
+
+```bash
+> git clone https://github.com/mangoumbrella/pyref.dev
+> cd pyref.dev
+> sudo cp pyrefdev.service /etc/systemd/system/pyrefdev.service
+> systemctl start pyrefdev.service
+```
+
+To update to a new version:
+
+```bash
+> cd pyref.dev
+> git pull
+> uv sync --all-extras
+> systemctl restart pyrefdev.service
+```
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md).
+
+## License
+
+[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.