ale
04/14/2022, 5:35 PMAnna Geller
04/14/2022, 5:37 PMale
04/14/2022, 5:38 PMprefect-cubejs
collection on my local environment 😊
Here you can find the code!
What are the next steps to submit the code into Prefect repo?Anna Geller
04/18/2022, 10:48 AMalex
04/18/2022, 1:30 PMcoverage run --branch -m pytest tests
. We recommend at least 80% coverage.
• Make sure that all the documentation is updated. This includes the docstrings in your Python code and README.md since they are used to generate your documentation. You can run mkdocs serve
to view the generated documentation.
• Publish a version of prefect-cubejs
on PyPI. You can do this automatically by creating a tag in GitHub with a v prefix (e.g. v0.1.0). This will create a release on PyPI and also publish the autogenerated docs to GitHub Pages. You’ll need a PyPI to to publish to PyPI and you can refer to MAINTAINERS.md in your repo for more information.
Once you’ve completed the initial release, we can work together to get prefect-cubejs
listed in the Prefect Collections Catalog. If you run into any issues, let me know and I’ll be happy to help!ale
04/20/2022, 3:26 PMprefect-cubejs
on PyPi 🎉
https://pypi.org/project/prefect-cubejs/alex
04/20/2022, 3:36 PMale
04/20/2022, 3:39 PMalex
04/20/2022, 3:48 PMale
04/20/2022, 3:49 PMalex
04/20/2022, 4:20 PMrun_query
need to be filled in. Can you you add a docstring that documents the arguments, return type, and examples for the task similar to these tasks here: https://github.com/PrefectHQ/prefect-slack/blob/main/prefect_slack/messages.py?ale
04/20/2022, 4:44 PMalex
04/20/2022, 7:06 PMprefect.engine.signals.FAIL
in the new docstring, but I think that should be CubeJSAPIFailureException
.ale
04/20/2022, 7:07 PMalex
04/21/2022, 6:22 PM(str, optional)
) since mkdocs can pull typing info from the type hints on your function. If you want to experiment with changes to the documentation on your local you can run mkdocs serve
which will rebuild the docs each time you make a change.ale
04/21/2022, 8:13 PMalex
04/22/2022, 4:25 PM