{"id":22111333,"url":"https://github.com/simfin/simfin-tutorials","last_synced_at":"2025-04-06T00:09:36.038Z","repository":{"id":39731717,"uuid":"210851843","full_name":"SimFin/simfin-tutorials","owner":"SimFin","description":"Tutorials for SimFin - Simple financial data for Python","archived":false,"fork":false,"pushed_at":"2024-07-30T21:17:02.000Z","size":6348,"stargazers_count":276,"open_issues_count":4,"forks_count":72,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-29T22:11:13.672Z","etag":null,"topics":["finance","financial-data","google-colab","notebook","python","simfin"],"latest_commit_sha":null,"homepage":"https://simfin.com/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SimFin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-25T13:26:40.000Z","updated_at":"2025-03-20T10:34:14.000Z","dependencies_parsed_at":"2024-12-01T10:39:06.778Z","dependency_job_id":"979f5fbf-d109-49e4-a30b-aa06c32ba95e","html_url":"https://github.com/SimFin/simfin-tutorials","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimFin%2Fsimfin-tutorials","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimFin%2Fsimfin-tutorials/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimFin%2Fsimfin-tutorials/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimFin%2Fsimfin-tutorials/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SimFin","download_url":"https://codeload.github.com/SimFin/simfin-tutorials/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415967,"owners_count":20935387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["finance","financial-data","google-colab","notebook","python","simfin"],"created_at":"2024-12-01T10:38:58.538Z","updated_at":"2025-04-06T00:09:36.005Z","avatar_url":"https://github.com/SimFin.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SimFin Tutorials\n\n[Original repository on GitHub](https://github.com/simfin/simfin-tutorials)\n\n\n## Introduction\n\n[SimFin](https://github.com/simfin/simfin) is a database with financial\ndata such as Income Statements, Balance Sheets and Cash Flow Statements,\nalong with a simple Python API for downloading and using the data. These\ntutorials show how to use the SimFin API and data.\n\n\n## Videos\n\nThere is a [video](https://www.youtube.com/watch?v=nCY8a0KeeAE)\non YouTube with an overview of these tutorials,\nand [another video](https://www.youtube.com/watch?v=zstXCc8iV2U)\non how to backtest and optimize a stock-screener based on Tutorial 7.\n\n\n## Tutorials\n\n1. Basics ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/01_Basics.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/01_Basics.ipynb))\n2. Resampling ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/02_Resampling.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/02_Resampling.ipynb))\n3. Growth \u0026 Returns ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/03_Growth_Returns.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/03_Growth_Returns.ipynb))\n4. Signals ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/04_Signals.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/04_Signals.ipynb))\n5. Data Hubs ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/05_Data_Hubs.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/05_Data_Hubs.ipynb))\n6. Performance Tips ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/06_Performance_Tips.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/06_Performance_Tips.ipynb))\n7. Stock Screener ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/07_Stock_Screener.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/07_Stock_Screener.ipynb))\n8. Statistical Analysis ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/08_Statistical_Analysis.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/08_Statistical_Analysis.ipynb))\n9. Machine Learning ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/09_Machine_Learning.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/09_Machine_Learning.ipynb))\n10. Neural Networks ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/10_Neural_Networks.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/10_Neural_Networks.ipynb))\n\nThere is also a collection of small recipes ([Notebook](https://github.com/simfin/simfin-tutorials/blob/master/Small_Recipes.ipynb)) ([Google Colab](https://colab.research.google.com/github/simfin/simfin-tutorials/blob/master/Small_Recipes.ipynb))\n\n\n## Downloading\n\nIf you want to run these tutorials on your own computer, then it is\nrecommended that you download the whole repository from GitHub,\ninstead of just downloading the individual Python Notebooks.\n\n\n### Git\n\nThe easiest way to download and install this is by using git from the command-line:\n\n    git clone https://github.com/simfin/simfin-tutorials.git\n\nThis creates the directory `simfin-tutorials` and downloads all the files to it.\n\nThis also makes it easy to update the files, simply by executing this\ncommand inside that directory:\n\n    git pull\n\n\n### Zip-File\n\nYou can also [download](https://github.com/simfin/simfin-tutorials/archive/master.zip)\nthe contents of the GitHub repository as a Zip-file and extract it manually.\n\n\n## Installation\n\nIf you want to run these tutorials on your own computer, then it is best\nto use a virtual environment when installing the required packages,\nso you can easily delete the environment again. You write the following\nin a Linux terminal:\n\n    virtualenv simfin-env\n\nOr you can use [Anaconda](https://www.anaconda.com/download) instead of a virtualenv:\n\n    conda create --name simfin-env python=3\n\nThen you switch to the virtual environment and install the required packages.\n\n    source activate simfin-env\n    pip install -r requirements.txt\n\nWhen you are done working on the project you can deactivate the virtualenv:\n\n    source deactivate\n\n\n## How To Run\n\nOnce you have installed the required Python packages in a virtual environment,\nyou run the following command from the `simfin-tutorials` directory to view\nand edit the Notebooks:\n\n    source activate simfin-env\n    jupyter notebook\n\n\n### Run in Google Colab\n\nIf you do not want to install anything on your own computer, then the Notebooks\ncan be viewed, edited and run entirely on the internet by using\n[Google Colab](https://colab.research.google.com).\n\nYou can click the \"Google Colab\"-link next to the tutorials listed above.\nYou can view the Notebook on Colab but in order to run it you need to login using\nyour Google account.\n\nAll the required Python packages should already be installed on Google Colab,\nexcept for simfin which you can install by executing the following command\nat the top of the Notebook:\n\n    !pip install simfin\n\nIf that is insufficient, then you can clone this entire GitHub repository\nto your Google Colab account, and execute the following commands at the\ntop of the Notebook, to install all requirements:\n\n    # Clone the repository from GitHub to Google Colab's temporary drive.\n    import os\n    work_dir = \"/content/simfin-tutorials/\"\n    if not os.path.exists(work_dir):\n        !git clone https://github.com/simfin/simfin-tutorials.git\n    os.chdir(work_dir)\n    \n    # Install the required Python packages.\n    !pip install -r requirements.txt\n\nNote that you will need to run this every time you login to Google Colab.\n\n## Testing\n\nAll the Notebooks can be run automatically and tested for errors. This is\nparticularly useful for developers who are making changes to the simfin\npackage, because it complements the unit-tests and data-tests with more\nrealistic use-cases.\n\nFirst you need to install [nbval](https://pypi.org/project/nbval/):\n\n    pip install nbval\n\nThen you can execute all the Notebooks and test them for errors by running\nthe following command from the directory where the Notebooks are located:\n \n    pytest --nbval-lax -v\n\nNote that this will only test for errors and exceptions. It will not test\nwhether the new output matches the old output found in the Notebooks,\nbecause the datasets are continually updated.\n\n\n## License (MIT)\n\nThis is published under the\n[MIT License](https://github.com/simfin/simfin-tutorials/blob/master/LICENSE.txt)\nwhich allows very broad use for both academic and commercial purposes.\n\nYou are very welcome to modify and use this source-code in your own project.\nPlease keep a link to the [original repository](https://github.com/simfin/simfin-tutorials).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimfin%2Fsimfin-tutorials","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimfin%2Fsimfin-tutorials","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimfin%2Fsimfin-tutorials/lists"}