Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an Adding Scripts page on the documentation #74

Open
TeaganKing opened this issue Mar 6, 2024 · 1 comment
Open

Create an Adding Scripts page on the documentation #74

TeaganKing opened this issue Mar 6, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@TeaganKing
Copy link
Collaborator

This should be complimentary to the current Adding Documentation page.

@TeaganKing TeaganKing added the documentation Improvements or additions to documentation label Mar 6, 2024
@rmshkv rmshkv self-assigned this Mar 13, 2024
@rmshkv
Copy link
Contributor

rmshkv commented Apr 17, 2024

Since I haven't gotten this page written yet, here's a quick example of how a scripts block in the config.yml should look:

compute_scripts:
    ocean:
        test_script:
            parameter_groups:
                none: {}
            product:
                "nothing.txt"

This should be on the same level as compute_notebooks, and follows the same component categories as compute_notebooks (once that PR goes in). The script this is running is test_script.py and arguments can be put under parameter_groups. Due to how Ploomber works it's required to generate an output file, which you specify under the required "product" key. Ploomber will check if that file exists before trying to run the script, similarly to how it does caching for notebooks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants