First commit

README.md

@@ -1,20 +1,30 @@
 # Introduction 
-TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. 
+Small repository to save and share Jupyter Notebooks within Data Team.
 
 # Getting Started
-TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
-1.	Installation process
-2.	Software dependencies
-3.	Latest releases
-4.	API references
 
-# Build and Test
-TODO: Describe and show how to build your code and run the tests. 
+### Basics
 
-# Contribute
-TODO: Explain how other users and developers can contribute to make your code better. 
+- Pre-requisites
+  - You need a Linux environment. That can be Linux, macOS or WSL.
+  - You need to have Python `>=3.10` installed.
+  - All docs will assume you are using VSCode.
+  - Also install the following VSCode Python extension: ms-python.python
+- Set up
+  - Create a virtual environment for the project with `python3 -m venv venv`.
+  - It's recommended that you set up the new `venv` as your default interpreter for VSCode. To do this, click Ctrl+Shift+P, and look for the `Python: Select interpreter` option. Choose the new `venv`.
+  - Ensure that VS code is using this virtual environment. You can activate it by running `source venv/bin/activate`
+  - Activate the virtual environment and run `pip install -r requirements.txt`
+- Lastly, you need to install the following extension to ensure VS code can render the notebooks.
+https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter
 
-If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
-- [ASP.NET Core](https://github.com/aspnet/Home)
-- [Visual Studio Code](https://github.com/Microsoft/vscode)
-- [Chakra Core](https://github.com/Microsoft/ChakraCore)
+### DWH connection
+In order to connect to DWH, you will need to create a local file with the credentials. You can use the file `credentials_example.yml`. Remember to fill the user and password. 
+
+Once done, you need to save the credentials file in your local path:
+`/home/{your_user}/.superhog-dwh/credentials.yml`
+
+Since this file has credentials, we need to secure it by ensuring that only your user has permissions. You need to run:
+`chmod 600 /home/{your_user}/.superhog-dwh/credentials.yml`
+
+Once you've handled the previous steps, you can try to run the code in the template.ipynb file. If it works, then everything is successful. If not, check with someone in Data Team.