Merge pull request #1 from gamejamco/main-github

Main GitHub

.gitignore

@@ -0,0 +1,170 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+.idea
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.DS_Store
+cli/*.csv
+cli/test.py
+cli/output/
+cli/input/
+
+airflow/logs/
+airflow/plugins/

.vscode/settings.json

@@ -0,0 +1,36 @@
+{
+    "fileHeaderComment.template": {
+        "mit": [
+            "${commentprefix} ${license_mit}",
+        ]
+    },
+    "fileHeaderComment.parameter": {
+        "*": {
+            "commentprefix": "#",
+            "author": "Gamejam.com",
+            "license_mit": [
+                "The MIT License (MIT)",
+                " Copyright (c) ${year} ${author}",
+                "",
+                " Permission is hereby granted, free of charge, to any person obtaining a copy of this software",
+                " and associated documentation files (the \"Software\"), to deal in the Software without restriction,",
+                " including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,",
+                " and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,",
+                " subject to the following conditions:",
+                "",
+                " The above copyright notice and this permission notice shall be included in all copies or substantial",
+                " portions of the Software.",
+                "",
+                " THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED",
+                " TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL",
+                " THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,",
+                " TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
+            ]
+        }
+    },
+    "python.analysis.extraPaths": [
+        "./cli",
+        "./airflow/dags"
+    ],
+    "python.formatting.provider": "autopep8"
+}

README.md

@@ -1 +1,18 @@
-# solana-etl
+# Solana ETL
+
+## Overview
+
+Solana ETL allows you to setup an ETL pipeline in Google Cloud Platform for ingesting Solana blockchain data
+into BigQuery. It comes with [CLI tools](/cli) for exporting Solana data into convenient formats like CSVs and relational databases.
+
+## Code quality
+
+Over time, we intend to format python files in this repo using isort and autopep8.
+At the moment, we are *only formatting any changed or added files*
+
+We have not implemented any sort of automation (e.g. pre-commit), but a requirements_dev.txt is provided for contributors to use.
+
+## Testing
+
+Various tests are implemented (`airflow/tests`, `cli/tests` and `./tests`).
+As part of an effort towards consistency, they all source the same requirements_test.txt.