Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waylonwalker/default-kedro157
default kedro template with kedro version 0.15.7
https://github.com/waylonwalker/default-kedro157
Last synced: about 1 month ago
JSON representation
default kedro template with kedro version 0.15.7
- Host: GitHub
- URL: https://github.com/waylonwalker/default-kedro157
- Owner: WaylonWalker
- Created: 2020-02-29T17:11:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T08:42:32.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T02:29:49.244Z (8 months ago)
- Language: Python
- Size: 9.67 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Default Kedro 157
_for testing out github actions with kedro_
Actions: 
Viz: [](https://app.netlify.com/sites/default-kedro157/deploys)
Docs: [](https://app.netlify.com/sites/default-kedro157-docs/deploys)
## ⚡ Fully automated actions
* test
* lint
* viz
* build-docs
* run
* package
* docker-build
* deploy viz
* deploy docs
## 📈 Vizualization Deployed
[default-kedro-157.waylonwalker.com/](https://default-kedro-157.waylonwalker.com/)
## 📄 Docs Deployed
[default-kedro-157-docs.waylonwalker.com/](https://default-kedro-157-docs.waylonwalker.com/)
## Overview
This is your new Kedro project, which was generated using `Kedro 0.15.7` by running:
```
kedro new
```
Take a look at the [documentation](https://kedro.readthedocs.io) to get started.
## Rules and guidelines
In order to get the best out of the template:
* Please don't remove any lines from the `.gitignore` file provided
* Make sure your results can be reproduced by following a data engineering convention, e.g. the one we suggest [here](https://kedro.readthedocs.io/en/stable/06_resources/01_faq.html#what-is-data-engineering-convention)
* Don't commit any data to your repository
* Don't commit any credentials or local configuration to your repository
* Keep all credentials or local configuration in `conf/local/`
## Installing dependencies
Dependencies should be declared in `src/requirements.txt` for pip installation and `src/environment.yml` for conda installation.
To install them, run:
```
kedro install
```
## Running Kedro
You can run your Kedro project with:
```
kedro run
```
## Testing Kedro
Have a look at the file `src/tests/test_run.py` for instructions on how to write your tests. You can run your tests with the following command:
```
kedro test
```
To configure the coverage threshold, please have a look at the file `.coveragerc`.
### Working with Kedro from notebooks
In order to use notebooks in your Kedro project, you need to install Jupyter:
```
pip install jupyter
```
For using Jupyter Lab, you need to install it:
```
pip install jupyterlab
```
After installing Jupyter, you can start a local notebook server:
```
kedro jupyter notebook
```
You can also start Jupyter Lab:
```
kedro jupyter lab
```
And if you want to run an IPython session:
```
kedro ipython
```
Running Jupyter or IPython this way provides the following variables in
scope: `proj_dir`, `proj_name`, `conf`, `io`, `parameters` and `startup_error`.
#### Converting notebook cells to nodes in a Kedro project
Once you are happy with a notebook, you may want to move your code over into the Kedro project structure for the next stage in your development. This is done through a mixture of [cell tagging](https://jupyter-notebook.readthedocs.io/en/stable/changelog.html#cell-tags) and Kedro CLI commands.
By adding the `node` tag to a cell and running the command below, the cell's source code will be copied over to a Python file within `src//nodes/`.
```
kedro jupyter convert
```
> *Note:* The name of the Python file matches the name of the original notebook.
Alternatively, you may want to transform all your notebooks in one go. To this end, you can run the following command to convert all notebook files found in the project root directory and under any of its sub-folders.
```
kedro jupyter convert --all
```
#### Ignoring notebook output cells in `git`
In order to automatically strip out all output cell contents before committing to `git`, you can run `kedro activate-nbstripout`. This will add a hook in `.git/config` which will run `nbstripout` before anything is committed to `git`.
> *Note:* Your output cells will be left intact locally.
## Package the project
In order to package the project's Python code in `.egg` and / or a `.wheel` file, you can run:
```
kedro package
```
After running that, you can find the two packages in `src/dist/`.
## Building API documentation
To build API docs for your code using Sphinx, run:
```
kedro build-docs
```
See your documentation by opening `docs/build/html/index.html`.
## Building the project requirements
To generate or update the dependency requirements for your project, run:
```
kedro build-reqs
```
This will copy the contents of `src/requirements.txt` into a new file `src/requirements.in` which will be used as the source for `pip-compile`. You can see the output of the resolution by opening `src/requirements.txt`.
After this, if you'd like to update your project requirements, please update `src/requirements.in` and re-run `kedro build-reqs`.