From c483e5f55509506c33d2d8bf711b221f85d4e49e Mon Sep 17 00:00:00 2001 From: "Micha R. Albert" Date: Wed, 23 Jul 2025 11:18:10 -0400 Subject: [PATCH] Add simple home page --- .gitignore | 203 +++++++++++++++++++++++++++ pyproject.toml | 6 +- src/carbon_copy/__init__.py | 4 + src/carbon_copy/main.py | 24 ++++ src/carbon_copy/templates/index.html | 13 ++ 5 files changed, 249 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 src/carbon_copy/main.py create mode 100644 src/carbon_copy/templates/index.html diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cb0f8dc --- /dev/null +++ b/.gitignore @@ -0,0 +1,203 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[codz] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.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 + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.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 +#poetry.toml + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python. +# https://pdm-project.org/en/latest/usage/project/#working-with-version-control +#pdm.lock +#pdm.toml +.pdm-python +.pdm-build/ + +# pixi +# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control. +#pixi.lock +# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one +# in the .venv directory. It is recommended not to include this directory in version control. +.pixi + +# 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 +.envrc +.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/ + +# Abstra +# Abstra is an AI-powered process automation framework. +# Ignore directories containing user credentials, local state, and settings. +# Learn more at https://abstra.io/docs +.abstra/ + +# Visual Studio Code +# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore +# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore +# and can be added to the global gitignore or merged into this file. However, if you prefer, +# you could uncomment the following to ignore the entire vscode folder +# .vscode/ + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + +# Marimo +marimo/_static/ +marimo/_lsp/ +__marimo__/ + +# Streamlit +.streamlit/secrets.toml diff --git a/pyproject.toml b/pyproject.toml index 9766a71..e9cc741 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -20,7 +20,11 @@ classifiers = [ "Programming Language :: Python :: 3.13", "Programming Language :: Python :: Implementation :: CPython", ] -dependencies = [] +dependencies = [ + "fastapi~=0.116.1", + "uvicorn[standard]~=0.35.0", + "jinja2~=3.1.6", +] [project.urls] Documentation = "https://github.com/Micha Albert/carbon-copy#readme" diff --git a/src/carbon_copy/__init__.py b/src/carbon_copy/__init__.py index 166a19d..9550e0e 100644 --- a/src/carbon_copy/__init__.py +++ b/src/carbon_copy/__init__.py @@ -1,3 +1,7 @@ # SPDX-FileCopyrightText: 2025-present Micha Albert # # SPDX-License-Identifier: MIT + +from .main import app + +__all__ = ["app"] diff --git a/src/carbon_copy/main.py b/src/carbon_copy/main.py new file mode 100644 index 0000000..9b3a7ba --- /dev/null +++ b/src/carbon_copy/main.py @@ -0,0 +1,24 @@ +# SPDX-FileCopyrightText: 2025-present Micha Albert +# +# SPDX-License-Identifier: MIT + +from pathlib import Path +from fastapi import FastAPI, Request +from fastapi.templating import Jinja2Templates + +# Get the directory where this file is located +BASE_DIR = Path(__file__).resolve().parent + +app = FastAPI( + title="Carbon Copy", + description="An email-based multiplayer text adventure for the masses", + version="0.0.1" +) + +templates = Jinja2Templates(directory=BASE_DIR / "templates") + +# Serve the home page +@app.get("/") +async def root(request: Request): + """Return the home page""" + return templates.TemplateResponse("index.html", {"request": request}) diff --git a/src/carbon_copy/templates/index.html b/src/carbon_copy/templates/index.html new file mode 100644 index 0000000..6bcc55e --- /dev/null +++ b/src/carbon_copy/templates/index.html @@ -0,0 +1,13 @@ + + + + + + + Carbon Copy + + +

Hello World

+

Welcome to Carbon Copy!

+ +