This is your new Kedro project, which was generated using Kedro 0.14.1
by running:
kedro new
Take a look at the documentation to get started.
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 adding necessary data to
data/01_raw
only - 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/
Dependencies should be declared in src/requirements.txt
.
To install them, run:
kedro install
You can run your Kedro project with:
kedro run
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
.
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
.
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.
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/
.
To build API docs for your code using Sphinx, run:
kedro build-docs
See your documentation by opening docs/build/html/index.html
.