Improvements in documentation, pre-commit configuration

.github/workflows/pipeline.yml

@@ -49,3 +49,4 @@ jobs:
           pip install -r src/requirements.txt
       - name: Run build
         run: kedro package
+

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+    -   id: check-yaml
+    -   id: check-json
+    -   id: check-ast
+    -   id: check-docstring-first
+    -   id: name-tests-test
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: detect-private-key
+    -   id: fix-encoding-pragma
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/psf/black
+    rev: 21.9b0
+    hooks:
+    -   id: black

README.md

@@ -1,28 +1,56 @@
+![example branch parameter](https://github.com/elcubonegro/kedro-devops/actions/workflows/pipeline.yml/badge.svg?branch=main)
+
 # kedro-devops
 
 This project intends to demonstrate and define a Dev(ML)Ops pipeline for Kedro
-
 ## Setup
 
 To install de project you must have [conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) and setup a Python3.7 environment as follows:
 
 ```bash
-conda create --name kedro-devops python=3.7 -y
+conda create --name Aldebaran-Learning python=3.7 -y
 ```
 
 Then you need to activate your virtualenv
 
 ```bash
-conda activate kedro-devops
+conda activate Aldebaran-Learning
 ```
-
 > Note: if you are using windows you may need to use a cmd shell instead of a powershell to activate a conda environment
 
+Init the git flow
+
+```bash
+git clone -b master git@github.com:elcubonegro/gitflow-avh.git
+cd gitflow-avh
+make && make install
+```
+
+Init the git pre-commit hooks
+
+```bash
+conda activate Aldebaran-Learning
+```
+
+After that initialize the local gitflow repository with gitflow itself:
+
+```bash
+git flow init -d
+git flow feature start <your feature>
+```
+
+Then, do work and commit your changes.
+
+```bash
+git flow feature publish <your feature>
+When done, open a pull request to your feature branch.
+```
+
 ## Overview
 
-This is your new Kedro project, which was generated using `Kedro 0.17.5`.
+this is a Kedro project, builded using `Kedro 0.17.5`.
 
-Take a look at the [Kedro documentation](https://kedro.readthedocs.io) to get started.
+For more information please reffer to [Kedro documentation](https://kedro.readthedocs.io).
 
 ## Rules and guidelines
 

src/kedro_devops/pipelines/data_engineering/nodes/transform_uppercase.py

@@ -3,12 +3,11 @@
 
 def transform_uppercase(data: pd.DataFrame) -> pd.DataFrame:
     """
-    Transform a lowercase dataframe to uppercase.
-
+    Transform the data to uppercase.
     Args:
-        data (pd.DataFrame): A raw dataframe
+        data (DataFrame): Data to be transformed.
 
     Returns:
-        pd.DataFrame: An uppercase dataframe
+        (DataFrame) Transformed data to uppercase.
     """
-    return data.applymap(lambda x: x.upper())
+    return data.applymap(lambda row: row.upper())

src/requirements.in

@@ -11,12 +11,13 @@ kedro-telemetry~=0.1.0
 mypy~=0.910
 nbstripout~=0.4
 pandas-stubs
+pre-commit==2.15.0
 pydocstyle~=6.1.1
 pytest-cov~=2.5
 pytest-mock>=1.7.1, <2.0
 pytest~=6.2
-types-atomicwrites 
-types-cachetools 
-types-setuptools 
+types-atomicwrites
+types-cachetools
+types-setuptools
 types-toml
 wheel>=0.35, <0.37