OpenBB
OpenBB copied to clipboard
[🕹️] Add Example Notebook Demonstrating Fundamental Analysis with OpenBB
📄 Task
Create a Jupyter notebook for our examples folder that demonstrates how to fetch financial KPIs and analyze valuations of public companies.
📋 Requirements:
- Template: Start by copying the example template notebook.
-
Content:
- Give your notebook a meaningful name.
- Fill in the details in the template, including the notebook title, description, your GitHub username, the notebook name in the Google Colab button, and any additional sections relevant to the task.
- Write code that uses OpenBB's features to perform the analysis.
- If your notebook requires additional dependencies, please specify those.
- Testing: Ensure that all cells in the notebook run successfully and produce the intended results.
- Documentation: Comment your code and to explain what each part does, and add markdown cells where necessary to provide explanations for the analysis.
-
Output: The final notebook should be added to the
examples
folder in this repository.
💡 Tips:
- You can refer to the OpenBB Documentation for additional guidance on using OpenBB features.
- If you encounter any issues, feel free to reach out for help in the discussions section or look at other example notebooks for inspiration.
📬 Submission:
- Follow the submission instructions detailed here
- Open a Pull Request (PR) to the
develop
branch. - Include a brief description of your notebook and the analysis it performs in the PR body.
- Provide a working example of your notebook (e.g., screenshots of the output or a video demonstration) if possible.
Happy hacking!