https://github.com/endrekrohn/fastws-example

FastWS example project with auto-documentation of WebSockets using AsyncAPI.
https://github.com/endrekrohn/fastws-example

asyncapi fastapi pydantic python

Last synced: 3 months ago
JSON representation

FastWS example project with auto-documentation of WebSockets using AsyncAPI.

• Host: GitHub
• URL: https://github.com/endrekrohn/fastws-example
• Owner: endrekrohn
• Created: 2023-07-06T22:26:07.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-27T11:36:26.000Z (over 1 year ago)
• Last Synced: 2024-07-29T16:59:30.720Z (6 months ago)
• Topics: asyncapi, fastapi, pydantic, python
• Language: Python
• Homepage: https://pypi.org/project/fastws
• Size: 6.84 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# FastWS - Example project



 

    





**Source Code**: https://github.com/endrekrohn/fastws

---

This is an example project for how one can structure an application around FastWS. Please see read the README.md in the project repo to understand it further 👨‍💻

## Installation

You can open this project in a devcontainer using VSCode if you would like. You can use the VSCode command `Tasks: Run Task` and chooose `Run API` to start the API.

To manually install the project first install `poetry` and install the necessary dependencies with the command:

```sh

poetry install --with dev

```

Then start the API with the following command:

```sh

poetry run uvicorn api.main:app --log-level debug --host 0.0.0.0 --port 8000 --reload

```

## Questions?

If you have any questions please raise an issue or send me an email at [email protected] 👉👉.