Papyrus 📜

CLI tool that generates an OpenAPI documentation from your Pyramid application. Designed to get you up and running fast with minimal fuss.

---

✨ Features

• Automated OpenAPI Docs: Generate up-to-date API documentation from your Pyramid app automatically.
• Flexible Output:
  • Clipboard: Pipe the output to your clipboard (e.g., using pbcopy on macOS).
  • File: Redirect output to a file (e.g., api.yml).
• Intuitive CLI: Built with Typer for a smooth command-line experience.

⚙️ Requirements

• Python: Version 3.13 or higher.

📦 Installation

Install Papyrus via the UV tool:

uv tool install git+https://github.com/iamlucasvieira/papyrus

Or clone the repository and install manually:

git clone https://github.com/iamlucasvieira/papyrus
cd papyrus
pip install .

🚀 Usage

1. Navigate to Your Pyramid App

Go to the directory of your Pyramid app (the directory containing your routes.py):

  cd /path/to/your/pyramid/app

2. Run Papyrus

Execute the command to generate the OpenAPI documentation:

papyrus

3. Output Options

Copy to Clipboard: Pipe the output directly to your clipboard (macOS example):

papyrus | pbcopy

Save to a File: Redirect the output to save it as a YAML file:

papyrus > api.yml

🤝 Contributing

Contributions are always welcome! If you have ideas for improvements or spot any issues, please open an issue or submit a pull request.

📄 License

Distributed under the MIT License. See the LICENSE file for more details.

🙏 Acknowledgements

A big thank you to the maintainers of these awesome tools that make Papyrus possible:

• typer
• cattrs
• rich
• openapi-spec-validator