prefxpy 0.1.3__tar.gz

prefxpy-0.1.3/.gitignore

@@ -0,0 +1,38 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+dist/
+*.egg-info/
+.eggs/
+*.egg
+pip-wheel-metadata/
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# Test / lint caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+
+# Editors
+.idea/
+.vscode/
+*.swp
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Local dev notes (not for the public repo)
+PathGuardの仕様書.md
+アプリ名：PrefxPy にする

prefxpy-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 kushi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

prefxpy-0.1.3/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: prefxpy
+Version: 0.1.3
+Summary: Local dev reverse proxy to reproduce production prefix and forwarded-header behavior.
+Project-URL: Homepage, https://github.com/smyrk2031/prefxpy
+Project-URL: Documentation, https://smyrk2031.github.io/prefxpy/
+Project-URL: Repository, https://github.com/smyrk2031/prefxpy
+Project-URL: Issues, https://github.com/smyrk2031/prefxpy/issues
+Author: kushi
+License: MIT
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Keywords: django,fastapi,flask,proxy,reverse-proxy,subpath
+Requires-Python: >=3.10
+Requires-Dist: aiohttp>=3.10.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: tomli>=2.0.1; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# PrefxPy
+
+[![CI](https://github.com/smyrk2031/prefxpy/actions/workflows/ci.yml/badge.svg)](https://github.com/smyrk2031/prefxpy/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/prefxpy)](https://pypi.org/project/prefxpy/)
+[![Python](https://img.shields.io/pypi/pyversions/prefxpy)](https://pypi.org/project/prefxpy/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+A small local reverse proxy for reproducing **production subpath / reverse-proxy issues** during development.
+
+Works well when your app behaves differently behind a path prefix (e.g. `/myapp/`) or with `X-Forwarded-*` headers — problems that often only show up in staging or production.
+
+**Not** a high-performance production proxy. Use it for local verification with FastAPI, Django, Flask, and similar stacks.
+
+## Install
+
+```bash
+pip install prefxpy
+```
+
+## Quick start
+
+```bash
+prefxpy
+```
+
+Defaults:
+
+- Public URL: `http://127.0.0.1:9000/myapp/`
+- Upstream: `http://127.0.0.1:8000`
+
+Another upstream port:
+
+```bash
+prefxpy --target http://127.0.0.1:5000
+```
+
+On startup, PrefxPy prints the **URL to open** in your browser.
+
+## Config file
+
+```bash
+prefxpy --config prefxpy.toml
+```
+
+See [`examples/prefxpy.example.toml`](examples/prefxpy.example.toml) for a sample. CLI flags override file values when set.
+
+By default PrefxPy sets these forwarded headers on upstream requests:
+
+- `X-Forwarded-Host`
+- `X-Forwarded-Proto`
+- `X-Forwarded-Prefix`
+- `X-Forwarded-For`
+
+## Development
+
+```bash
+git clone https://github.com/smyrk2031/prefxpy.git
+cd prefxpy
+pip install -e ".[dev]"
+pytest
+```
+
+Publishing to TestPyPI / PyPI: [`docs/PYPI.md`](docs/PYPI.md).
+
+## Documentation
+
+| Language | Topic |
+|----------|-------|
+| 日本語 | [仕様](docs/仕様.md) · [設計](docs/設計.md) |
+| English | This README · [Project site](https://smyrk2031.github.io/prefxpy/) |
+
+## License
+
+PrefxPy is released under the [MIT License](LICENSE).
+
+Third-party licenses for runtime dependencies (aiohttp, httpx, etc.) are listed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

prefxpy-0.1.3/README.md

@@ -0,0 +1,76 @@
+# PrefxPy
+
+[![CI](https://github.com/smyrk2031/prefxpy/actions/workflows/ci.yml/badge.svg)](https://github.com/smyrk2031/prefxpy/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/prefxpy)](https://pypi.org/project/prefxpy/)
+[![Python](https://img.shields.io/pypi/pyversions/prefxpy)](https://pypi.org/project/prefxpy/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+A small local reverse proxy for reproducing **production subpath / reverse-proxy issues** during development.
+
+Works well when your app behaves differently behind a path prefix (e.g. `/myapp/`) or with `X-Forwarded-*` headers — problems that often only show up in staging or production.
+
+**Not** a high-performance production proxy. Use it for local verification with FastAPI, Django, Flask, and similar stacks.
+
+## Install
+
+```bash
+pip install prefxpy
+```
+
+## Quick start
+
+```bash
+prefxpy
+```
+
+Defaults:
+
+- Public URL: `http://127.0.0.1:9000/myapp/`
+- Upstream: `http://127.0.0.1:8000`
+
+Another upstream port:
+
+```bash
+prefxpy --target http://127.0.0.1:5000
+```
+
+On startup, PrefxPy prints the **URL to open** in your browser.
+
+## Config file
+
+```bash
+prefxpy --config prefxpy.toml
+```
+
+See [`examples/prefxpy.example.toml`](examples/prefxpy.example.toml) for a sample. CLI flags override file values when set.
+
+By default PrefxPy sets these forwarded headers on upstream requests:
+
+- `X-Forwarded-Host`
+- `X-Forwarded-Proto`
+- `X-Forwarded-Prefix`
+- `X-Forwarded-For`
+
+## Development
+
+```bash
+git clone https://github.com/smyrk2031/prefxpy.git
+cd prefxpy
+pip install -e ".[dev]"
+pytest
+```
+
+Publishing to TestPyPI / PyPI: [`docs/PYPI.md`](docs/PYPI.md).
+
+## Documentation
+
+| Language | Topic |
+|----------|-------|
+| 日本語 | [仕様](docs/仕様.md) · [設計](docs/設計.md) |
+| English | This README · [Project site](https://smyrk2031.github.io/prefxpy/) |
+
+## License
+
+PrefxPy is released under the [MIT License](LICENSE).
+
+Third-party licenses for runtime dependencies (aiohttp, httpx, etc.) are listed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

prefxpy-0.1.3/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,78 @@
+# Third-Party Notices
+
+PrefxPy (prefxpy) is licensed under the MIT License. See [LICENSE](LICENSE).
+
+This product bundles or depends on the following third-party software.
+When you install `prefxpy` from PyPI, `pip` may also install transitive
+dependencies required by the packages below.
+
+## Runtime dependencies (installed with `pip install prefxpy`)
+
+| Package | License | Project |
+|---------|---------|---------|
+| aiohttp | Apache License 2.0 | https://github.com/aio-libs/aiohttp |
+| httpx | BSD 3-Clause License | https://github.com/encode/httpx |
+| tomli (Python 3.10 only) | MIT License | https://github.com/hukkin/tomli |
+
+Python 3.11 and later use the standard library module `tomllib` instead of
+`tomli`.
+
+### Apache License 2.0 (aiohttp)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+### BSD 3-Clause License (httpx)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+## Development dependencies (optional, `pip install prefxpy[dev]`)
+
+These packages are used for tests and linting only. They are **not** required
+to run the `prefxpy` command in production or local use.
+
+| Package | License | Project |
+|---------|---------|---------|
+| pytest | MIT License | https://github.com/pytest-dev/pytest |
+| pytest-asyncio | Apache License 2.0 | https://github.com/pytest-dev/pytest-asyncio |
+| ruff | MIT License | https://github.com/astral-sh/ruff |
+
+## Notes
+
+- License texts above are summaries for convenience. The authoritative license
+  for each dependency is included in that package's installation metadata and
+  source repository.
+- If your organization requires a full compliance review, obtain the complete
+  license files from each installed package (for example under
+  `site-packages/` after installation).

prefxpy-0.1.3/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["hatchling>=1.25.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "prefxpy"
+version = "0.1.3"
+description = "Local dev reverse proxy to reproduce production prefix and forwarded-header behavior."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+license-files = ["LICENSE", "THIRD_PARTY_NOTICES.md"]
+authors = [{ name = "kushi" }]
+keywords = ["proxy", "reverse-proxy", "subpath", "fastapi", "django", "flask"]
+dependencies = [
+  "aiohttp>=3.10.0",
+  "httpx>=0.27.0",
+  "tomli>=2.0.1; python_version < '3.11'",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.3.0",
+  "pytest-asyncio>=0.24.0",
+  "ruff>=0.8.0",
+]
+
+[project.scripts]
+prefxpy = "prefxpy.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/smyrk2031/prefxpy"
+Documentation = "https://smyrk2031.github.io/prefxpy/"
+Repository = "https://github.com/smyrk2031/prefxpy"
+Issues = "https://github.com/smyrk2031/prefxpy/issues"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/LICENSE",
+  "/THIRD_PARTY_NOTICES.md",
+]
+
+[tool.hatch.build.targets.wheel.force-include]
+"LICENSE" = "LICENSE"
+"THIRD_PARTY_NOTICES.md" = "THIRD_PARTY_NOTICES.md"