Merge branch '171-remove-cookieecutter-logic' into 'master'

[RFC] Resolve "Remove cookieecutter logic"

Closes #171

See merge request mutt_data/soam!116

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.8.1
+current_version = 0.9.0
 tag = False
 
 [bumpversion:file:soam/__init__.py]

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.0 - 2021-08-09]
+
+### Removed
+- Cookiecutter logic.
+
 ## [0.8.1 - 2021-08-06]
 
 ### Added

README.md

@@ -109,13 +109,7 @@ _Note_: The `pdf_report` extra might need to run the following command before in
 [Here](quickstart.ipynb) is an example for a quick start into SoaM. In it a time series with AAPL stock prices is loaded, processed and forecasted. As well, there's [other example](soamflowrun.ipynb) with the same steps, but exploding the power of flows.
 
 ## Usage
-For further info check our **[end to end](end2end.md)** example where we explained how SoaM will interact with Airflow and Cookiecutter on a generic project.
-
-## SoaM CLI
-After installing SoaM locally, there are some commands available:
-
-* `soam init --output`, scaffolding for a project ready to use SoaM. `cookiecutter` will then ask for parameters via prompt.
-[//comment]: # (TODO: Add further info about directories and their functionalities created by cookiecutter. Maybe in end2end.md?)
+For further info check our [end to end](end2end.md) example where we explained how SoaM will interact with Airflow on a generic project.
 
 ## Database management
 For database storing there are complementary tools:

documentation/source/project_structure.md

@@ -50,9 +50,6 @@ This directory contains the migrations for the database that stores the data and
 ### [alembic.ini](../../soam/alembic.ini)
 Configures the alembic library to manage the migrations for the DBSaver.
 
-### templates
-Contains the directory structure that cookiecutter is going to generate.
-
 ### resources
 Files that will be used in the pipeline, like a template for an email report in a postprocess step.
 

documentation/source/references.md

@@ -4,9 +4,7 @@ This is the priority order to understand the dependencies:
  1. prefect
  2. alembic
  3. sqlalchemy
- 4. jinja?
- 5. cookiecuter
- 6. darts
+ 4. jinja
 
 <!--- # (TODO: Ask Pedro to improve the background documents
  with the knowledge learned from delver)--->
@@ -85,12 +83,6 @@ Used in: console.py
 [click docs](https://click.palletsprojects.com/en/7.x/)
 
 
-## cookiecutter
-Used in: console.py
-
-[cookiecutter docs](https://cookiecutter.readthedocs.io/en/latest/)
-
-
 ## datetime
 Used in: constants.py, helpers.py, plot_utils.py, runner.py
 

documentation/source/soam.rst

@@ -26,14 +26,6 @@ soam.cfg module
    :undoc-members:
    :show-inheritance:
 
-soam.console module
--------------------
-
-.. automodule:: soam.console
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 soam.constants module
 ---------------------
 

end2end.md

@@ -1,14 +1,12 @@
 # End to End data product with SoaM:
 
-The purpose of this document is to show how a generic end to end data product would look line using SoaM, [Cookiecutter](https://cookiecutter.readthedocs.io/en/) and [Airflow](http://airflow.apache.org/).
+The purpose of this document is to show how a generic end to end data product would look line using SoaM and [Airflow](http://airflow.apache.org/).
 
 Let's imagine you need to run a process everyday that consists on loading the daily ABT, querying your database, transforming some datapoints, forecasting on a desired timeframe, plotting the results and sharing it by slack with your workteam. After that, promote results to the production environment. The diagram bellow show this process:
 
 ```mermaid
 flowchart LR;
-  soma_main_repo[/SoaM Main Repo/]--->|defines|cookiecutter[/Cookiecutter/];
   raw_data[(Raw Data)]-->load_daily_abt
-  cookiecutter--generates-->soam_instance;
   subgraph DAG
     soam_instance-->promote_to_prod[Promote Results to Production];
     load_daily_abt[Prepare new data in analytics DB]-->soam_instance[SoaM Instance];
@@ -27,21 +25,6 @@ In this case, SoaM and Airflow will be interacting elbow to elbow to get this ru
 
 See the following sections where we double click on this so that it's clearer for you.
 
-
-## Cookiecutter strucutre
-
-[Cookiecutter](https://medium.com/worldsensing-techblog/project-templates-and-cookiecutter-6d8f99a06374) is a CLI tool (Command Line Interface) to create an application boilerplate from a template. It uses a templating system — [Jinja](https://jinja.palletsprojects.com/) — to replace or customize folder and file names, as well as file content.
-
-We use Cookiecutter to save time constructing a new repository, to avoid forgetting mandatory files like Readme or Changelog; and to lower the entry level to new collaborators — new team members, freelancers, partners.
-
-After installing SoaM locally, you can run the following command:
-
-```bash
-$ soam init --output
-```
-
-To generate a project structure ready to use SoaM based on Cookiecutter. After executing that command, cookiecutter will ask you for parameters via prompt.
-
 ## Airflow
 
 We use **Apache Airflow** to create the DAG that schedules the following pipeline:

setup.py

@@ -94,7 +94,6 @@
         "prefect==0.14.17",
         "filelock",
         "click",
-        "cookiecutter",
         "wheel",
         "muttlib>=1.1.2,<2",
         "numpy>=1.19,<1.20",

soam/__init__.py

@@ -1,3 +1,3 @@
 """Version."""
 
-__version__ = '0.8.1'
+__version__ = '0.9.0'