Update repository references from 'encode' to 'Kludex' across documentation and configuration files (#2684)
This commit is contained in:
secrett2633
GitHub
parent
e6c7ce791f
commit
016db5f7da
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -2,7 +2,7 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Discussions
|
||||
url: https://github.com/encode/uvicorn/discussions
|
||||
url: https://github.com/Kludex/uvicorn/discussions
|
||||
about: The "Discussions" forum is where you want to start. 💖
|
||||
- name: Chat
|
||||
url: https://discord.com/invite/SWU73HffbV
|
||||
|
||||
@ -14,7 +14,7 @@ authors:
|
||||
- given-names: Tom
|
||||
family-names: Christie
|
||||
email: tom@tomchristie.com
|
||||
repository-code: 'https://github.com/encode/uvicorn'
|
||||
repository-code: 'https://github.com/Kludex/uvicorn'
|
||||
url: 'https://www.uvicorn.org/'
|
||||
abstract: Uvicorn is an ASGI web server implementation for Python.
|
||||
keywords:
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
---
|
||||
|
||||
[](https://github.com/encode/uvicorn/actions)
|
||||
[](https://github.com/Kludex/uvicorn/actions)
|
||||
[](https://pypi.python.org/pypi/uvicorn)
|
||||
[](https://pypi.org/project/uvicorn)
|
||||
|
||||
@ -137,7 +137,7 @@ $ hypercorn app:App
|
||||
|
||||
---
|
||||
|
||||
<p align="center"><i>Uvicorn is <a href="https://github.com/encode/uvicorn/blob/master/LICENSE.md">BSD licensed</a> code.<br/>Designed & crafted with care.</i><br/>— 🦄 —</p>
|
||||
<p align="center"><i>Uvicorn is <a href="https://github.com/Kludex/uvicorn/blob/master/LICENSE.md">BSD licensed</a> code.<br/>Designed & crafted with care.</i><br/>— 🦄 —</p>
|
||||
|
||||
[asgi]: https://asgi.readthedocs.io/en/latest/
|
||||
[daphne]: https://github.com/django/daphne
|
||||
|
||||
@ -229,7 +229,7 @@ For small services you can also write ASGI applications directly.
|
||||
|
||||
### Starlette
|
||||
|
||||
[Starlette](https://github.com/encode/starlette) is a lightweight ASGI framework/toolkit.
|
||||
[Starlette](https://github.com/Kludex/starlette) is a lightweight ASGI framework/toolkit.
|
||||
|
||||
It is ideal for building high performance asyncio services, and supports both HTTP and WebSockets.
|
||||
|
||||
|
||||
@ -3,9 +3,9 @@
|
||||
Thank you for being interested in contributing to Uvicorn.
|
||||
There are many ways you can contribute to the project:
|
||||
|
||||
- Using Uvicorn on your stack and [reporting bugs/issues you find](https://github.com/encode/uvicorn/issues/new)
|
||||
- [Implementing new features and fixing bugs](https://github.com/encode/uvicorn/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
|
||||
- [Review Pull Requests of others](https://github.com/encode/uvicorn/pulls)
|
||||
- Using Uvicorn on your stack and [reporting bugs/issues you find](https://github.com/Kludex/uvicorn/issues/new)
|
||||
- [Implementing new features and fixing bugs](https://github.com/Kludex/uvicorn/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
|
||||
- [Review Pull Requests of others](https://github.com/Kludex/uvicorn/pulls)
|
||||
- Write documentation
|
||||
- Participate in discussions
|
||||
|
||||
@ -17,7 +17,7 @@ Need a missing functionality?
|
||||
|
||||
Contributions should generally start out from a previous discussion.
|
||||
You can reach out someone at the [community chat](https://discord.com/invite/SWU73HffbV)
|
||||
or at the [github discussions tab](https://github.com/encode/uvicorn/discussions).
|
||||
or at the [github discussions tab](https://github.com/Kludex/uvicorn/discussions).
|
||||
|
||||
When creating a new topic in the discussions tab, possible bugs may be raised
|
||||
as a "Potential Issue" discussion, feature requests may be raised as an
|
||||
@ -45,7 +45,7 @@ Some possibly useful tips for narrowing down potential issues...
|
||||
## Development
|
||||
|
||||
To start developing Uvicorn create a **fork** of the
|
||||
[Uvicorn repository](https://github.com/encode/uvicorn) on GitHub.
|
||||
[Uvicorn repository](https://github.com/Kludex/uvicorn) on GitHub.
|
||||
|
||||
Then clone your fork with the following command replacing `YOUR-USERNAME` with
|
||||
your GitHub username:
|
||||
@ -110,7 +110,7 @@ If the test suite fails, you'll want to click through to the
|
||||
"Details" link, and try to identify why the test suite failed.
|
||||
|
||||
<p align="center" style="margin: 0 0 10px">
|
||||
<img src="https://raw.githubusercontent.com/encode/uvicorn/master/docs/img/gh-actions-fail.png" alt='Failing PR commit status'>
|
||||
<img src="https://raw.githubusercontent.com/Kludex/uvicorn/master/docs/img/gh-actions-fail.png" alt='Failing PR commit status'>
|
||||
</p>
|
||||
|
||||
Here are some common ways the test suite can fail:
|
||||
@ -118,7 +118,7 @@ Here are some common ways the test suite can fail:
|
||||
### Check Job Failed
|
||||
|
||||
<p align="center" style="margin: 0 0 10px">
|
||||
<img src="https://raw.githubusercontent.com/encode/uvicorn/master/docs/img/gh-actions-fail-check.png" alt='Failing GitHub action lint job'>
|
||||
<img src="https://raw.githubusercontent.com/Kludex/uvicorn/master/docs/img/gh-actions-fail-check.png" alt='Failing GitHub action lint job'>
|
||||
</p>
|
||||
|
||||
This job failing means there is either a code formatting issue or type-annotation issue.
|
||||
@ -157,17 +157,17 @@ Before releasing a new version, create a pull request that includes:
|
||||
|
||||
- **An update to the changelog**:
|
||||
- We follow the format from [keepachangelog](https://keepachangelog.com/en/1.0.0/).
|
||||
- [Compare](https://github.com/encode/uvicorn/compare/) `master` with the tag of the latest release, and list all entries that are of interest to our users:
|
||||
- [Compare](https://github.com/Kludex/uvicorn/compare/) `master` with the tag of the latest release, and list all entries that are of interest to our users:
|
||||
- Things that **must** go in the changelog: added, changed, deprecated or removed features, and bug fixes.
|
||||
- Things that **should not** go in the changelog: changes to documentation, tests or tooling.
|
||||
- Try sorting entries in descending order of impact / importance.
|
||||
- Keep it concise and to-the-point. 🎯
|
||||
- **A version bump**: see `__init__.py`.
|
||||
|
||||
For an example, see [#1006](https://github.com/encode/uvicorn/pull/1107).
|
||||
For an example, see [#1006](https://github.com/Kludex/uvicorn/pull/1107).
|
||||
|
||||
Once the release PR is merged, create a
|
||||
[new release](https://github.com/encode/uvicorn/releases/new) including:
|
||||
[new release](https://github.com/Kludex/uvicorn/releases/new) including:
|
||||
|
||||
- Tag version like `0.13.3`.
|
||||
- Release title `Version 0.13.3`
|
||||
|
||||
@ -244,7 +244,7 @@ or Literals (e.g. `/path/to/socket.sock`). When running from CLI these are confi
|
||||
!!! Warning "Only trust clients you can actually trust!"
|
||||
Incorrectly trusting other clients can lead to malicious actors spoofing their apparent client address to your application.
|
||||
|
||||
For more information, check [`ProxyHeadersMiddleware`](https://github.com/encode/uvicorn/blob/master/uvicorn/middleware/proxy_headers.py).
|
||||
For more information, check [`ProxyHeadersMiddleware`](https://github.com/Kludex/uvicorn/blob/master/uvicorn/middleware/proxy_headers.py).
|
||||
|
||||
### Client Port
|
||||
|
||||
|
||||
@ -14,8 +14,8 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/encode/uvicorn/actions">
|
||||
<img src="https://github.com/encode/uvicorn/workflows/Test%20Suite/badge.svg" alt="Test Suite">
|
||||
<a href="https://github.com/Kludex/uvicorn/actions">
|
||||
<img src="https://github.com/Kludex/uvicorn/workflows/Test%20Suite/badge.svg" alt="Test Suite">
|
||||
</a>
|
||||
<a href="https://pypi.org/project/uvicorn/">
|
||||
<img src="https://badge.fury.io/py/uvicorn.svg" alt="Package version">
|
||||
@ -31,7 +31,7 @@
|
||||
---
|
||||
|
||||
**Documentation**: [https://www.uvicorn.org](https://www.uvicorn.org)<br>
|
||||
**Source Code**: [https://www.github.com/encode/uvicorn](https://www.github.com/encode/uvicorn)
|
||||
**Source Code**: [https://www.github.com/Kludex/uvicorn](https://www.github.com/Kludex/uvicorn)
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -18,12 +18,12 @@ def on_page_content(html: str, page: Page, config: Config, files: Files) -> str:
|
||||
def add_hyperlink_to_pull_request(html: str, page: Page, config: Config, files: Files) -> str:
|
||||
"""Add hyperlink on PRs mentioned on the release notes page.
|
||||
|
||||
If we find "(#\\d+)" it will be added an hyperlink to https://github.com/encode/uvicorn/pull/$1.
|
||||
If we find "(#\\d+)" it will be added an hyperlink to https://github.com/Kludex/uvicorn/pull/$1.
|
||||
"""
|
||||
if not page.file.name == "release-notes":
|
||||
return html
|
||||
|
||||
return re.sub(r"\(#(\d+)\)", r"(<a href='https://github.com/encode/uvicorn/pull/\1'>#\1</a>)", html)
|
||||
return re.sub(r"\(#(\d+)\)", r"(<a href='https://github.com/Kludex/uvicorn/pull/\1'>#\1</a>)", html)
|
||||
|
||||
|
||||
def on_page_markdown(markdown: str, page: Page, config: Config, files: Files) -> str:
|
||||
|
||||
@ -153,7 +153,7 @@ We currently manage sponsorships *exclusively* through **GitHub Sponsors**. This
|
||||
<p>We are currently evaluating whether to expand our sponsorship options beyond GitHub Sponsors. If your company would be interested in sponsoring Starlette and Uvicorn but prefers to use a different platform (e.g., Open Collective, direct invoicing), please let us know!</p>
|
||||
<p>Your feedback is invaluable in helping us make sponsorship as accessible as possible. Share your thoughts by:</p>
|
||||
<ul>
|
||||
<li>Opening a discussion on our <a href="https://github.com/encode/starlette/discussions">GitHub repository</a></li>
|
||||
<li>Opening a discussion on our <a href="https://github.com/Kludex/starlette/discussions">GitHub repository</a></li>
|
||||
<li>Contacting us directly at <a href="mailto:marcelotryle@gmail.com">marcelotryle@gmail.com</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@ -176,7 +176,7 @@ Special thanks to some of our most impactful contributors:
|
||||
|
||||
If you want your name removed from the list above, or if I forgot a significant contributor, please let me know.
|
||||
You can view all contributors on GitHub:
|
||||
[Starlette Contributors](https://github.com/encode/starlette/graphs/contributors) / [Uvicorn Contributors](https://github.com/encode/uvicorn/graphs/contributors).
|
||||
[Starlette Contributors](https://github.com/Kludex/starlette/graphs/contributors) / [Uvicorn Contributors](https://github.com/Kludex/uvicorn/graphs/contributors).
|
||||
|
||||
While the current sponsorship program directly supports Marcelo's maintenance work, we are exploring ways
|
||||
to distribute funding to other key contributors in the future. This initiative is still in early planning
|
||||
|
||||
@ -34,8 +34,8 @@ theme:
|
||||
- toc.follow # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following
|
||||
- announce.dismiss # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#mark-as-read
|
||||
|
||||
repo_name: encode/uvicorn
|
||||
repo_url: https://github.com/encode/uvicorn
|
||||
repo_name: Kludex/uvicorn
|
||||
repo_url: https://github.com/Kludex/uvicorn
|
||||
edit_uri: edit/master/docs/
|
||||
|
||||
# https://www.mkdocs.org/user-guide/configuration/#validation
|
||||
|
||||
@ -53,7 +53,7 @@ uvicorn = "uvicorn.main:main"
|
||||
Changelog = "https://www.uvicorn.org/release-notes"
|
||||
Funding = "https://github.com/sponsors/encode"
|
||||
Homepage = "https://www.uvicorn.org/"
|
||||
Source = "https://github.com/encode/uvicorn"
|
||||
Source = "https://github.com/Kludex/uvicorn"
|
||||
|
||||
[tool.hatch.version]
|
||||
path = "uvicorn/__init__.py"
|
||||
|
||||
@ -354,14 +354,14 @@ def test_forwarded_hosts(init_hosts: str | list[str], test_host: str, expected:
|
||||
(["127.0.0.1", "10.0.0.1"], "https://1.2.3.4:0"),
|
||||
("127.0.0.1, 10.0.0.1", "https://1.2.3.4:0"),
|
||||
# trusted proxy network
|
||||
# https://github.com/encode/uvicorn/issues/1068#issuecomment-1004813267
|
||||
# https://github.com/Kludex/uvicorn/issues/1068#issuecomment-1004813267
|
||||
("127.0.0.0/24, 10.0.0.1", "https://1.2.3.4:0"),
|
||||
# request from untrusted proxy
|
||||
("192.168.0.1", "http://127.0.0.1:123"),
|
||||
# request from untrusted proxy network
|
||||
("192.168.0.0/16", "http://127.0.0.1:123"),
|
||||
# request from client running on proxy server itself
|
||||
# https://github.com/encode/uvicorn/issues/1068#issuecomment-855371576
|
||||
# https://github.com/Kludex/uvicorn/issues/1068#issuecomment-855371576
|
||||
(["127.0.0.1", "1.2.3.4"], "https://1.2.3.4:0"),
|
||||
],
|
||||
)
|
||||
@ -487,7 +487,7 @@ async def test_proxy_headers_websocket_x_forwarded_proto(
|
||||
@pytest.mark.anyio
|
||||
async def test_proxy_headers_empty_x_forwarded_for() -> None:
|
||||
# fallback to the default behavior if x-forwarded-for is an empty list
|
||||
# https://github.com/encode/uvicorn/issues/1068#issuecomment-855371576
|
||||
# https://github.com/Kludex/uvicorn/issues/1068#issuecomment-855371576
|
||||
async with make_httpx_client("*") as client:
|
||||
headers = {X_FORWARDED_FOR: "", X_FORWARDED_PROTO: "https"}
|
||||
response = await client.get("/", headers=headers)
|
||||
|
||||
@ -754,7 +754,7 @@ async def test_server_reject_connection(
|
||||
# -- At this point websockets' recv() is unusable. --
|
||||
|
||||
# This doesn't raise `TypeError`:
|
||||
# See https://github.com/encode/uvicorn/issues/244
|
||||
# See https://github.com/Kludex/uvicorn/issues/244
|
||||
disconnected_message = await receive()
|
||||
|
||||
async def websocket_session(url: str):
|
||||
|
||||
@ -50,7 +50,7 @@ class LifespanOn:
|
||||
loop = asyncio.get_event_loop()
|
||||
main_lifespan_task = loop.create_task(self.main()) # noqa: F841
|
||||
# Keep a hard reference to prevent garbage collection
|
||||
# See https://github.com/encode/uvicorn/pull/972
|
||||
# See https://github.com/Kludex/uvicorn/pull/972
|
||||
startup_event: LifespanStartupEvent = {"type": "lifespan.startup"}
|
||||
await self.receive_queue.put(startup_event)
|
||||
await self.startup_event.wait()
|
||||
|
||||
@ -50,7 +50,7 @@ class ProxyHeadersMiddleware:
|
||||
if host:
|
||||
# If the x-forwarded-for header is empty then host is an empty string.
|
||||
# Only set the client if we actually got something usable.
|
||||
# See: https://github.com/encode/uvicorn/issues/1068
|
||||
# See: https://github.com/Kludex/uvicorn/issues/1068
|
||||
|
||||
# We've lost the connecting client's port information by now,
|
||||
# so only include the host.
|
||||
@ -138,5 +138,5 @@ class _TrustedHosts:
|
||||
return host
|
||||
|
||||
# All hosts are trusted meaning that the client was also a trusted proxy
|
||||
# See https://github.com/encode/uvicorn/issues/1068#issuecomment-855371576
|
||||
# See https://github.com/Kludex/uvicorn/issues/1068#issuecomment-855371576
|
||||
return x_forwarded_for_hosts[0]
|
||||
|
||||
@ -223,7 +223,7 @@ class WebSocketProtocol(WebSocketServerProtocol):
|
||||
]
|
||||
self.transport.write(b"".join(content))
|
||||
# Allow handler task to terminate cleanly, as websockets doesn't cancel it by
|
||||
# itself (see https://github.com/encode/uvicorn/issues/920)
|
||||
# itself (see https://github.com/Kludex/uvicorn/issues/920)
|
||||
self.handshake_started_event.set()
|
||||
|
||||
async def ws_handler(self, protocol: WebSocketServerProtocol, path: str) -> Any: # type: ignore[override]
|
||||
|
||||
@ -74,7 +74,7 @@ class UvicornWorker(Worker):
|
||||
def init_signals(self) -> None:
|
||||
# Reset signals so Gunicorn doesn't swallow subprocess return codes
|
||||
# other signals are set up by Server.install_signal_handlers()
|
||||
# See: https://github.com/encode/uvicorn/issues/894
|
||||
# See: https://github.com/Kludex/uvicorn/issues/894
|
||||
for s in self.SIGNALS:
|
||||
signal.signal(s, signal.SIG_DFL)
|
||||
|
||||
@ -85,7 +85,7 @@ class UvicornWorker(Worker):
|
||||
def _install_sigquit_handler(self) -> None:
|
||||
"""Install a SIGQUIT handler on workers.
|
||||
|
||||
- https://github.com/encode/uvicorn/issues/1116
|
||||
- https://github.com/Kludex/uvicorn/issues/1116
|
||||
- https://github.com/benoitc/gunicorn/issues/2604
|
||||
"""
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user