Replace "My Project" with your actual project name
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)
- 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] - Replace "my_project" directory name with your package name (use underscores)
- Update this README.md with your project details
- Update the package imports in your code as needed
The fastest way to get started (on Unix/MacOS/Linux):
make install
cp .env.example .env # Then add your API keysFor detailed installation instructions, API key configuration options, and alternative setup methods, see PIPELEX_SETUP.md.
| Channel | Use case |
|---|---|
| GitHub Discussions → "Show & Tell" | Share ideas, brainstorm, get early feedback. |
| GitHub Issues | Report bugs or request features. |
| Email (privacy & security) | security@pipelex.com |
| Discord | Real-time chat — https://go.pipelex.com/discord |
This project is licensed under the MIT license. Runtime dependencies are distributed under their own licenses via PyPI.
Happy piping! 🚀
