diff --git a/README.md b/README.md new file mode 100644 index 0000000..76ba4b3 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Python Workers Examples + +This is a collection of examples for [writing Cloudflare Workers in Python](https://developers.cloudflare.com/workers/languages/python). Use these examples to learn how Python Workers work. + +## Get started + +1. `git clone https://github.com/cloudflare/python-workers-examples` +2. `cd hello` +3. `npx wrangler@latest dev` +4. Press the `b` key to open a browser tab, and make a request to your Worker +5. `npx wrangler@latest deploy` to deploy your Worker to Cloudflare + +You can run `npx wrangler@latest dev` in any example project directory to run a local development server using [Wrangler](https://developers.cloudflare.com/workers/wrangler/), the CLI for Cloudflare Workers. This local development server is powered by [workerd](https://github.com/cloudflare/workerd), the open-source Workers runtime. + +## Examples + +- [**`01-hello/`**](01-hello) — the most basic Python Worker +- [**`02-binding/`**](02-binding) — shows how [bindings](https://developers.cloudflare.com/workers/configuration/bindings/) work in Python Workers. Put a key into Workers KV, and then read it. +- [**`03-fastapi/`**](03-fastapi) — demonstrates how to use the [FastAPI](https://fastapi.tiangolo.com/) package with Python Workers +- [**`04-langchain/`**](04-langchain) — demonstrates how to use the [LangChain](https://pypi.org/project/langchain/) package with Python Workers + +## License + +The [MIT license](LICENSE).