Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgements

About The Project

This is an application that pulls and analyzes etf data from a database.

Built With

• Python
• Python CSV Reading/Writing
• Python pandas
• Python hvplot.pandas
• Python conda
• Python JupyterLab

Getting Started

• You don't need Python. You can install Anaconda and JupyterLab normally just like any other application on your computer. Follow the instructions for Anaconda, ensure that its working, then install JupyterLab.

• I have placed Comments throughout the code so that you can follow the code and be able to replicate the app on your own. Also, so that you're able to contribute in the future :-)

Prerequisites

A text editor such as VS Code or Sublime Text

Installation

1. Clone the repo

   git clone https://github.com/AnaIitico/etf_analyzer.git

2. You don't need to install pip - Conda comes with pip and you can also use the command conda install 'package name'

3. Install Conda according to the instructions based on your operating system. For windows users you MUST use the Administrator PowerShell. Users with AMD Processors MUST use the Administrator PowerShell 7 (X64) version

   Once installed Conda has an Admin PowerShell version shortcut - look on your Start menu for it. This shortcut will prove very useful at times when you need to install other apps or make adjustments to your installation

   Once installed you will see (base) on your terminal

4. Activate Conda Dev environment

   conda activate dev

   You should now see (dev) on your terminal

5. Install JupyterLabs

   pip install jupyterlab

6. Run JupyterLabs

   jupyter lab

   A browser window should open on localhost:8888/lab

Usage

This project is an app that pulls data from a database and analyzes it.

Roadmap

The app is complete

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Jose Tollinchi - @josetollinchi - jtollinchi1971@gmail.com

Project Link: https://github.com/AnaIitico/etf_analyzer

Acknowledgements

Other Dependencies used to build the project.

Search google for the correct conda install command

• numpy

• pandas

• sqlalchemy

• Img Shields

• Choose an Open Source License