This repository hosts the dbt project for Open edX Aspects. It contains sql files and configuration that control the ClickHouse reporting schema, data transformations, tests, and documentation that drive Aspects reports. This project is still in its infancy and will be growing with documentation and examples as we approach the Aspects v1 launch.
A dbt docs site with the details of this project, built off the main branch is located here: https://openedx.github.io/aspects-dbt/
pip install -r requirements.txtwill install dbt and other required packages.dbt depswill install the dbt packages defined in packages.yml (this step needs to be run when initializing your project or when changing the package list).
dbt run will compile and create the models defined in the "aspects" dbt project. By default, dbt will look in the xapi schema to find source tables. The XAPI_SCHEMA environment variable can be used to specify a different schema.
If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.
For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.
https://github.com/openedx/aspects-dbt/issues
For more information about these options, see the Getting Help page.
Please see LICENSE for details.
Contributions are very welcome. Please read How To Contribute for details.
This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.
Make sure to format the SQL models via make format before submitting a pull request.
All community members are expected to follow the Open edX Code of Conduct.
The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.
Please do not report security issues in public. Please email [email protected].