# Apache Beam Python I/O Cookiecutter

```{image} _static/logo.png
:alt: pyio-cookiecutter logo
:width: 250px
:align: center
```

<br>

`pyio-cookiecutter` is a [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) template for creating a package for the [Apache Beam Python I/O Connectors](https://github.com/beam-pyio) project using [`poetry`](https://python-poetry.org).

## Features

```{include} stubs/features-stub.md
```

## Quick Start

```{include} stubs/quickstart-stub.md
```

## Parameters

```{include} stubs/parameters-stub.md
```

## Learn More

To learn more, checkout the sections below.

```{eval-rst}
.. container:: button

   :doc:`Quick Start <quickstart>` :doc:`User Guide <user-guide>`
```

## Acknowledgements

`pyio-cookiecutter` was originally developed for use in the [Apache Beam Python I/O Connectors](https://github.com/beam-pyio) project. It was inspired by the `Py-Pkgs-Cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).

```{toctree}
:maxdepth: 2
:hidden:

Home <self>
Quick Start <quickstart>
User Guide <user-guide>
Contributing <contributing>
Code of Conduct <conduct>
```