README

Run parameterized Jupyter notebooks as Laravel report jobs and collect their output — CSV/TSV data exports or nbconvert-style document conversions (HTML, PDF, script, markdown) — behind a single, swappable execution strategy.

Status: this package is under active development and not yet ready for production use. Public API and configuration are still subject to change. Design rationale for the notebook execution strategy is documented as an Architecture Decision Record under docs/adr.

Installation

You can install the package via composer:

composer require creightonfrance/laravel-jupyter-reports

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-jupyter-reports-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravel-jupyter-reports-config"

Optionally, you can publish the views using:

php artisan vendor:publish --tag="laravel-jupyter-reports-views"

Usage

The notebook execution API is still being built out and isn't ready to document with a working example yet. See docs/adr for the current design direction and the CHANGELOG for what has actually shipped so far — this section will be filled in once the public API stabilizes.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Code of Conduct

Please review our Code of Conduct — it applies to all interactions in this project.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Creighton France
• All Contributors

License

The MIT License (MIT). Please see License File for more information.