uvicorn-worker - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #golang #go #machine-learning #rust #docker #macos #awesome #kubernetes #security #openai

uvicorn-worker

(★ 123)

Uvicorn worker for Gunicorn! :sparkles:

File Explorer

Download Latest Version (.zip)

- - main.yml
  - publish.yml
- dependabot.yml
- - index.md
  - logging.md
  - reloader.md
- mkdocs.yml
- build
- check
- coverage
- install
- lint
- test
- __init__.py
- conftest.py
- test_workers.py
- __init__.py
- _workers.py
.gitignore
LICENSE.md
pyproject.toml
README.md
requirements.txt

# Installation Guide

1. Get the code

git clone https://github.com/Kludex/uvicorn-worker

Downloads the entire project code from GitHub to your computer.

cd uvicorn-worker

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install uvicorn-worker

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install uvicorn-worker

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Uvicorn Worker

The **Uvicorn Worker** is a package designed for the mature and comprehensive server and process manager, [Gunicorn][gunicorn].
This package allows you to run ASGI applications, leverages [Uvicorn][uvicorn]'s high-performance capabilities, and provides Gunicorn's
robust process management.

By using this package, you can dynamically adjust the number of worker processes, restart them gracefully, and execute server
upgrades without any service interruption.

## Getting Started

### Installation

You can easily install the Uvicorn Worker package using pip:

```bash
pip install uvicorn-worker
```

## Deployment

For production environments, it's recommended to utilize Gunicorn with the Uvicorn worker class.
Below is an example of how to do this:

```bash
gunicorn example:app -w 4 -k uvicorn_worker.UvicornWorker
```

In the above command, `-w 4` instructs Gunicorn to initiate 4 worker processes, and `-k uvicorn_worker.UvicornWorker` flag tells
Gunicorn to use the Uvicorn worker class.

If you're working with a [PyPy][pypy] compatible configuration, you should use `uvicorn_worker.UvicornH11Worker`.

### Development

During development, you can directly run Uvicorn as follows:

```bash
uvicorn example:app --reload
```

The `--reload` flag will automatically reload the server when you make changes to your code.

For more information read the [Uvicorn documentation](https://www.uvicorn.org/).

[gunicorn]: https://gunicorn.org/
[uvicorn]: https://www.uvicorn.org/
[pypy]: https://www.pypy.org/