Merge pull request #15 from Spherre-Labs/feat/setup-backend-application

DanielEmmanuel1 · web-flow · commit 859ce30e9864 · 2025-03-14T15:33:59.000+01:00
Setup backend application
diff --git a/.github/workflows/backend_lint.yml b/.github/workflows/backend_lint.yml
@@ -0,0 +1,42 @@
+name: Backend Lint and Code Formatting Check
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  frontend-lint-and-format:
+    runs-on: ubuntu-latest
+    steps:
+      # Step 1: Check out the code
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # Step 2: Set up Node.js
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      # Step 3: Install dependencies
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+        working-directory: backend
+          
+      # Step 4: Run Ruff Lint
+      - name: Run Ruff Lint
+        run: |
+          ruff check .
+        working-directory: backend
+      
+      # Step 5: Run Ruff for formatting
+      - name: Run Ruff for formatting
+        run: ruff format --check .
+        working-directory: backend
diff --git a/backend/.env.example b/backend/.env.example
@@ -0,0 +1,2 @@
+DB_CONNECTION_STRING=sqlite:///db.sqlite3
+SECRET_KEY=spherregonnabegreat25
diff --git a/backend/.gitignore b/backend/.gitignore
@@ -0,0 +1,8 @@
+env/
+.env
+.ruff_cache/
+instance/
+.webassets-cache
+__pycache__/
+*.py[cod]
+*$py.class
diff --git a/backend/Makefile b/backend/Makefile
@@ -0,0 +1,12 @@
+build:
+	pip install -r requirements.txt
+
+format:
+	ruff format .
+	ruff check . --fix --select I
+
+lint:
+	ruff check .
+
+start:
+	python spherre/wsgi.py
diff --git a/backend/README.md b/backend/README.md
@@ -1 +1,63 @@
-## Spherre Backend
+## Spherre Backend
+This is the official backend for the spherre multisig
+
+## Installation
+
+### Prerequisites
+
+- Python 3.8 or higher
+- Make
+
+### Steps
+1. **Clone the repository**:
+    ```bash
+    git clone https://github.com/your-username/spherre-dapp.git
+    cd spherre-dapp/backend/
+    ```
+3. **Create a virtual environment and initialize it**
+    ```bash
+    virtualenv env
+    source env/bin/activate # for linux
+    ```
+2. **Install dependencies**:
+    ```bash
+    make build
+    ```
+3. **Start the Application**:
+    ```bash
+    make install
+    ```
+
+## Contributing
+1. Fork this repository
+2. Create a new branch:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+   or 
+   ```bash
+   git checkout -b fix/issue-number
+   ```
+
+
+3. Make your changes
+
+4. Commit your changes:
+    ```bash
+   git commit -m "feat: Description of changes"
+   ```
+
+### Linting and Formatting
+Before submitting your changes, ensure:
+
+1. Code is linted:
+
+   ```bash
+   make lint
+   ```
+
+2. Code is formatted:
+
+   ```bash
+   make format
+   ```
diff --git a/backend/pyproject.toml b/backend/pyproject.toml
@@ -0,0 +1,76 @@
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "learnbestia.settings"
+pythonpath = ["src", "tests"]
+python_files = [
+    "test_*.py",
+    "*_test.py",
+    "testing/python/*.py"
+]
+norecursedirs = [
+    "scripts",
+    "node_modules",
+    "py-requirements",
+    "webpack",
+    ".*",
+    "{args}"
+]
+
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+    "migrations",
+    "env",
+]
+
+line-length = 88
+target-version = "py312"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E", "E4", "E7", "E9", "F", "I001"]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = false
+docstring-code-line-length = "dynamic"
+
+[tool.poetry]
+name = "spherre"
+version = "0.1.0"
+description = "API for spherre"
+authors = ["codebestia"]
+readme = "README.md"
+package-mode = false
diff --git a/backend/requirements.txt b/backend/requirements.txt
@@ -0,0 +1,94 @@
+aiohappyeyeballs==2.6.1
+aiohttp==3.11.13
+aiosignal==1.3.2
+aniso8601==10.0.0
+anyio==4.8.0
+apibara==0.8.0
+asgiref==3.8.1
+attrs==25.3.0
+blinker==1.9.0
+build==1.2.2.post1
+CacheControl==0.14.2
+cached-property==2.0.1
+certifi==2025.1.31
+cffi==1.17.1
+charset-normalizer==3.4.1
+cleo==2.1.0
+click==8.1.8
+crashtest==0.4.1
+crypto_cpp_py==1.4.5
+cryptography==44.0.2
+cytoolz==1.0.1
+distlib==0.3.9
+dulwich==0.22.8
+ecdsa==0.18.0
+eth-hash==0.7.1
+eth-keyfile==0.9.1
+eth-keys==0.6.1
+eth-typing==5.2.0
+eth-utils==5.2.0
+fastjsonschema==2.21.1
+filelock==3.17.0
+findpython==0.6.3
+Flask==3.1.0
+Flask-RESTful==0.3.10
+frozenlist==1.5.0
+greenlet==3.1.1
+grpcio==1.71.0
+h11==0.14.0
+httpcore==1.0.7
+httpx==0.28.1
+idna==3.10
+installer==0.7.0
+itsdangerous==2.2.0
+jaraco.classes==3.4.0
+jaraco.context==6.0.1
+jaraco.functools==4.1.0
+jeepney==0.9.0
+Jinja2==3.1.6
+keyring==25.6.0
+lark==1.2.2
+MarkupSafe==3.0.2
+marshmallow==3.26.1
+marshmallow-oneofschema==3.1.1
+marshmallow_dataclass==8.7.1
+more-itertools==10.6.0
+mpmath==1.3.0
+msgpack==1.1.0
+multidict==6.1.0
+mypy-extensions==1.0.0
+packaging==24.2
+pbs-installer==2025.3.11
+pkginfo==1.12.1.2
+platformdirs==4.3.6
+poetry-core==2.1.1
+poseidon_py==0.1.5
+propcache==0.3.0
+protobuf==4.25.6
+py-ecc==7.0.1
+pycparser==2.22
+pycryptodome==3.21.0
+pyproject_hooks==1.2.0
+pytz==2025.1
+RapidFuzz==3.12.2
+requests==2.32.3
+requests-toolbelt==1.0.0
+ruff==0.9.10
+SecretStorage==3.3.3
+shellingham==1.5.4
+six==1.17.0
+sniffio==1.3.1
+SQLAlchemy==2.0.39
+starknet-py==0.25.0
+sympy==1.12.1
+tomlkit==0.13.2
+toolz==1.0.0
+trove-classifiers==2025.3.3.18
+typeguard==4.4.2
+typing-inspect==0.9.0
+typing_extensions==4.12.2
+urllib3==2.3.0
+virtualenv==20.29.3
+Werkzeug==3.1.3
+yarl==1.18.3
+zstandard==0.23.0
diff --git a/backend/spherre/__init__.py b/backend/spherre/__init__.py
diff --git a/backend/spherre/app.py b/backend/spherre/app.py
@@ -0,0 +1,12 @@
+from flask_restful import Api, Resource
+from settings import app
+
+api = Api(app)
+
+
+class TestView(Resource):
+    def get(self):
+        return {"message": "Hello world"}
+
+
+api.add_resource(TestView, "/")
diff --git a/backend/spherre/models.py b/backend/spherre/models.py
diff --git a/backend/spherre/serializers.py b/backend/spherre/serializers.py
diff --git a/backend/spherre/settings.py b/backend/spherre/settings.py
@@ -0,0 +1,10 @@
+import os
+from datetime import timedelta
+
+from flask import Flask
+
+app = Flask(__name__)
+app.secret_key = os.environ.get("SECRET_KEY")
+app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("DB_CONNECTION_STRING")
+app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
+app.permanent_session_lifetime = timedelta(days=1)
diff --git a/backend/spherre/views.py b/backend/spherre/views.py
diff --git a/backend/spherre/wsgi.py b/backend/spherre/wsgi.py
@@ -0,0 +1,6 @@
+from settings import app as flask_app
+
+if __name__ == "__main__":
+    import app  # noqa
+
+    flask_app.run(debug=True)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+DB_CONNECTION_STRING=sqlite:///db.sqlite3`
	`2`	`+SECRET_KEY=spherregonnabegreat25`