This project is dedicated to visualizing financial data, particularly focusing on the generation of charts for social media. It is structured into two primary components: data collection/cleaning and chart generation.
The project is organized into the following directories:
.
├── raw/
│ ├── sp500_earnings_yield.csv
│ └── us10y_yield.csv
├── charts.ipynb
├── data.ipynb
└── requirements.txt
raw/
: Contains the raw data files.charts.ipynb
: Notebook for generating charts.data.ipynb
: Notebook for data collection and cleaning.requirements.txt
: Lists the Python package dependencies.
After running the notebooks for the first time, you will also have the following directories:
chart/
: Stores the output charts. Generated by thecharts.ipynb
notebook.clean/
: Contains cleaned data files, ready for analysis. Generated by thedata.ipynb
notebook.
- Abstract the data source name and URL into the CSV
- Create GitHub repository
- Commit code
- Add license
-
Clone the repository to your local machine.
-
Choose the appropriate Python environment for the project.
pyenv local 3.11.9
-
Install the required packages:
pipenv install
- Run the
data.ipynb
notebook.- This notebook will process the raw data located in the
raw/
directory. - The cleaned data will be saved in the
clean/
directory.
- This notebook will process the raw data located in the
- Run the
charts.ipynb
notebook.- This notebook will read the cleaned data from the
clean/
directory. - It will generate charts based on the processed data and save them in the
chart/
directory.
- This notebook will read the cleaned data from the
- The output charts will be stored in the
chart/
directory. For example,earnings_yield_cycle_plot.png
is a chart generated by thecharts.ipynb
notebook.
Feel free to fork this repository and contribute to enhancing the functionalities of the project. For major changes, please open an issue first to discuss what you would like to change.
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.