My Project ⚡️

Replace "My Project" with your actual project name

Use this template

This is a template repository: don't clone it, click the green Use this template button at the top-right of the Github repo page. Once you've created your repository from it, then you can clone it and follow the instructions below:

Next steps after creating from template (or later when you feel like it)

1. In pyproject.toml, replace "my-project" with your project name in the header, then replace "my_project" with your package name (using underscores) in the "packages" parameter of [tool.mypy] and the "include" parameter of [tool.pyright]
2. Replace "my_project" directory name with your package name (use underscores)
3. Update this README.md with your project details
4. Update the package imports in your code as needed

---

Getting Started

Quick Start

git clone https://github.com/yourusername/your-repo-name.git
cd your-repo-name

# Create and activate virtual environment
python -m venv .venv
# or python3 -m venv .venv
source .venv/bin/activate

# Install
pip install .  # or uv sync
pipelex init

After installation, configure your API keys by creating a .env file with your credentials. See more about API key configuration in the documentation.

---

Contact & Support

Channel	Use case
GitHub Discussions → "Show & Tell"	Share ideas, brainstorm, get early feedback.
GitHub Issues	Report bugs or request features.
Email (privacy & security)	[email protected]
Discord	Real-time chat — https://go.pipelex.com/discord

📝 License

This project is licensed under the MIT license. Runtime dependencies are distributed under their own licenses via PyPI.

---

Happy piping! 🚀