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

Remove .ipython dir and update readme files #78

Merged
merged 1 commit into from
Mar 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
Expand Down
4 changes: 0 additions & 4 deletions astro-airflow-iris/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ airflow_settings.yaml
logs/

# All Kedro project files, except data/ and conf/
.ipython/
docs/
notebooks/
src/
Expand Down
4 changes: 0 additions & 4 deletions astro-airflow-iris/{{ cookiecutter.repo_name }}/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
.ipython/profile_default/history.sqlite
.ipython/profile_default/startup/README

# pyenv
.python-version

Expand Down
13 changes: 7 additions & 6 deletions astro-airflow-iris/{{ cookiecutter.repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To install them, run:
pip install -r src/requirements.txt
```

## How to run Kedro
## How to run your Kedro pipeline

You can run your Kedro project with:

Expand All @@ -41,8 +41,7 @@ Have a look at the file `src/tests/test_run.py` for instructions on how to write
kedro test
```

To configure the coverage threshold, look at the `.coveragerc` file.

To configure the coverage threshold, go to the `.coveragerc` file.

## Project dependencies

Expand All @@ -52,15 +51,17 @@ To generate or update the dependency requirements for your project:
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`.
This will `pip-compile` the contents of `src/requirements.txt` into a new file `src/requirements.lock`. You can see the output of the resolution by opening `src/requirements.lock`.

After this, if you'd like to update your project requirements, please update `src/requirements.in` and re-run `kedro build-reqs`.
After this, if you'd like to update your project requirements, please update `src/requirements.txt` and re-run `kedro build-reqs`.

[Further information about project dependencies](https://kedro.readthedocs.io/en/stable/kedro_project_setup/dependencies.html#project-specific-dependencies)

## How to work with Kedro and notebooks

> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `context`, `catalog`, and `startup_error`.
> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `catalog`, `context`, `pipelines` and `session`.
>
> Jupyter, JupyterLab, and IPython are already included in the project requirements by default, so once you have run `pip install -r src/requirements.txt` you will not need to take any extra steps before you use them.

### Jupyter
To use Jupyter notebooks in your Kedro project, you need to install Jupyter:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ flake8>=3.7.9, <4.0
ipython>=7.31.1, <8.0
isort~=5.0
jupyter~=1.0
jupyter_client>=5.1, <7.0
jupyterlab~=3.0
kedro[pandas.CSVDataSet]=={{ cookiecutter.kedro_version }}
kedro-airflow~=0.4
Expand Down
4 changes: 0 additions & 4 deletions pandas-iris/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
Expand Down
4 changes: 0 additions & 4 deletions pandas-iris/{{ cookiecutter.repo_name }}/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
.ipython/profile_default/history.sqlite
.ipython/profile_default/startup/README

# pyenv
.python-version

Expand Down

This file was deleted.

13 changes: 7 additions & 6 deletions pandas-iris/{{ cookiecutter.repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To install them, run:
pip install -r src/requirements.txt
```

## How to run Kedro
## How to run your Kedro pipeline

You can run your Kedro project with:

Expand All @@ -41,8 +41,7 @@ Have a look at the file `src/tests/test_run.py` for instructions on how to write
kedro test
```

To configure the coverage threshold, look at the `.coveragerc` file.

To configure the coverage threshold, go to the `.coveragerc` file.

## Project dependencies

Expand All @@ -52,15 +51,17 @@ To generate or update the dependency requirements for your project:
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`.
This will `pip-compile` the contents of `src/requirements.txt` into a new file `src/requirements.lock`. You can see the output of the resolution by opening `src/requirements.lock`.

After this, if you'd like to update your project requirements, please update `src/requirements.in` and re-run `kedro build-reqs`.
After this, if you'd like to update your project requirements, please update `src/requirements.txt` and re-run `kedro build-reqs`.

[Further information about project dependencies](https://kedro.readthedocs.io/en/stable/kedro_project_setup/dependencies.html#project-specific-dependencies)

## How to work with Kedro and notebooks

> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `context`, `catalog`, and `startup_error`.
> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `catalog`, `context`, `pipelines` and `session`.
>
> Jupyter, JupyterLab, and IPython are already included in the project requirements by default, so once you have run `pip install -r src/requirements.txt` you will not need to take any extra steps before you use them.

### Jupyter
To use Jupyter notebooks in your Kedro project, you need to install Jupyter:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ flake8>=3.7.9, <4.0
ipython>=7.31.1, <8.0
isort~=5.0
jupyter~=1.0
jupyter_client>=5.1, <7.0
jupyterlab~=3.0
kedro[pandas.CSVDataSet]=={{ cookiecutter.kedro_version }}
kedro-telemetry~=0.1.0
Expand Down
4 changes: 0 additions & 4 deletions pyspark-iris/{{ cookiecutter.repo_name }}/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
.ipython/profile_default/history.sqlite
.ipython/profile_default/startup/README

# pyenv
.python-version

Expand Down

This file was deleted.

17 changes: 8 additions & 9 deletions pyspark-iris/{{ cookiecutter.repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

## Overview

This is your new Kedro project with some initial Spark configuration and an example pipeline, generated using `Kedro {{ cookiecutter.kedro_version }}`.

This project assumes that a Spark cluster is accessible. Please refer to [Spark documentation](https://spark.apache.org/docs/latest/spark-standalone.html) on how to set one up locally.
This is your new Kedro project, which was generated using `Kedro {{ cookiecutter.kedro_version }}`.

Take a look at the [Kedro documentation](https://kedro.readthedocs.io) to get started.

Expand All @@ -27,7 +25,7 @@ To install them, run:
pip install -r src/requirements.txt
```

## How to run Kedro
## How to run your Kedro pipeline

You can run your Kedro project with:

Expand All @@ -43,8 +41,7 @@ Have a look at the file `src/tests/test_run.py` for instructions on how to write
kedro test
```

To configure the coverage threshold, look at the `.coveragerc` file.

To configure the coverage threshold, go to the `.coveragerc` file.

## Project dependencies

Expand All @@ -54,15 +51,17 @@ To generate or update the dependency requirements for your project:
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`.
This will `pip-compile` the contents of `src/requirements.txt` into a new file `src/requirements.lock`. You can see the output of the resolution by opening `src/requirements.lock`.

After this, if you'd like to update your project requirements, please update `src/requirements.in` and re-run `kedro build-reqs`.
After this, if you'd like to update your project requirements, please update `src/requirements.txt` and re-run `kedro build-reqs`.

[Further information about project dependencies](https://kedro.readthedocs.io/en/stable/kedro_project_setup/dependencies.html#project-specific-dependencies)

## How to work with Kedro and notebooks

> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `context`, `catalog`, and `startup_error`.
> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `catalog`, `context`, `pipelines` and `session`.
>
> Jupyter, JupyterLab, and IPython are already included in the project requirements by default, so once you have run `pip install -r src/requirements.txt` you will not need to take any extra steps before you use them.

### Jupyter
To use Jupyter notebooks in your Kedro project, you need to install Jupyter:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ flake8>=3.7.9, <4.0
ipython>=7.31.1, <8.0
isort~=5.0
jupyter~=1.0
jupyter_client>=5.1, <7.0
jupyterlab~=3.0
kedro[spark.SparkDataSet]=={{ cookiecutter.kedro_version }}
kedro-telemetry~=0.1.0
Expand Down
4 changes: 0 additions & 4 deletions pyspark/{{ cookiecutter.repo_name }}/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
.ipython/profile_default/history.sqlite
.ipython/profile_default/startup/README

# pyenv
.python-version

Expand Down

This file was deleted.

17 changes: 8 additions & 9 deletions pyspark/{{ cookiecutter.repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

## Overview

This is your new Kedro project with some initial Spark configurations and an example pipeline, which was generated using `Kedro {{ cookiecutter.kedro_version }}`.
This is your new Kedro project, which was generated using `Kedro {{ cookiecutter.kedro_version }}`.

Take a look at the [Kedro documentation](https://kedro.readthedocs.io) to get started.

This project assumes that a Spark cluster is accessible. Please refer to [Spark documentation](https://spark.apache.org/docs/latest/spark-standalone.html) on how to set one up locally.

## Rules and guidelines

In order to get the best out of the template:
Expand All @@ -27,7 +25,7 @@ To install them, run:
pip install -r src/requirements.txt
```

## How to run Kedro
## How to run your Kedro pipeline

You can run your Kedro project with:

Expand All @@ -43,8 +41,7 @@ Have a look at the file `src/tests/test_run.py` for instructions on how to write
kedro test
```

To configure the coverage threshold, look at the `.coveragerc` file.

To configure the coverage threshold, go to the `.coveragerc` file.

## Project dependencies

Expand All @@ -54,15 +51,17 @@ To generate or update the dependency requirements for your project:
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`.
This will `pip-compile` the contents of `src/requirements.txt` into a new file `src/requirements.lock`. You can see the output of the resolution by opening `src/requirements.lock`.

After this, if you'd like to update your project requirements, please update `src/requirements.in` and re-run `kedro build-reqs`.
After this, if you'd like to update your project requirements, please update `src/requirements.txt` and re-run `kedro build-reqs`.

[Further information about project dependencies](https://kedro.readthedocs.io/en/stable/kedro_project_setup/dependencies.html#project-specific-dependencies)

## How to work with Kedro and notebooks

> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `context`, `catalog`, and `startup_error`.
> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `catalog`, `context`, `pipelines` and `session`.
>
> Jupyter, JupyterLab, and IPython are already included in the project requirements by default, so once you have run `pip install -r src/requirements.txt` you will not need to take any extra steps before you use them.

### Jupyter
To use Jupyter notebooks in your Kedro project, you need to install Jupyter:
Expand Down
1 change: 0 additions & 1 deletion pyspark/{{ cookiecutter.repo_name }}/src/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ flake8>=3.7.9, <4.0
ipython>=7.31.1, <8.0
isort~=5.0
jupyter~=1.0
jupyter_client>=5.1, <7.0
jupyterlab~=3.0
kedro[spark.SparkDataSet]=={{ cookiecutter.kedro_version }}
kedro-telemetry~=0.1.0
Expand Down
4 changes: 0 additions & 4 deletions spaceflights/{{ cookiecutter.repo_name }}/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
.ipython/profile_default/history.sqlite
.ipython/profile_default/startup/README

# pyenv
.python-version

Expand Down

This file was deleted.

15 changes: 8 additions & 7 deletions spaceflights/{{ cookiecutter.repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

This is your new Kedro project, which was generated using `Kedro {{ cookiecutter.kedro_version }}`, with the completed version of the [spaceflights tutorial](https://kedro.readthedocs.io/en/stable/tutorial/spaceflights_tutorial.html) and the data necessary to run the project.
This is your new Kedro project, which was generated using `Kedro {{ cookiecutter.kedro_version }}`.

Take a look at the [Kedro documentation](https://kedro.readthedocs.io) to get started.

Expand All @@ -25,7 +25,7 @@ To install them, run:
pip install -r src/requirements.txt
```

## How to run Kedro
## How to run your Kedro pipeline

You can run your Kedro project with:

Expand All @@ -41,8 +41,7 @@ Have a look at the file `src/tests/test_run.py` for instructions on how to write
kedro test
```

To configure the coverage threshold, look at the `.coveragerc` file.

To configure the coverage threshold, go to the `.coveragerc` file.

## Project dependencies

Expand All @@ -52,15 +51,17 @@ To generate or update the dependency requirements for your project:
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`](https://github.com/jazzband/pip-tools#example-usage-for-pip-compile). You can see the output of the resolution by opening `src/requirements.txt`.
This will `pip-compile` the contents of `src/requirements.txt` into a new file `src/requirements.lock`. You can see the output of the resolution by opening `src/requirements.lock`.

After this, if you'd like to update your project requirements, please update `src/requirements.in` and re-run `kedro build-reqs`.
After this, if you'd like to update your project requirements, please update `src/requirements.txt` and re-run `kedro build-reqs`.

[Further information about project dependencies](https://kedro.readthedocs.io/en/stable/kedro_project_setup/dependencies.html#project-specific-dependencies)

## How to work with Kedro and notebooks

> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `context`, `catalog`, and `startup_error`.
> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `catalog`, `context`, `pipelines` and `session`.
>
> Jupyter, JupyterLab, and IPython are already included in the project requirements by default, so once you have run `pip install -r src/requirements.txt` you will not need to take any extra steps before you use them.

### Jupyter
To use Jupyter notebooks in your Kedro project, you need to install Jupyter:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ flake8>=3.7.9, <4.0
ipython>=7.31.1, <8.0
isort~=5.0
jupyter~=1.0
jupyter_client>=5.1, <7.0
jupyterlab~=3.0
kedro[pandas.CSVDataSet, pandas.ExcelDataSet, pandas.ParquetDataSet]=={{ cookiecutter.kedro_version }}
kedro-telemetry~=0.1.0
Expand Down
4 changes: 0 additions & 4 deletions standalone-datacatalog/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,6 @@ target/
# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
Expand Down