Add Streamlit app and Xet image helpers
Browse files- .gitattributes +2 -34
- .gitignore +174 -0
- Dockerfile +9 -13
- LICENSE +674 -0
- app.py +37 -0
- config.toml +17 -0
- huggingface-metadata.yaml +8 -0
- img/3blue1brown.png +3 -0
- img/Computerphile.png +3 -0
- img/CrashCourse.png +3 -0
- img/Harvard.png +3 -0
- img/KhanAcademy.png +3 -0
- img/MIT OpenCourseWare.png +3 -0
- img/ProgrammingWithMosh.png +3 -0
- img/SciShow.png +3 -0
- img/Stanford Online.png +3 -0
- img/TED.png +3 -0
- img/TEDEd.png +3 -0
- img/TEDx.png +3 -0
- img/Udacity.png +3 -0
- img/Veritasium.png +3 -0
- img/YaleCourses.png +3 -0
- img/coursera.png +3 -0
- img/cover_page.jpg +3 -0
- img/edX.png +3 -0
- img/freeCodeCamp.png +3 -0
- img/minutephysics.png +3 -0
- img/numberphile.png +3 -0
- img/user_flow_system_architecture.jpg +3 -0
- requirements.txt +13 -3
- scripts/api_lambda_call.py +24 -0
- scripts/create_iam_role.py +144 -0
- src/__init__.py +0 -0
- src/pages/__init__.py +7 -0
- src/pages/_about_page.py +168 -0
- src/pages/_contact_page.py +39 -0
- src/pages/_home_page.py +628 -0
- src/utils/__init__.py +1 -0
- src/utils/helpers.py +317 -0
- src/utils/settings.py +50 -0
.gitattributes
CHANGED
|
@@ -1,35 +1,3 @@
|
|
| 1 |
-
*.
|
| 2 |
-
*.arrow filter=lfs diff=lfs merge=lfs -text
|
| 3 |
-
*.bin filter=lfs diff=lfs merge=lfs -text
|
| 4 |
-
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
| 5 |
-
*.ckpt filter=lfs diff=lfs merge=lfs -text
|
| 6 |
-
*.ftz filter=lfs diff=lfs merge=lfs -text
|
| 7 |
-
*.gz filter=lfs diff=lfs merge=lfs -text
|
| 8 |
-
*.h5 filter=lfs diff=lfs merge=lfs -text
|
| 9 |
-
*.joblib filter=lfs diff=lfs merge=lfs -text
|
| 10 |
-
*.lfs.* filter=lfs diff=lfs merge=lfs -text
|
| 11 |
-
*.mlmodel filter=lfs diff=lfs merge=lfs -text
|
| 12 |
-
*.model filter=lfs diff=lfs merge=lfs -text
|
| 13 |
-
*.msgpack filter=lfs diff=lfs merge=lfs -text
|
| 14 |
-
*.npy filter=lfs diff=lfs merge=lfs -text
|
| 15 |
-
*.npz filter=lfs diff=lfs merge=lfs -text
|
| 16 |
-
*.onnx filter=lfs diff=lfs merge=lfs -text
|
| 17 |
-
*.ot filter=lfs diff=lfs merge=lfs -text
|
| 18 |
-
*.parquet filter=lfs diff=lfs merge=lfs -text
|
| 19 |
-
*.pb filter=lfs diff=lfs merge=lfs -text
|
| 20 |
-
*.pickle filter=lfs diff=lfs merge=lfs -text
|
| 21 |
*.pkl filter=lfs diff=lfs merge=lfs -text
|
| 22 |
-
|
| 23 |
-
*.pth filter=lfs diff=lfs merge=lfs -text
|
| 24 |
-
*.rar filter=lfs diff=lfs merge=lfs -text
|
| 25 |
-
*.safetensors filter=lfs diff=lfs merge=lfs -text
|
| 26 |
-
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
| 27 |
-
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
| 28 |
-
*.tar filter=lfs diff=lfs merge=lfs -text
|
| 29 |
-
*.tflite filter=lfs diff=lfs merge=lfs -text
|
| 30 |
-
*.tgz filter=lfs diff=lfs merge=lfs -text
|
| 31 |
-
*.wasm filter=lfs diff=lfs merge=lfs -text
|
| 32 |
-
*.xz filter=lfs diff=lfs merge=lfs -text
|
| 33 |
-
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
-
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
-
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
|
|
|
| 1 |
+
*.csv filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
*.pkl filter=lfs diff=lfs merge=lfs -text
|
| 3 |
+
img/* filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.gitignore
ADDED
|
@@ -0,0 +1,174 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Byte-compiled / optimized / DLL files
|
| 2 |
+
__pycache__/
|
| 3 |
+
*.py[cod]
|
| 4 |
+
*$py.class
|
| 5 |
+
|
| 6 |
+
# C extensions
|
| 7 |
+
*.so
|
| 8 |
+
|
| 9 |
+
# Distribution / packaging
|
| 10 |
+
.Python
|
| 11 |
+
build/
|
| 12 |
+
develop-eggs/
|
| 13 |
+
dist/
|
| 14 |
+
downloads/
|
| 15 |
+
eggs/
|
| 16 |
+
.eggs/
|
| 17 |
+
lib/
|
| 18 |
+
lib64/
|
| 19 |
+
parts/
|
| 20 |
+
sdist/
|
| 21 |
+
var/
|
| 22 |
+
wheels/
|
| 23 |
+
share/python-wheels/
|
| 24 |
+
*.egg-info/
|
| 25 |
+
.installed.cfg
|
| 26 |
+
*.egg
|
| 27 |
+
MANIFEST
|
| 28 |
+
|
| 29 |
+
# PyInstaller
|
| 30 |
+
# Usually these files are written by a python script from a template
|
| 31 |
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
| 32 |
+
*.manifest
|
| 33 |
+
*.spec
|
| 34 |
+
|
| 35 |
+
# Installer logs
|
| 36 |
+
pip-log.txt
|
| 37 |
+
pip-delete-this-directory.txt
|
| 38 |
+
|
| 39 |
+
# Unit test / coverage reports
|
| 40 |
+
htmlcov/
|
| 41 |
+
.tox/
|
| 42 |
+
.nox/
|
| 43 |
+
.coverage
|
| 44 |
+
.coverage.*
|
| 45 |
+
.cache
|
| 46 |
+
nosetests.xml
|
| 47 |
+
coverage.xml
|
| 48 |
+
*.cover
|
| 49 |
+
*.py,cover
|
| 50 |
+
.hypothesis/
|
| 51 |
+
.pytest_cache/
|
| 52 |
+
cover/
|
| 53 |
+
|
| 54 |
+
# Translations
|
| 55 |
+
*.mo
|
| 56 |
+
*.pot
|
| 57 |
+
|
| 58 |
+
# Django stuff:
|
| 59 |
+
*.log
|
| 60 |
+
local_settings.py
|
| 61 |
+
db.sqlite3
|
| 62 |
+
db.sqlite3-journal
|
| 63 |
+
|
| 64 |
+
# Flask stuff:
|
| 65 |
+
instance/
|
| 66 |
+
.webassets-cache
|
| 67 |
+
|
| 68 |
+
# Scrapy stuff:
|
| 69 |
+
.scrapy
|
| 70 |
+
|
| 71 |
+
# Sphinx documentation
|
| 72 |
+
docs/_build/
|
| 73 |
+
|
| 74 |
+
# PyBuilder
|
| 75 |
+
.pybuilder/
|
| 76 |
+
target/
|
| 77 |
+
|
| 78 |
+
# Jupyter Notebook
|
| 79 |
+
.ipynb_checkpoints
|
| 80 |
+
|
| 81 |
+
# IPython
|
| 82 |
+
profile_default/
|
| 83 |
+
ipython_config.py
|
| 84 |
+
|
| 85 |
+
# pyenv
|
| 86 |
+
# For a library or package, you might want to ignore these files since the code is
|
| 87 |
+
# intended to run in multiple environments; otherwise, check them in:
|
| 88 |
+
# .python-version
|
| 89 |
+
|
| 90 |
+
# pipenv
|
| 91 |
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
| 92 |
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
| 93 |
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
| 94 |
+
# install all needed dependencies.
|
| 95 |
+
#Pipfile.lock
|
| 96 |
+
|
| 97 |
+
# UV
|
| 98 |
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
| 99 |
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
| 100 |
+
# commonly ignored for libraries.
|
| 101 |
+
#uv.lock
|
| 102 |
+
|
| 103 |
+
# poetry
|
| 104 |
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
| 105 |
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
| 106 |
+
# commonly ignored for libraries.
|
| 107 |
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
| 108 |
+
#poetry.lock
|
| 109 |
+
|
| 110 |
+
# pdm
|
| 111 |
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
| 112 |
+
#pdm.lock
|
| 113 |
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
| 114 |
+
# in version control.
|
| 115 |
+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
| 116 |
+
.pdm.toml
|
| 117 |
+
.pdm-python
|
| 118 |
+
.pdm-build/
|
| 119 |
+
|
| 120 |
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
| 121 |
+
__pypackages__/
|
| 122 |
+
|
| 123 |
+
# Celery stuff
|
| 124 |
+
celerybeat-schedule
|
| 125 |
+
celerybeat.pid
|
| 126 |
+
|
| 127 |
+
# SageMath parsed files
|
| 128 |
+
*.sage.py
|
| 129 |
+
|
| 130 |
+
# Environments
|
| 131 |
+
.env
|
| 132 |
+
.venv
|
| 133 |
+
env/
|
| 134 |
+
venv/
|
| 135 |
+
ENV/
|
| 136 |
+
env.bak/
|
| 137 |
+
venv.bak/
|
| 138 |
+
|
| 139 |
+
# Spyder project settings
|
| 140 |
+
.spyderproject
|
| 141 |
+
.spyproject
|
| 142 |
+
|
| 143 |
+
# Rope project settings
|
| 144 |
+
.ropeproject
|
| 145 |
+
|
| 146 |
+
# mkdocs documentation
|
| 147 |
+
/site
|
| 148 |
+
|
| 149 |
+
# mypy
|
| 150 |
+
.mypy_cache/
|
| 151 |
+
.dmypy.json
|
| 152 |
+
dmypy.json
|
| 153 |
+
|
| 154 |
+
# Pyre type checker
|
| 155 |
+
.pyre/
|
| 156 |
+
|
| 157 |
+
# pytype static type analyzer
|
| 158 |
+
.pytype/
|
| 159 |
+
|
| 160 |
+
# Cython debug symbols
|
| 161 |
+
cython_debug/
|
| 162 |
+
|
| 163 |
+
# PyCharm
|
| 164 |
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
| 165 |
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
| 166 |
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
| 167 |
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
| 168 |
+
#.idea/
|
| 169 |
+
|
| 170 |
+
# Ruff stuff:
|
| 171 |
+
.ruff_cache/
|
| 172 |
+
|
| 173 |
+
# PyPI configuration file
|
| 174 |
+
.pypirc
|
Dockerfile
CHANGED
|
@@ -1,20 +1,16 @@
|
|
| 1 |
-
FROM python:3.
|
| 2 |
|
| 3 |
WORKDIR /app
|
| 4 |
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
git \
|
| 9 |
-
&& rm -rf /var/lib/apt/lists/*
|
| 10 |
|
| 11 |
-
|
| 12 |
-
COPY
|
| 13 |
-
|
| 14 |
-
RUN pip3 install -r requirements.txt
|
| 15 |
|
|
|
|
| 16 |
EXPOSE 8501
|
| 17 |
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
ENTRYPOINT ["streamlit", "run", "src/streamlit_app.py", "--server.port=8501", "--server.address=0.0.0.0"]
|
|
|
|
| 1 |
+
FROM python:3.9-slim
|
| 2 |
|
| 3 |
WORKDIR /app
|
| 4 |
|
| 5 |
+
# Copy requirements and install dependencies
|
| 6 |
+
COPY requirements.txt .
|
| 7 |
+
RUN pip install --no-cache-dir -r requirements.txt
|
|
|
|
|
|
|
| 8 |
|
| 9 |
+
# Copy the application code
|
| 10 |
+
COPY . .
|
|
|
|
|
|
|
| 11 |
|
| 12 |
+
# Expose the Streamlit port
|
| 13 |
EXPOSE 8501
|
| 14 |
|
| 15 |
+
# Command to run the application
|
| 16 |
+
CMD ["streamlit", "run", "app.py", "--server.address=0.0.0.0", "--server.port=8501"]
|
|
|
LICENSE
ADDED
|
@@ -0,0 +1,674 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
GNU GENERAL PUBLIC LICENSE
|
| 2 |
+
Version 3, 29 June 2007
|
| 3 |
+
|
| 4 |
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
| 5 |
+
Everyone is permitted to copy and distribute verbatim copies
|
| 6 |
+
of this license document, but changing it is not allowed.
|
| 7 |
+
|
| 8 |
+
Preamble
|
| 9 |
+
|
| 10 |
+
The GNU General Public License is a free, copyleft license for
|
| 11 |
+
software and other kinds of works.
|
| 12 |
+
|
| 13 |
+
The licenses for most software and other practical works are designed
|
| 14 |
+
to take away your freedom to share and change the works. By contrast,
|
| 15 |
+
the GNU General Public License is intended to guarantee your freedom to
|
| 16 |
+
share and change all versions of a program--to make sure it remains free
|
| 17 |
+
software for all its users. We, the Free Software Foundation, use the
|
| 18 |
+
GNU General Public License for most of our software; it applies also to
|
| 19 |
+
any other work released this way by its authors. You can apply it to
|
| 20 |
+
your programs, too.
|
| 21 |
+
|
| 22 |
+
When we speak of free software, we are referring to freedom, not
|
| 23 |
+
price. Our General Public Licenses are designed to make sure that you
|
| 24 |
+
have the freedom to distribute copies of free software (and charge for
|
| 25 |
+
them if you wish), that you receive source code or can get it if you
|
| 26 |
+
want it, that you can change the software or use pieces of it in new
|
| 27 |
+
free programs, and that you know you can do these things.
|
| 28 |
+
|
| 29 |
+
To protect your rights, we need to prevent others from denying you
|
| 30 |
+
these rights or asking you to surrender the rights. Therefore, you have
|
| 31 |
+
certain responsibilities if you distribute copies of the software, or if
|
| 32 |
+
you modify it: responsibilities to respect the freedom of others.
|
| 33 |
+
|
| 34 |
+
For example, if you distribute copies of such a program, whether
|
| 35 |
+
gratis or for a fee, you must pass on to the recipients the same
|
| 36 |
+
freedoms that you received. You must make sure that they, too, receive
|
| 37 |
+
or can get the source code. And you must show them these terms so they
|
| 38 |
+
know their rights.
|
| 39 |
+
|
| 40 |
+
Developers that use the GNU GPL protect your rights with two steps:
|
| 41 |
+
(1) assert copyright on the software, and (2) offer you this License
|
| 42 |
+
giving you legal permission to copy, distribute and/or modify it.
|
| 43 |
+
|
| 44 |
+
For the developers' and authors' protection, the GPL clearly explains
|
| 45 |
+
that there is no warranty for this free software. For both users' and
|
| 46 |
+
authors' sake, the GPL requires that modified versions be marked as
|
| 47 |
+
changed, so that their problems will not be attributed erroneously to
|
| 48 |
+
authors of previous versions.
|
| 49 |
+
|
| 50 |
+
Some devices are designed to deny users access to install or run
|
| 51 |
+
modified versions of the software inside them, although the manufacturer
|
| 52 |
+
can do so. This is fundamentally incompatible with the aim of
|
| 53 |
+
protecting users' freedom to change the software. The systematic
|
| 54 |
+
pattern of such abuse occurs in the area of products for individuals to
|
| 55 |
+
use, which is precisely where it is most unacceptable. Therefore, we
|
| 56 |
+
have designed this version of the GPL to prohibit the practice for those
|
| 57 |
+
products. If such problems arise substantially in other domains, we
|
| 58 |
+
stand ready to extend this provision to those domains in future versions
|
| 59 |
+
of the GPL, as needed to protect the freedom of users.
|
| 60 |
+
|
| 61 |
+
Finally, every program is threatened constantly by software patents.
|
| 62 |
+
States should not allow patents to restrict development and use of
|
| 63 |
+
software on general-purpose computers, but in those that do, we wish to
|
| 64 |
+
avoid the special danger that patents applied to a free program could
|
| 65 |
+
make it effectively proprietary. To prevent this, the GPL assures that
|
| 66 |
+
patents cannot be used to render the program non-free.
|
| 67 |
+
|
| 68 |
+
The precise terms and conditions for copying, distribution and
|
| 69 |
+
modification follow.
|
| 70 |
+
|
| 71 |
+
TERMS AND CONDITIONS
|
| 72 |
+
|
| 73 |
+
0. Definitions.
|
| 74 |
+
|
| 75 |
+
"This License" refers to version 3 of the GNU General Public License.
|
| 76 |
+
|
| 77 |
+
"Copyright" also means copyright-like laws that apply to other kinds of
|
| 78 |
+
works, such as semiconductor masks.
|
| 79 |
+
|
| 80 |
+
"The Program" refers to any copyrightable work licensed under this
|
| 81 |
+
License. Each licensee is addressed as "you". "Licensees" and
|
| 82 |
+
"recipients" may be individuals or organizations.
|
| 83 |
+
|
| 84 |
+
To "modify" a work means to copy from or adapt all or part of the work
|
| 85 |
+
in a fashion requiring copyright permission, other than the making of an
|
| 86 |
+
exact copy. The resulting work is called a "modified version" of the
|
| 87 |
+
earlier work or a work "based on" the earlier work.
|
| 88 |
+
|
| 89 |
+
A "covered work" means either the unmodified Program or a work based
|
| 90 |
+
on the Program.
|
| 91 |
+
|
| 92 |
+
To "propagate" a work means to do anything with it that, without
|
| 93 |
+
permission, would make you directly or secondarily liable for
|
| 94 |
+
infringement under applicable copyright law, except executing it on a
|
| 95 |
+
computer or modifying a private copy. Propagation includes copying,
|
| 96 |
+
distribution (with or without modification), making available to the
|
| 97 |
+
public, and in some countries other activities as well.
|
| 98 |
+
|
| 99 |
+
To "convey" a work means any kind of propagation that enables other
|
| 100 |
+
parties to make or receive copies. Mere interaction with a user through
|
| 101 |
+
a computer network, with no transfer of a copy, is not conveying.
|
| 102 |
+
|
| 103 |
+
An interactive user interface displays "Appropriate Legal Notices"
|
| 104 |
+
to the extent that it includes a convenient and prominently visible
|
| 105 |
+
feature that (1) displays an appropriate copyright notice, and (2)
|
| 106 |
+
tells the user that there is no warranty for the work (except to the
|
| 107 |
+
extent that warranties are provided), that licensees may convey the
|
| 108 |
+
work under this License, and how to view a copy of this License. If
|
| 109 |
+
the interface presents a list of user commands or options, such as a
|
| 110 |
+
menu, a prominent item in the list meets this criterion.
|
| 111 |
+
|
| 112 |
+
1. Source Code.
|
| 113 |
+
|
| 114 |
+
The "source code" for a work means the preferred form of the work
|
| 115 |
+
for making modifications to it. "Object code" means any non-source
|
| 116 |
+
form of a work.
|
| 117 |
+
|
| 118 |
+
A "Standard Interface" means an interface that either is an official
|
| 119 |
+
standard defined by a recognized standards body, or, in the case of
|
| 120 |
+
interfaces specified for a particular programming language, one that
|
| 121 |
+
is widely used among developers working in that language.
|
| 122 |
+
|
| 123 |
+
The "System Libraries" of an executable work include anything, other
|
| 124 |
+
than the work as a whole, that (a) is included in the normal form of
|
| 125 |
+
packaging a Major Component, but which is not part of that Major
|
| 126 |
+
Component, and (b) serves only to enable use of the work with that
|
| 127 |
+
Major Component, or to implement a Standard Interface for which an
|
| 128 |
+
implementation is available to the public in source code form. A
|
| 129 |
+
"Major Component", in this context, means a major essential component
|
| 130 |
+
(kernel, window system, and so on) of the specific operating system
|
| 131 |
+
(if any) on which the executable work runs, or a compiler used to
|
| 132 |
+
produce the work, or an object code interpreter used to run it.
|
| 133 |
+
|
| 134 |
+
The "Corresponding Source" for a work in object code form means all
|
| 135 |
+
the source code needed to generate, install, and (for an executable
|
| 136 |
+
work) run the object code and to modify the work, including scripts to
|
| 137 |
+
control those activities. However, it does not include the work's
|
| 138 |
+
System Libraries, or general-purpose tools or generally available free
|
| 139 |
+
programs which are used unmodified in performing those activities but
|
| 140 |
+
which are not part of the work. For example, Corresponding Source
|
| 141 |
+
includes interface definition files associated with source files for
|
| 142 |
+
the work, and the source code for shared libraries and dynamically
|
| 143 |
+
linked subprograms that the work is specifically designed to require,
|
| 144 |
+
such as by intimate data communication or control flow between those
|
| 145 |
+
subprograms and other parts of the work.
|
| 146 |
+
|
| 147 |
+
The Corresponding Source need not include anything that users
|
| 148 |
+
can regenerate automatically from other parts of the Corresponding
|
| 149 |
+
Source.
|
| 150 |
+
|
| 151 |
+
The Corresponding Source for a work in source code form is that
|
| 152 |
+
same work.
|
| 153 |
+
|
| 154 |
+
2. Basic Permissions.
|
| 155 |
+
|
| 156 |
+
All rights granted under this License are granted for the term of
|
| 157 |
+
copyright on the Program, and are irrevocable provided the stated
|
| 158 |
+
conditions are met. This License explicitly affirms your unlimited
|
| 159 |
+
permission to run the unmodified Program. The output from running a
|
| 160 |
+
covered work is covered by this License only if the output, given its
|
| 161 |
+
content, constitutes a covered work. This License acknowledges your
|
| 162 |
+
rights of fair use or other equivalent, as provided by copyright law.
|
| 163 |
+
|
| 164 |
+
You may make, run and propagate covered works that you do not
|
| 165 |
+
convey, without conditions so long as your license otherwise remains
|
| 166 |
+
in force. You may convey covered works to others for the sole purpose
|
| 167 |
+
of having them make modifications exclusively for you, or provide you
|
| 168 |
+
with facilities for running those works, provided that you comply with
|
| 169 |
+
the terms of this License in conveying all material for which you do
|
| 170 |
+
not control copyright. Those thus making or running the covered works
|
| 171 |
+
for you must do so exclusively on your behalf, under your direction
|
| 172 |
+
and control, on terms that prohibit them from making any copies of
|
| 173 |
+
your copyrighted material outside their relationship with you.
|
| 174 |
+
|
| 175 |
+
Conveying under any other circumstances is permitted solely under
|
| 176 |
+
the conditions stated below. Sublicensing is not allowed; section 10
|
| 177 |
+
makes it unnecessary.
|
| 178 |
+
|
| 179 |
+
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
| 180 |
+
|
| 181 |
+
No covered work shall be deemed part of an effective technological
|
| 182 |
+
measure under any applicable law fulfilling obligations under article
|
| 183 |
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
| 184 |
+
similar laws prohibiting or restricting circumvention of such
|
| 185 |
+
measures.
|
| 186 |
+
|
| 187 |
+
When you convey a covered work, you waive any legal power to forbid
|
| 188 |
+
circumvention of technological measures to the extent such circumvention
|
| 189 |
+
is effected by exercising rights under this License with respect to
|
| 190 |
+
the covered work, and you disclaim any intention to limit operation or
|
| 191 |
+
modification of the work as a means of enforcing, against the work's
|
| 192 |
+
users, your or third parties' legal rights to forbid circumvention of
|
| 193 |
+
technological measures.
|
| 194 |
+
|
| 195 |
+
4. Conveying Verbatim Copies.
|
| 196 |
+
|
| 197 |
+
You may convey verbatim copies of the Program's source code as you
|
| 198 |
+
receive it, in any medium, provided that you conspicuously and
|
| 199 |
+
appropriately publish on each copy an appropriate copyright notice;
|
| 200 |
+
keep intact all notices stating that this License and any
|
| 201 |
+
non-permissive terms added in accord with section 7 apply to the code;
|
| 202 |
+
keep intact all notices of the absence of any warranty; and give all
|
| 203 |
+
recipients a copy of this License along with the Program.
|
| 204 |
+
|
| 205 |
+
You may charge any price or no price for each copy that you convey,
|
| 206 |
+
and you may offer support or warranty protection for a fee.
|
| 207 |
+
|
| 208 |
+
5. Conveying Modified Source Versions.
|
| 209 |
+
|
| 210 |
+
You may convey a work based on the Program, or the modifications to
|
| 211 |
+
produce it from the Program, in the form of source code under the
|
| 212 |
+
terms of section 4, provided that you also meet all of these conditions:
|
| 213 |
+
|
| 214 |
+
a) The work must carry prominent notices stating that you modified
|
| 215 |
+
it, and giving a relevant date.
|
| 216 |
+
|
| 217 |
+
b) The work must carry prominent notices stating that it is
|
| 218 |
+
released under this License and any conditions added under section
|
| 219 |
+
7. This requirement modifies the requirement in section 4 to
|
| 220 |
+
"keep intact all notices".
|
| 221 |
+
|
| 222 |
+
c) You must license the entire work, as a whole, under this
|
| 223 |
+
License to anyone who comes into possession of a copy. This
|
| 224 |
+
License will therefore apply, along with any applicable section 7
|
| 225 |
+
additional terms, to the whole of the work, and all its parts,
|
| 226 |
+
regardless of how they are packaged. This License gives no
|
| 227 |
+
permission to license the work in any other way, but it does not
|
| 228 |
+
invalidate such permission if you have separately received it.
|
| 229 |
+
|
| 230 |
+
d) If the work has interactive user interfaces, each must display
|
| 231 |
+
Appropriate Legal Notices; however, if the Program has interactive
|
| 232 |
+
interfaces that do not display Appropriate Legal Notices, your
|
| 233 |
+
work need not make them do so.
|
| 234 |
+
|
| 235 |
+
A compilation of a covered work with other separate and independent
|
| 236 |
+
works, which are not by their nature extensions of the covered work,
|
| 237 |
+
and which are not combined with it such as to form a larger program,
|
| 238 |
+
in or on a volume of a storage or distribution medium, is called an
|
| 239 |
+
"aggregate" if the compilation and its resulting copyright are not
|
| 240 |
+
used to limit the access or legal rights of the compilation's users
|
| 241 |
+
beyond what the individual works permit. Inclusion of a covered work
|
| 242 |
+
in an aggregate does not cause this License to apply to the other
|
| 243 |
+
parts of the aggregate.
|
| 244 |
+
|
| 245 |
+
6. Conveying Non-Source Forms.
|
| 246 |
+
|
| 247 |
+
You may convey a covered work in object code form under the terms
|
| 248 |
+
of sections 4 and 5, provided that you also convey the
|
| 249 |
+
machine-readable Corresponding Source under the terms of this License,
|
| 250 |
+
in one of these ways:
|
| 251 |
+
|
| 252 |
+
a) Convey the object code in, or embodied in, a physical product
|
| 253 |
+
(including a physical distribution medium), accompanied by the
|
| 254 |
+
Corresponding Source fixed on a durable physical medium
|
| 255 |
+
customarily used for software interchange.
|
| 256 |
+
|
| 257 |
+
b) Convey the object code in, or embodied in, a physical product
|
| 258 |
+
(including a physical distribution medium), accompanied by a
|
| 259 |
+
written offer, valid for at least three years and valid for as
|
| 260 |
+
long as you offer spare parts or customer support for that product
|
| 261 |
+
model, to give anyone who possesses the object code either (1) a
|
| 262 |
+
copy of the Corresponding Source for all the software in the
|
| 263 |
+
product that is covered by this License, on a durable physical
|
| 264 |
+
medium customarily used for software interchange, for a price no
|
| 265 |
+
more than your reasonable cost of physically performing this
|
| 266 |
+
conveying of source, or (2) access to copy the
|
| 267 |
+
Corresponding Source from a network server at no charge.
|
| 268 |
+
|
| 269 |
+
c) Convey individual copies of the object code with a copy of the
|
| 270 |
+
written offer to provide the Corresponding Source. This
|
| 271 |
+
alternative is allowed only occasionally and noncommercially, and
|
| 272 |
+
only if you received the object code with such an offer, in accord
|
| 273 |
+
with subsection 6b.
|
| 274 |
+
|
| 275 |
+
d) Convey the object code by offering access from a designated
|
| 276 |
+
place (gratis or for a charge), and offer equivalent access to the
|
| 277 |
+
Corresponding Source in the same way through the same place at no
|
| 278 |
+
further charge. You need not require recipients to copy the
|
| 279 |
+
Corresponding Source along with the object code. If the place to
|
| 280 |
+
copy the object code is a network server, the Corresponding Source
|
| 281 |
+
may be on a different server (operated by you or a third party)
|
| 282 |
+
that supports equivalent copying facilities, provided you maintain
|
| 283 |
+
clear directions next to the object code saying where to find the
|
| 284 |
+
Corresponding Source. Regardless of what server hosts the
|
| 285 |
+
Corresponding Source, you remain obligated to ensure that it is
|
| 286 |
+
available for as long as needed to satisfy these requirements.
|
| 287 |
+
|
| 288 |
+
e) Convey the object code using peer-to-peer transmission, provided
|
| 289 |
+
you inform other peers where the object code and Corresponding
|
| 290 |
+
Source of the work are being offered to the general public at no
|
| 291 |
+
charge under subsection 6d.
|
| 292 |
+
|
| 293 |
+
A separable portion of the object code, whose source code is excluded
|
| 294 |
+
from the Corresponding Source as a System Library, need not be
|
| 295 |
+
included in conveying the object code work.
|
| 296 |
+
|
| 297 |
+
A "User Product" is either (1) a "consumer product", which means any
|
| 298 |
+
tangible personal property which is normally used for personal, family,
|
| 299 |
+
or household purposes, or (2) anything designed or sold for incorporation
|
| 300 |
+
into a dwelling. In determining whether a product is a consumer product,
|
| 301 |
+
doubtful cases shall be resolved in favor of coverage. For a particular
|
| 302 |
+
product received by a particular user, "normally used" refers to a
|
| 303 |
+
typical or common use of that class of product, regardless of the status
|
| 304 |
+
of the particular user or of the way in which the particular user
|
| 305 |
+
actually uses, or expects or is expected to use, the product. A product
|
| 306 |
+
is a consumer product regardless of whether the product has substantial
|
| 307 |
+
commercial, industrial or non-consumer uses, unless such uses represent
|
| 308 |
+
the only significant mode of use of the product.
|
| 309 |
+
|
| 310 |
+
"Installation Information" for a User Product means any methods,
|
| 311 |
+
procedures, authorization keys, or other information required to install
|
| 312 |
+
and execute modified versions of a covered work in that User Product from
|
| 313 |
+
a modified version of its Corresponding Source. The information must
|
| 314 |
+
suffice to ensure that the continued functioning of the modified object
|
| 315 |
+
code is in no case prevented or interfered with solely because
|
| 316 |
+
modification has been made.
|
| 317 |
+
|
| 318 |
+
If you convey an object code work under this section in, or with, or
|
| 319 |
+
specifically for use in, a User Product, and the conveying occurs as
|
| 320 |
+
part of a transaction in which the right of possession and use of the
|
| 321 |
+
User Product is transferred to the recipient in perpetuity or for a
|
| 322 |
+
fixed term (regardless of how the transaction is characterized), the
|
| 323 |
+
Corresponding Source conveyed under this section must be accompanied
|
| 324 |
+
by the Installation Information. But this requirement does not apply
|
| 325 |
+
if neither you nor any third party retains the ability to install
|
| 326 |
+
modified object code on the User Product (for example, the work has
|
| 327 |
+
been installed in ROM).
|
| 328 |
+
|
| 329 |
+
The requirement to provide Installation Information does not include a
|
| 330 |
+
requirement to continue to provide support service, warranty, or updates
|
| 331 |
+
for a work that has been modified or installed by the recipient, or for
|
| 332 |
+
the User Product in which it has been modified or installed. Access to a
|
| 333 |
+
network may be denied when the modification itself materially and
|
| 334 |
+
adversely affects the operation of the network or violates the rules and
|
| 335 |
+
protocols for communication across the network.
|
| 336 |
+
|
| 337 |
+
Corresponding Source conveyed, and Installation Information provided,
|
| 338 |
+
in accord with this section must be in a format that is publicly
|
| 339 |
+
documented (and with an implementation available to the public in
|
| 340 |
+
source code form), and must require no special password or key for
|
| 341 |
+
unpacking, reading or copying.
|
| 342 |
+
|
| 343 |
+
7. Additional Terms.
|
| 344 |
+
|
| 345 |
+
"Additional permissions" are terms that supplement the terms of this
|
| 346 |
+
License by making exceptions from one or more of its conditions.
|
| 347 |
+
Additional permissions that are applicable to the entire Program shall
|
| 348 |
+
be treated as though they were included in this License, to the extent
|
| 349 |
+
that they are valid under applicable law. If additional permissions
|
| 350 |
+
apply only to part of the Program, that part may be used separately
|
| 351 |
+
under those permissions, but the entire Program remains governed by
|
| 352 |
+
this License without regard to the additional permissions.
|
| 353 |
+
|
| 354 |
+
When you convey a copy of a covered work, you may at your option
|
| 355 |
+
remove any additional permissions from that copy, or from any part of
|
| 356 |
+
it. (Additional permissions may be written to require their own
|
| 357 |
+
removal in certain cases when you modify the work.) You may place
|
| 358 |
+
additional permissions on material, added by you to a covered work,
|
| 359 |
+
for which you have or can give appropriate copyright permission.
|
| 360 |
+
|
| 361 |
+
Notwithstanding any other provision of this License, for material you
|
| 362 |
+
add to a covered work, you may (if authorized by the copyright holders of
|
| 363 |
+
that material) supplement the terms of this License with terms:
|
| 364 |
+
|
| 365 |
+
a) Disclaiming warranty or limiting liability differently from the
|
| 366 |
+
terms of sections 15 and 16 of this License; or
|
| 367 |
+
|
| 368 |
+
b) Requiring preservation of specified reasonable legal notices or
|
| 369 |
+
author attributions in that material or in the Appropriate Legal
|
| 370 |
+
Notices displayed by works containing it; or
|
| 371 |
+
|
| 372 |
+
c) Prohibiting misrepresentation of the origin of that material, or
|
| 373 |
+
requiring that modified versions of such material be marked in
|
| 374 |
+
reasonable ways as different from the original version; or
|
| 375 |
+
|
| 376 |
+
d) Limiting the use for publicity purposes of names of licensors or
|
| 377 |
+
authors of the material; or
|
| 378 |
+
|
| 379 |
+
e) Declining to grant rights under trademark law for use of some
|
| 380 |
+
trade names, trademarks, or service marks; or
|
| 381 |
+
|
| 382 |
+
f) Requiring indemnification of licensors and authors of that
|
| 383 |
+
material by anyone who conveys the material (or modified versions of
|
| 384 |
+
it) with contractual assumptions of liability to the recipient, for
|
| 385 |
+
any liability that these contractual assumptions directly impose on
|
| 386 |
+
those licensors and authors.
|
| 387 |
+
|
| 388 |
+
All other non-permissive additional terms are considered "further
|
| 389 |
+
restrictions" within the meaning of section 10. If the Program as you
|
| 390 |
+
received it, or any part of it, contains a notice stating that it is
|
| 391 |
+
governed by this License along with a term that is a further
|
| 392 |
+
restriction, you may remove that term. If a license document contains
|
| 393 |
+
a further restriction but permits relicensing or conveying under this
|
| 394 |
+
License, you may add to a covered work material governed by the terms
|
| 395 |
+
of that license document, provided that the further restriction does
|
| 396 |
+
not survive such relicensing or conveying.
|
| 397 |
+
|
| 398 |
+
If you add terms to a covered work in accord with this section, you
|
| 399 |
+
must place, in the relevant source files, a statement of the
|
| 400 |
+
additional terms that apply to those files, or a notice indicating
|
| 401 |
+
where to find the applicable terms.
|
| 402 |
+
|
| 403 |
+
Additional terms, permissive or non-permissive, may be stated in the
|
| 404 |
+
form of a separately written license, or stated as exceptions;
|
| 405 |
+
the above requirements apply either way.
|
| 406 |
+
|
| 407 |
+
8. Termination.
|
| 408 |
+
|
| 409 |
+
You may not propagate or modify a covered work except as expressly
|
| 410 |
+
provided under this License. Any attempt otherwise to propagate or
|
| 411 |
+
modify it is void, and will automatically terminate your rights under
|
| 412 |
+
this License (including any patent licenses granted under the third
|
| 413 |
+
paragraph of section 11).
|
| 414 |
+
|
| 415 |
+
However, if you cease all violation of this License, then your
|
| 416 |
+
license from a particular copyright holder is reinstated (a)
|
| 417 |
+
provisionally, unless and until the copyright holder explicitly and
|
| 418 |
+
finally terminates your license, and (b) permanently, if the copyright
|
| 419 |
+
holder fails to notify you of the violation by some reasonable means
|
| 420 |
+
prior to 60 days after the cessation.
|
| 421 |
+
|
| 422 |
+
Moreover, your license from a particular copyright holder is
|
| 423 |
+
reinstated permanently if the copyright holder notifies you of the
|
| 424 |
+
violation by some reasonable means, this is the first time you have
|
| 425 |
+
received notice of violation of this License (for any work) from that
|
| 426 |
+
copyright holder, and you cure the violation prior to 30 days after
|
| 427 |
+
your receipt of the notice.
|
| 428 |
+
|
| 429 |
+
Termination of your rights under this section does not terminate the
|
| 430 |
+
licenses of parties who have received copies or rights from you under
|
| 431 |
+
this License. If your rights have been terminated and not permanently
|
| 432 |
+
reinstated, you do not qualify to receive new licenses for the same
|
| 433 |
+
material under section 10.
|
| 434 |
+
|
| 435 |
+
9. Acceptance Not Required for Having Copies.
|
| 436 |
+
|
| 437 |
+
You are not required to accept this License in order to receive or
|
| 438 |
+
run a copy of the Program. Ancillary propagation of a covered work
|
| 439 |
+
occurring solely as a consequence of using peer-to-peer transmission
|
| 440 |
+
to receive a copy likewise does not require acceptance. However,
|
| 441 |
+
nothing other than this License grants you permission to propagate or
|
| 442 |
+
modify any covered work. These actions infringe copyright if you do
|
| 443 |
+
not accept this License. Therefore, by modifying or propagating a
|
| 444 |
+
covered work, you indicate your acceptance of this License to do so.
|
| 445 |
+
|
| 446 |
+
10. Automatic Licensing of Downstream Recipients.
|
| 447 |
+
|
| 448 |
+
Each time you convey a covered work, the recipient automatically
|
| 449 |
+
receives a license from the original licensors, to run, modify and
|
| 450 |
+
propagate that work, subject to this License. You are not responsible
|
| 451 |
+
for enforcing compliance by third parties with this License.
|
| 452 |
+
|
| 453 |
+
An "entity transaction" is a transaction transferring control of an
|
| 454 |
+
organization, or substantially all assets of one, or subdividing an
|
| 455 |
+
organization, or merging organizations. If propagation of a covered
|
| 456 |
+
work results from an entity transaction, each party to that
|
| 457 |
+
transaction who receives a copy of the work also receives whatever
|
| 458 |
+
licenses to the work the party's predecessor in interest had or could
|
| 459 |
+
give under the previous paragraph, plus a right to possession of the
|
| 460 |
+
Corresponding Source of the work from the predecessor in interest, if
|
| 461 |
+
the predecessor has it or can get it with reasonable efforts.
|
| 462 |
+
|
| 463 |
+
You may not impose any further restrictions on the exercise of the
|
| 464 |
+
rights granted or affirmed under this License. For example, you may
|
| 465 |
+
not impose a license fee, royalty, or other charge for exercise of
|
| 466 |
+
rights granted under this License, and you may not initiate litigation
|
| 467 |
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
| 468 |
+
any patent claim is infringed by making, using, selling, offering for
|
| 469 |
+
sale, or importing the Program or any portion of it.
|
| 470 |
+
|
| 471 |
+
11. Patents.
|
| 472 |
+
|
| 473 |
+
A "contributor" is a copyright holder who authorizes use under this
|
| 474 |
+
License of the Program or a work on which the Program is based. The
|
| 475 |
+
work thus licensed is called the contributor's "contributor version".
|
| 476 |
+
|
| 477 |
+
A contributor's "essential patent claims" are all patent claims
|
| 478 |
+
owned or controlled by the contributor, whether already acquired or
|
| 479 |
+
hereafter acquired, that would be infringed by some manner, permitted
|
| 480 |
+
by this License, of making, using, or selling its contributor version,
|
| 481 |
+
but do not include claims that would be infringed only as a
|
| 482 |
+
consequence of further modification of the contributor version. For
|
| 483 |
+
purposes of this definition, "control" includes the right to grant
|
| 484 |
+
patent sublicenses in a manner consistent with the requirements of
|
| 485 |
+
this License.
|
| 486 |
+
|
| 487 |
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
| 488 |
+
patent license under the contributor's essential patent claims, to
|
| 489 |
+
make, use, sell, offer for sale, import and otherwise run, modify and
|
| 490 |
+
propagate the contents of its contributor version.
|
| 491 |
+
|
| 492 |
+
In the following three paragraphs, a "patent license" is any express
|
| 493 |
+
agreement or commitment, however denominated, not to enforce a patent
|
| 494 |
+
(such as an express permission to practice a patent or covenant not to
|
| 495 |
+
sue for patent infringement). To "grant" such a patent license to a
|
| 496 |
+
party means to make such an agreement or commitment not to enforce a
|
| 497 |
+
patent against the party.
|
| 498 |
+
|
| 499 |
+
If you convey a covered work, knowingly relying on a patent license,
|
| 500 |
+
and the Corresponding Source of the work is not available for anyone
|
| 501 |
+
to copy, free of charge and under the terms of this License, through a
|
| 502 |
+
publicly available network server or other readily accessible means,
|
| 503 |
+
then you must either (1) cause the Corresponding Source to be so
|
| 504 |
+
available, or (2) arrange to deprive yourself of the benefit of the
|
| 505 |
+
patent license for this particular work, or (3) arrange, in a manner
|
| 506 |
+
consistent with the requirements of this License, to extend the patent
|
| 507 |
+
license to downstream recipients. "Knowingly relying" means you have
|
| 508 |
+
actual knowledge that, but for the patent license, your conveying the
|
| 509 |
+
covered work in a country, or your recipient's use of the covered work
|
| 510 |
+
in a country, would infringe one or more identifiable patents in that
|
| 511 |
+
country that you have reason to believe are valid.
|
| 512 |
+
|
| 513 |
+
If, pursuant to or in connection with a single transaction or
|
| 514 |
+
arrangement, you convey, or propagate by procuring conveyance of, a
|
| 515 |
+
covered work, and grant a patent license to some of the parties
|
| 516 |
+
receiving the covered work authorizing them to use, propagate, modify
|
| 517 |
+
or convey a specific copy of the covered work, then the patent license
|
| 518 |
+
you grant is automatically extended to all recipients of the covered
|
| 519 |
+
work and works based on it.
|
| 520 |
+
|
| 521 |
+
A patent license is "discriminatory" if it does not include within
|
| 522 |
+
the scope of its coverage, prohibits the exercise of, or is
|
| 523 |
+
conditioned on the non-exercise of one or more of the rights that are
|
| 524 |
+
specifically granted under this License. You may not convey a covered
|
| 525 |
+
work if you are a party to an arrangement with a third party that is
|
| 526 |
+
in the business of distributing software, under which you make payment
|
| 527 |
+
to the third party based on the extent of your activity of conveying
|
| 528 |
+
the work, and under which the third party grants, to any of the
|
| 529 |
+
parties who would receive the covered work from you, a discriminatory
|
| 530 |
+
patent license (a) in connection with copies of the covered work
|
| 531 |
+
conveyed by you (or copies made from those copies), or (b) primarily
|
| 532 |
+
for and in connection with specific products or compilations that
|
| 533 |
+
contain the covered work, unless you entered into that arrangement,
|
| 534 |
+
or that patent license was granted, prior to 28 March 2007.
|
| 535 |
+
|
| 536 |
+
Nothing in this License shall be construed as excluding or limiting
|
| 537 |
+
any implied license or other defenses to infringement that may
|
| 538 |
+
otherwise be available to you under applicable patent law.
|
| 539 |
+
|
| 540 |
+
12. No Surrender of Others' Freedom.
|
| 541 |
+
|
| 542 |
+
If conditions are imposed on you (whether by court order, agreement or
|
| 543 |
+
otherwise) that contradict the conditions of this License, they do not
|
| 544 |
+
excuse you from the conditions of this License. If you cannot convey a
|
| 545 |
+
covered work so as to satisfy simultaneously your obligations under this
|
| 546 |
+
License and any other pertinent obligations, then as a consequence you may
|
| 547 |
+
not convey it at all. For example, if you agree to terms that obligate you
|
| 548 |
+
to collect a royalty for further conveying from those to whom you convey
|
| 549 |
+
the Program, the only way you could satisfy both those terms and this
|
| 550 |
+
License would be to refrain entirely from conveying the Program.
|
| 551 |
+
|
| 552 |
+
13. Use with the GNU Affero General Public License.
|
| 553 |
+
|
| 554 |
+
Notwithstanding any other provision of this License, you have
|
| 555 |
+
permission to link or combine any covered work with a work licensed
|
| 556 |
+
under version 3 of the GNU Affero General Public License into a single
|
| 557 |
+
combined work, and to convey the resulting work. The terms of this
|
| 558 |
+
License will continue to apply to the part which is the covered work,
|
| 559 |
+
but the special requirements of the GNU Affero General Public License,
|
| 560 |
+
section 13, concerning interaction through a network will apply to the
|
| 561 |
+
combination as such.
|
| 562 |
+
|
| 563 |
+
14. Revised Versions of this License.
|
| 564 |
+
|
| 565 |
+
The Free Software Foundation may publish revised and/or new versions of
|
| 566 |
+
the GNU General Public License from time to time. Such new versions will
|
| 567 |
+
be similar in spirit to the present version, but may differ in detail to
|
| 568 |
+
address new problems or concerns.
|
| 569 |
+
|
| 570 |
+
Each version is given a distinguishing version number. If the
|
| 571 |
+
Program specifies that a certain numbered version of the GNU General
|
| 572 |
+
Public License "or any later version" applies to it, you have the
|
| 573 |
+
option of following the terms and conditions either of that numbered
|
| 574 |
+
version or of any later version published by the Free Software
|
| 575 |
+
Foundation. If the Program does not specify a version number of the
|
| 576 |
+
GNU General Public License, you may choose any version ever published
|
| 577 |
+
by the Free Software Foundation.
|
| 578 |
+
|
| 579 |
+
If the Program specifies that a proxy can decide which future
|
| 580 |
+
versions of the GNU General Public License can be used, that proxy's
|
| 581 |
+
public statement of acceptance of a version permanently authorizes you
|
| 582 |
+
to choose that version for the Program.
|
| 583 |
+
|
| 584 |
+
Later license versions may give you additional or different
|
| 585 |
+
permissions. However, no additional obligations are imposed on any
|
| 586 |
+
author or copyright holder as a result of your choosing to follow a
|
| 587 |
+
later version.
|
| 588 |
+
|
| 589 |
+
15. Disclaimer of Warranty.
|
| 590 |
+
|
| 591 |
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
| 592 |
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
| 593 |
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
| 594 |
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
| 595 |
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
| 596 |
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
| 597 |
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
| 598 |
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
| 599 |
+
|
| 600 |
+
16. Limitation of Liability.
|
| 601 |
+
|
| 602 |
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
| 603 |
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
| 604 |
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
| 605 |
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
| 606 |
+
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
| 607 |
+
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
| 608 |
+
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
| 609 |
+
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
| 610 |
+
SUCH DAMAGES.
|
| 611 |
+
|
| 612 |
+
17. Interpretation of Sections 15 and 16.
|
| 613 |
+
|
| 614 |
+
If the disclaimer of warranty and limitation of liability provided
|
| 615 |
+
above cannot be given local legal effect according to their terms,
|
| 616 |
+
reviewing courts shall apply local law that most closely approximates
|
| 617 |
+
an absolute waiver of all civil liability in connection with the
|
| 618 |
+
Program, unless a warranty or assumption of liability accompanies a
|
| 619 |
+
copy of the Program in return for a fee.
|
| 620 |
+
|
| 621 |
+
END OF TERMS AND CONDITIONS
|
| 622 |
+
|
| 623 |
+
How to Apply These Terms to Your New Programs
|
| 624 |
+
|
| 625 |
+
If you develop a new program, and you want it to be of the greatest
|
| 626 |
+
possible use to the public, the best way to achieve this is to make it
|
| 627 |
+
free software which everyone can redistribute and change under these terms.
|
| 628 |
+
|
| 629 |
+
To do so, attach the following notices to the program. It is safest
|
| 630 |
+
to attach them to the start of each source file to most effectively
|
| 631 |
+
state the exclusion of warranty; and each file should have at least
|
| 632 |
+
the "copyright" line and a pointer to where the full notice is found.
|
| 633 |
+
|
| 634 |
+
<one line to give the program's name and a brief idea of what it does.>
|
| 635 |
+
Copyright (C) <year> <name of author>
|
| 636 |
+
|
| 637 |
+
This program is free software: you can redistribute it and/or modify
|
| 638 |
+
it under the terms of the GNU General Public License as published by
|
| 639 |
+
the Free Software Foundation, either version 3 of the License, or
|
| 640 |
+
(at your option) any later version.
|
| 641 |
+
|
| 642 |
+
This program is distributed in the hope that it will be useful,
|
| 643 |
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 644 |
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 645 |
+
GNU General Public License for more details.
|
| 646 |
+
|
| 647 |
+
You should have received a copy of the GNU General Public License
|
| 648 |
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
| 649 |
+
|
| 650 |
+
Also add information on how to contact you by electronic and paper mail.
|
| 651 |
+
|
| 652 |
+
If the program does terminal interaction, make it output a short
|
| 653 |
+
notice like this when it starts in an interactive mode:
|
| 654 |
+
|
| 655 |
+
<program> Copyright (C) <year> <name of author>
|
| 656 |
+
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
| 657 |
+
This is free software, and you are welcome to redistribute it
|
| 658 |
+
under certain conditions; type `show c' for details.
|
| 659 |
+
|
| 660 |
+
The hypothetical commands `show w' and `show c' should show the appropriate
|
| 661 |
+
parts of the General Public License. Of course, your program's commands
|
| 662 |
+
might be different; for a GUI interface, you would use an "about box".
|
| 663 |
+
|
| 664 |
+
You should also get your employer (if you work as a programmer) or school,
|
| 665 |
+
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
| 666 |
+
For more information on this, and how to apply and follow the GNU GPL, see
|
| 667 |
+
<https://www.gnu.org/licenses/>.
|
| 668 |
+
|
| 669 |
+
The GNU General Public License does not permit incorporating your program
|
| 670 |
+
into proprietary programs. If your program is a subroutine library, you
|
| 671 |
+
may consider it more useful to permit linking proprietary applications with
|
| 672 |
+
the library. If this is what you want to do, use the GNU Lesser General
|
| 673 |
+
Public License instead of this License. But first, please read
|
| 674 |
+
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
app.py
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Main entry point of the Streamlit application
|
| 2 |
+
|
| 3 |
+
import streamlit as st
|
| 4 |
+
import sys
|
| 5 |
+
from pathlib import Path
|
| 6 |
+
|
| 7 |
+
APP_DIR = Path(__file__).resolve().parent
|
| 8 |
+
STREAMLIT_SRC = APP_DIR / "src"
|
| 9 |
+
if str(STREAMLIT_SRC) not in sys.path:
|
| 10 |
+
sys.path.append(str(STREAMLIT_SRC))
|
| 11 |
+
|
| 12 |
+
from pages import about_page, contact_page, home_page
|
| 13 |
+
|
| 14 |
+
def main():
|
| 15 |
+
st.set_page_config(
|
| 16 |
+
page_title="Chaptly (YouTube Tutor Chatbot)",
|
| 17 |
+
page_icon="📚",
|
| 18 |
+
layout="wide",
|
| 19 |
+
initial_sidebar_state="expanded",
|
| 20 |
+
)
|
| 21 |
+
|
| 22 |
+
st.sidebar.title("Navigation")
|
| 23 |
+
|
| 24 |
+
# Sidebar navigation
|
| 25 |
+
pages = {
|
| 26 |
+
"Home": home_page,
|
| 27 |
+
"About": about_page,
|
| 28 |
+
"Contact": contact_page,
|
| 29 |
+
}
|
| 30 |
+
|
| 31 |
+
selection = st.sidebar.radio("Go to", list(pages.keys()))
|
| 32 |
+
|
| 33 |
+
# Render the selected page
|
| 34 |
+
pages[selection]()
|
| 35 |
+
|
| 36 |
+
if __name__ == "__main__":
|
| 37 |
+
main()
|
config.toml
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
[general]
|
| 2 |
+
email = "[email protected]"
|
| 3 |
+
# The email address for the Streamlit sharing service.
|
| 4 |
+
|
| 5 |
+
[server]
|
| 6 |
+
headless = true
|
| 7 |
+
port = 8501
|
| 8 |
+
enableCORS = false
|
| 9 |
+
# Configuration for the server, including running in headless mode and setting the port.
|
| 10 |
+
|
| 11 |
+
[theme]
|
| 12 |
+
primaryColor = "#F39C12"
|
| 13 |
+
backgroundColor = "#FFFFFF"
|
| 14 |
+
secondaryBackgroundColor = "#F0F0F0"
|
| 15 |
+
textColor = "#000000"
|
| 16 |
+
font = "sans serif"
|
| 17 |
+
# Theme settings for the Streamlit application, including colors and font.
|
huggingface-metadata.yaml
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# File: .github/huggingface-metadata.yaml
|
| 2 |
+
title: Chaptly AI
|
| 3 |
+
emoji: 📕
|
| 4 |
+
colorFrom: indigo
|
| 5 |
+
colorTo: blue
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_port: 8501
|
| 8 |
+
pinned: false
|
img/3blue1brown.png
ADDED
|
Git LFS Details
|
img/Computerphile.png
ADDED
|
Git LFS Details
|
img/CrashCourse.png
ADDED
|
Git LFS Details
|
img/Harvard.png
ADDED
|
Git LFS Details
|
img/KhanAcademy.png
ADDED
|
Git LFS Details
|
img/MIT OpenCourseWare.png
ADDED
|
Git LFS Details
|
img/ProgrammingWithMosh.png
ADDED
|
Git LFS Details
|
img/SciShow.png
ADDED
|
Git LFS Details
|
img/Stanford Online.png
ADDED
|
Git LFS Details
|
img/TED.png
ADDED
|
Git LFS Details
|
img/TEDEd.png
ADDED
|
Git LFS Details
|
img/TEDx.png
ADDED
|
Git LFS Details
|
img/Udacity.png
ADDED
|
Git LFS Details
|
img/Veritasium.png
ADDED
|
Git LFS Details
|
img/YaleCourses.png
ADDED
|
Git LFS Details
|
img/coursera.png
ADDED
|
Git LFS Details
|
img/cover_page.jpg
ADDED
|
Git LFS Details
|
img/edX.png
ADDED
|
Git LFS Details
|
img/freeCodeCamp.png
ADDED
|
Git LFS Details
|
img/minutephysics.png
ADDED
|
Git LFS Details
|
img/numberphile.png
ADDED
|
Git LFS Details
|
img/user_flow_system_architecture.jpg
ADDED
|
Git LFS Details
|
requirements.txt
CHANGED
|
@@ -1,3 +1,13 @@
|
|
| 1 |
-
|
| 2 |
-
pandas
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
streamlit>=1.24.0
|
| 2 |
+
pandas>=1.5.0
|
| 3 |
+
numpy>=1.23.0
|
| 4 |
+
plotly>=5.13.0
|
| 5 |
+
folium>=0.14.0
|
| 6 |
+
streamlit-folium>=0.11.0
|
| 7 |
+
requests>=2.28.0
|
| 8 |
+
python-dotenv>=1.0.0
|
| 9 |
+
ortools>=9.6.0
|
| 10 |
+
geopy
|
| 11 |
+
matplotlib
|
| 12 |
+
boto3>=1.28.0
|
| 13 |
+
altair
|
scripts/api_lambda_call.py
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import os, time, hashlib, hmac, requests
|
| 2 |
+
|
| 3 |
+
API_URL = os.environ["CHAPTLY_API_URL"]
|
| 4 |
+
API_SECRET = os.environ["CHAPTLY_API_SECRET"]
|
| 5 |
+
API_KEY = os.environ["API_KEYS"] # optional, only if using ApiKeyMiddleware
|
| 6 |
+
|
| 7 |
+
def signed_request(method: str, path: str, json_payload: dict | None = None):
|
| 8 |
+
body_bytes = (json.dumps(json_payload or {}) ).encode("utf-8")
|
| 9 |
+
body_hash = hashlib.sha256(body_bytes).hexdigest()
|
| 10 |
+
timestamp = str(int(time.time()))
|
| 11 |
+
canonical = "\n".join([method.upper(), path, body_hash, timestamp])
|
| 12 |
+
signature = hmac.new(API_SECRET.encode(), canonical.encode(), hashlib.sha256).hexdigest()
|
| 13 |
+
|
| 14 |
+
headers = {
|
| 15 |
+
"X-Timestamp": timestamp,
|
| 16 |
+
"X-Signature": signature,
|
| 17 |
+
}
|
| 18 |
+
if API_KEY:
|
| 19 |
+
headers["X-API-Key"] = API_KEY
|
| 20 |
+
|
| 21 |
+
url = f"{API_URL}{path}"
|
| 22 |
+
resp = requests.request(method, url, json=json_payload, headers=headers)
|
| 23 |
+
resp.raise_for_status()
|
| 24 |
+
return resp.json()
|
scripts/create_iam_role.py
ADDED
|
@@ -0,0 +1,144 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"""Utility script to provision S3 read-only credentials for the Streamlit app.
|
| 2 |
+
|
| 3 |
+
This helper creates (or reuses) an IAM user and optional role that have
|
| 4 |
+
`s3:ListBucket` / `s3:GetObject` access to the `chaptly-rag` bucket. It then
|
| 5 |
+
prints the access key and secret so they can be set as environment variables for the Streamlit app.
|
| 6 |
+
|
| 7 |
+
Usage:
|
| 8 |
+
|
| 9 |
+
```bash
|
| 10 |
+
python streamlit/scripts/create_iam_role.py \
|
| 11 |
+
--entity-name streamlit-cache-reader \
|
| 12 |
+
--bucket chaptly-rag
|
| 13 |
+
```
|
| 14 |
+
|
| 15 |
+
The AWS account credentials used to run this script must already have IAM
|
| 16 |
+
permissions to create users/roles, attach policies, and create access keys.
|
| 17 |
+
"""
|
| 18 |
+
|
| 19 |
+
from __future__ import annotations
|
| 20 |
+
|
| 21 |
+
import argparse
|
| 22 |
+
import json
|
| 23 |
+
import sys
|
| 24 |
+
from typing import Any, Dict, Optional
|
| 25 |
+
|
| 26 |
+
import boto3
|
| 27 |
+
from botocore.exceptions import ClientError
|
| 28 |
+
|
| 29 |
+
S3_POLICY_NAME = "StreamlitS3ReadOnly"
|
| 30 |
+
DEFAULT_ENTITY_NAME = "streamlit-cache-reader"
|
| 31 |
+
DEFAULT_BUCKET = "chaptly-rag"
|
| 32 |
+
|
| 33 |
+
|
| 34 |
+
def _build_policy(bucket: str) -> Dict[str, Any]:
|
| 35 |
+
resource_arn = f"arn:aws:s3:::{bucket}"
|
| 36 |
+
object_arn = f"{resource_arn}/*"
|
| 37 |
+
return {
|
| 38 |
+
"Version": "2012-10-17",
|
| 39 |
+
"Statement": [
|
| 40 |
+
{
|
| 41 |
+
"Effect": "Allow",
|
| 42 |
+
"Action": ["s3:ListBucket"],
|
| 43 |
+
"Resource": resource_arn,
|
| 44 |
+
},
|
| 45 |
+
{
|
| 46 |
+
"Effect": "Allow",
|
| 47 |
+
"Action": ["s3:GetObject"],
|
| 48 |
+
"Resource": object_arn,
|
| 49 |
+
},
|
| 50 |
+
],
|
| 51 |
+
}
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
def ensure_user(iam, user_name: str) -> None:
|
| 55 |
+
try:
|
| 56 |
+
iam.get_user(UserName=user_name)
|
| 57 |
+
print(f"Reusing IAM user '{user_name}'.")
|
| 58 |
+
except ClientError as exc:
|
| 59 |
+
if exc.response["Error"]["Code"] == "NoSuchEntity":
|
| 60 |
+
iam.create_user(UserName=user_name)
|
| 61 |
+
print(f"Created IAM user '{user_name}'.")
|
| 62 |
+
else:
|
| 63 |
+
raise
|
| 64 |
+
|
| 65 |
+
|
| 66 |
+
def attach_inline_policy(iam, user_name: str, bucket: str) -> None:
|
| 67 |
+
policy_doc = json.dumps(_build_policy(bucket))
|
| 68 |
+
iam.put_user_policy(UserName=user_name, PolicyName=S3_POLICY_NAME, PolicyDocument=policy_doc)
|
| 69 |
+
print(f"Attached inline S3 read policy '{S3_POLICY_NAME}' to user '{user_name}'.")
|
| 70 |
+
|
| 71 |
+
|
| 72 |
+
def create_access_key(iam, user_name: str) -> Dict[str, str]:
|
| 73 |
+
response = iam.create_access_key(UserName=user_name)
|
| 74 |
+
access_key = response["AccessKey"]
|
| 75 |
+
return {
|
| 76 |
+
"AWS_ACCESS_KEY_ID": access_key["AccessKeyId"],
|
| 77 |
+
"AWS_SECRET_ACCESS_KEY": access_key["SecretAccessKey"],
|
| 78 |
+
}
|
| 79 |
+
|
| 80 |
+
|
| 81 |
+
def ensure_role(iam, role_name: str, bucket: str, assume_policy: Dict[str, Any]) -> None:
|
| 82 |
+
try:
|
| 83 |
+
iam.get_role(RoleName=role_name)
|
| 84 |
+
print(f"Reusing IAM role '{role_name}'.")
|
| 85 |
+
except ClientError as exc:
|
| 86 |
+
if exc.response["Error"]["Code"] == "NoSuchEntity":
|
| 87 |
+
iam.create_role(RoleName=role_name, AssumeRolePolicyDocument=json.dumps(assume_policy))
|
| 88 |
+
print(f"Created IAM role '{role_name}'.")
|
| 89 |
+
else:
|
| 90 |
+
raise
|
| 91 |
+
policy_doc = json.dumps(_build_policy(bucket))
|
| 92 |
+
iam.put_role_policy(RoleName=role_name, PolicyName=S3_POLICY_NAME, PolicyDocument=policy_doc)
|
| 93 |
+
print(f"Attached inline S3 read policy '{S3_POLICY_NAME}' to role '{role_name}'.")
|
| 94 |
+
|
| 95 |
+
|
| 96 |
+
def parse_args() -> argparse.Namespace:
|
| 97 |
+
parser = argparse.ArgumentParser(description="Provision S3 read-only IAM credentials for Streamlit.")
|
| 98 |
+
parser.add_argument("--entity-name", default=DEFAULT_ENTITY_NAME, help="IAM user/role name to create or reuse.")
|
| 99 |
+
parser.add_argument("--bucket", default=DEFAULT_BUCKET, help="S3 bucket name (default: chaptly-rag).")
|
| 100 |
+
parser.add_argument(
|
| 101 |
+
"--create-role",
|
| 102 |
+
action="store_true",
|
| 103 |
+
help="Also create an IAM role with the same name and inline policy (optional).",
|
| 104 |
+
)
|
| 105 |
+
parser.add_argument(
|
| 106 |
+
"--role-trust",
|
| 107 |
+
default=None,
|
| 108 |
+
help="Path to a JSON file describing the assume-role trust policy (required if --create-role).",
|
| 109 |
+
)
|
| 110 |
+
return parser.parse_args()
|
| 111 |
+
|
| 112 |
+
|
| 113 |
+
def main() -> None:
|
| 114 |
+
args = parse_args()
|
| 115 |
+
iam = boto3.client("iam")
|
| 116 |
+
ensure_user(iam, args.entity_name)
|
| 117 |
+
attach_inline_policy(iam, args.entity_name, args.bucket)
|
| 118 |
+
credentials = create_access_key(iam, args.entity_name)
|
| 119 |
+
print("\nAdd the following values to your Streamlit secrets:")
|
| 120 |
+
for key, value in credentials.items():
|
| 121 |
+
print(f"{key} = {value}")
|
| 122 |
+
print("AWS_REGION = ap-southeast-1")
|
| 123 |
+
print(f"CHAPTLY_S3_BUCKET = {args.bucket}")
|
| 124 |
+
|
| 125 |
+
if args.create_role:
|
| 126 |
+
if not args.role_trust:
|
| 127 |
+
raise SystemExit("--role-trust JSON file is required when --create-role is set.")
|
| 128 |
+
with open(args.role_trust, "r", encoding="utf-8") as handle:
|
| 129 |
+
assume_policy = json.load(handle)
|
| 130 |
+
ensure_role(iam, args.entity_name, args.bucket, assume_policy)
|
| 131 |
+
print(
|
| 132 |
+
"\nIAM role created. Attach this role to an EC2/Lambda/Streamlit Cloud runner and expose temporary credentials via environment variables."
|
| 133 |
+
)
|
| 134 |
+
|
| 135 |
+
|
| 136 |
+
if __name__ == "__main__":
|
| 137 |
+
try:
|
| 138 |
+
main()
|
| 139 |
+
except ClientError as exc:
|
| 140 |
+
print(f"AWS error: {exc}")
|
| 141 |
+
sys.exit(1)
|
| 142 |
+
except KeyboardInterrupt:
|
| 143 |
+
print("Aborted by user.")
|
| 144 |
+
sys.exit(130)
|
src/__init__.py
ADDED
|
File without changes
|
src/pages/__init__.py
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"""Streamlit page entrypoints."""
|
| 2 |
+
|
| 3 |
+
from ._home_page import home_page
|
| 4 |
+
from ._about_page import about_page
|
| 5 |
+
from ._contact_page import contact_page
|
| 6 |
+
|
| 7 |
+
__all__ = ["home_page", "about_page", "contact_page"]
|
src/pages/_about_page.py
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import streamlit as st
|
| 2 |
+
|
| 3 |
+
from utils.helpers import get_image_base64, get_remote_image_url, resolve_image_source
|
| 4 |
+
|
| 5 |
+
|
| 6 |
+
def about_page() -> None:
|
| 7 |
+
st.title("About Chaptly AI")
|
| 8 |
+
st.markdown(
|
| 9 |
+
"Chaptly is a conversational tutor that turns long-form YouTube lectures into searchable,"
|
| 10 |
+
" grounded study sessions using Gemini, FastAPI, and a fully serverless AWS backbone."
|
| 11 |
+
)
|
| 12 |
+
|
| 13 |
+
cover_src = resolve_image_source("cover_page.jpg")
|
| 14 |
+
if cover_src:
|
| 15 |
+
st.image(cover_src, caption="Serverless AI data pipeline overview", width=512)
|
| 16 |
+
|
| 17 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 18 |
+
st.header("Project Overview")
|
| 19 |
+
st.write(
|
| 20 |
+
"Chaptly indexes pre-approved educational channels, downloads transcripts, chunks and embeds them,"\
|
| 21 |
+
" then exposes bookmarks, semantic search, QA, quizzes, and summaries via a single FastAPI Lambda."\
|
| 22 |
+
" Downstream clients (Hugging Face Space, Streamlit, CLI) interact through API Gateway using API keys"\
|
| 23 |
+
" and strict channel whitelists."
|
| 24 |
+
)
|
| 25 |
+
|
| 26 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 27 |
+
with st.expander("Whitelisted YouTube Channels ✅", expanded=True):
|
| 28 |
+
# Channel data: (logo filename, url, display name)
|
| 29 |
+
channel_data = [
|
| 30 |
+
("MIT OpenCourseWare.png", "https://www.youtube.com/@mitocw", "MIT OpenCourseWare"),
|
| 31 |
+
("Stanford Online.png", "https://www.youtube.com/@stanfordonline", "Stanford Online"),
|
| 32 |
+
("Harvard.png", "https://www.youtube.com/@harvard", "Harvard"),
|
| 33 |
+
("freeCodeCamp.png", "https://www.youtube.com/@freecodecamp", "freeCodeCamp.org"),
|
| 34 |
+
("TEDx.png", "https://www.youtube.com/@TEDx", "TEDx Talks"),
|
| 35 |
+
("SciShow.png", "https://www.youtube.com/@SciShow", "SciShow"),
|
| 36 |
+
("Udacity.png", "https://www.youtube.com/@Udacity", "Udacity"),
|
| 37 |
+
("ProgrammingWithMosh.png", "https://www.youtube.com/@programmingwithmosh", "Programming with Mosh"),
|
| 38 |
+
("Computerphile.png", "https://www.youtube.com/@Computerphile", "Computerphile"),
|
| 39 |
+
("edX.png", "https://www.youtube.com/@edXOnline", "edX"),
|
| 40 |
+
("TED.png", "https://www.youtube.com/@TED", "TED"),
|
| 41 |
+
("YaleCourses.png", "https://www.youtube.com/@YaleCourses", "YaleCourses"),
|
| 42 |
+
("Veritasium.png", "https://www.youtube.com/@veritasium", "Veritasium"),
|
| 43 |
+
("3blue1brown.png", "https://www.youtube.com/@3blue1brown", "3blue1brown"),
|
| 44 |
+
("CrashCourse.png", "https://www.youtube.com/@crashcourse", "CrashCourse"),
|
| 45 |
+
("KhanAcademy.png", "https://www.youtube.com/@khanacademy", "Khan Academy"),
|
| 46 |
+
("minutephysics.png", "https://www.youtube.com/@minutephysics", "minutephysics"),
|
| 47 |
+
("numberphile.png", "https://www.youtube.com/@numberphile", "numberphile"),
|
| 48 |
+
("TEDEd.png", "https://www.youtube.com/@TEDEd", "TED-Ed"),
|
| 49 |
+
("coursera.png", "https://www.youtube.com/@coursera", "Coursera"),
|
| 50 |
+
]
|
| 51 |
+
# Display in rows of 4 columns
|
| 52 |
+
num_cols = 4
|
| 53 |
+
for row_start in range(0, len(channel_data), num_cols):
|
| 54 |
+
cols = st.columns(num_cols)
|
| 55 |
+
for col_idx in range(num_cols):
|
| 56 |
+
idx = row_start + col_idx
|
| 57 |
+
if idx >= len(channel_data):
|
| 58 |
+
continue
|
| 59 |
+
img_filename, url, alt = channel_data[idx]
|
| 60 |
+
with cols[col_idx]:
|
| 61 |
+
img_base64 = get_image_base64(img_filename)
|
| 62 |
+
img_src = (
|
| 63 |
+
f"data:image/png;base64,{img_base64}"
|
| 64 |
+
if img_base64
|
| 65 |
+
else get_remote_image_url(img_filename)
|
| 66 |
+
)
|
| 67 |
+
st.markdown(
|
| 68 |
+
f"""
|
| 69 |
+
<a href='{url}' target='_blank'>
|
| 70 |
+
<img src='{img_src}' style='display:block;margin:auto;width:48px;height:48px;object-fit:contain;' alt='{alt}'/>
|
| 71 |
+
</a>
|
| 72 |
+
""",
|
| 73 |
+
unsafe_allow_html=True
|
| 74 |
+
)
|
| 75 |
+
st.markdown(f"<div style='text-align:center;'><a href='{url}' target='_blank'>{alt}</a></div>", unsafe_allow_html=True)
|
| 76 |
+
|
| 77 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 78 |
+
st.info(
|
| 79 |
+
"Only whitelisted channels are supported due to copyright restrictions and to ensure all ingested content is suitable for educational and tutoring purposes. This policy protects creators' intellectual property and guarantees high-quality, reliable study material for learners."
|
| 80 |
+
)
|
| 81 |
+
|
| 82 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 83 |
+
st.header("Key Features")
|
| 84 |
+
col1, col2 = st.columns(2)
|
| 85 |
+
with col1:
|
| 86 |
+
st.markdown(
|
| 87 |
+
"- **One-click ingestion** queues a background job that fetches transcripts and stores artifacts in S3.\n"
|
| 88 |
+
"- **Grounded QA** cites timestamped transcript snippets for every answer.\n"
|
| 89 |
+
"- **Bookmarks & summaries** give learners instant structure for long lectures."
|
| 90 |
+
)
|
| 91 |
+
with col2:
|
| 92 |
+
st.markdown(
|
| 93 |
+
"- **Quiz builder** mixes MCQ/open prompts sourced from Gemini.\n"
|
| 94 |
+
"- **Semantic search** surfaces the best matching transcript spans instantly.\n"
|
| 95 |
+
"- **Strict channel policy** enforces ingestion only from approved education partners."
|
| 96 |
+
)
|
| 97 |
+
|
| 98 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 99 |
+
st.header("How Chaptly AI Transforms Your Study Experience")
|
| 100 |
+
st.markdown("Chaptly AI is designed to help learners master complex material quickly and at scale:")
|
| 101 |
+
feature_emojis = [
|
| 102 |
+
"🚀", "🔎", "📑", "📝", "💡", "✅"
|
| 103 |
+
]
|
| 104 |
+
feature_titles = [
|
| 105 |
+
"One-click Ingestion",
|
| 106 |
+
"Grounded QA",
|
| 107 |
+
"Bookmarks & Summaries",
|
| 108 |
+
"Quiz Builder",
|
| 109 |
+
"Semantic Search",
|
| 110 |
+
"Strict Channel Policy"
|
| 111 |
+
]
|
| 112 |
+
feature_descriptions = [
|
| 113 |
+
"Instant access to hours of lectures—no manual steps.",
|
| 114 |
+
"Reliable, context-rich answers—less searching, more learning.",
|
| 115 |
+
"Digest lectures into key sections for easy review.",
|
| 116 |
+
"Self-test and reinforce knowledge instantly.",
|
| 117 |
+
"Find the exact explanation you need, fast.",
|
| 118 |
+
"Only high-quality, trusted educational content."
|
| 119 |
+
]
|
| 120 |
+
cols = st.columns(3)
|
| 121 |
+
for i in range(3):
|
| 122 |
+
with cols[i]:
|
| 123 |
+
st.markdown(f"{feature_emojis[i]} **{feature_titles[i]}**")
|
| 124 |
+
st.write(feature_descriptions[i])
|
| 125 |
+
cols2 = st.columns(3)
|
| 126 |
+
for i in range(3, 6):
|
| 127 |
+
with cols2[i-3]:
|
| 128 |
+
st.markdown(f"{feature_emojis[i]} **{feature_titles[i]}**")
|
| 129 |
+
st.write(feature_descriptions[i])
|
| 130 |
+
st.markdown(
|
| 131 |
+
"<br><b>Together, these features empower users to learn faster, retain more, and scale their study efforts across multiple subjects and lectures—making Chaptly AI a powerful tool for modern, rapid, and effective education.</b>", unsafe_allow_html=True
|
| 132 |
+
)
|
| 133 |
+
|
| 134 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 135 |
+
st.header("Tools & Technologies")
|
| 136 |
+
st.markdown(
|
| 137 |
+
"| Layer | Stack |\n| --- | --- |\n"
|
| 138 |
+
"| Backend | FastAPI + Pydantic running on AWS Lambda via Mangum |\n"
|
| 139 |
+
"| Storage | AWS S3 (artifacts + Lambda ZIP), DynamoDB (`ChaptlyJobs`), Secrets Manager |\n"
|
| 140 |
+
"| AI | Google Gemini (text-embedding-004, 1.5 Flash) |\n"
|
| 141 |
+
"| Infra | Terraform (S3, DynamoDB, IAM, Lambda, API Gateway, CloudWatch) |\n"
|
| 142 |
+
"| Frontend | Streamlit & Hugging Face Space clients |"
|
| 143 |
+
)
|
| 144 |
+
|
| 145 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 146 |
+
st.header("Architecture & Flow")
|
| 147 |
+
arch_src = resolve_image_source("user_flow_system_architecture.jpg")
|
| 148 |
+
if arch_src:
|
| 149 |
+
st.image(arch_src, caption="User Flow & System Architecture", width=800)
|
| 150 |
+
st.write(
|
| 151 |
+
"1. User submits a YouTube URL from an approved channel.\n"
|
| 152 |
+
"2. API Gateway forwards the request to the Lambda-hosted FastAPI app.\n"
|
| 153 |
+
"3. Background worker fetches transcripts, chunks + embeds with Gemini, and stores artifacts in S3 with lifecycle policies.\n"
|
| 154 |
+
"4. Job metadata lives in DynamoDB and is polled via `/videos/process/{job_id}`.\n"
|
| 155 |
+
"5. Subsequent queries (bookmarks, QA, summary, quiz, search) reuse cached artifacts for sub-second responses.\n"
|
| 156 |
+
"6. Logs & metrics stream into CloudWatch while Terraform keeps every resource in sync."
|
| 157 |
+
)
|
| 158 |
+
|
| 159 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 160 |
+
st.header("Getting Started")
|
| 161 |
+
st.markdown(
|
| 162 |
+
"1. Use the **Home** page to upload a YouTube lecture, browse bookmarks, and chat with Gemini.\n"
|
| 163 |
+
"2. Visit **Contact** page for support, licensing, and GitHub links."
|
| 164 |
+
)
|
| 165 |
+
|
| 166 |
+
|
| 167 |
+
if __name__ == "__main__":
|
| 168 |
+
about_page()
|
src/pages/_contact_page.py
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import streamlit as st
|
| 2 |
+
|
| 3 |
+
|
| 4 |
+
def contact_page() -> None:
|
| 5 |
+
st.title("Contact & Support")
|
| 6 |
+
st.markdown(
|
| 7 |
+
"Have a question about Chaptly AI, need help onboarding the API, or want to contribute? "
|
| 8 |
+
"Reach out through the channels below."
|
| 9 |
+
)
|
| 10 |
+
|
| 11 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 12 |
+
st.header("Primary Contact")
|
| 13 |
+
st.markdown("- **Email**: [[email protected]](mailto:[email protected])")
|
| 14 |
+
|
| 15 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 16 |
+
st.header("GitHub & Issues")
|
| 17 |
+
st.markdown(
|
| 18 |
+
"- Source: [Github Repository](https://github.com/Jhwong19/chaptly-ai-public)\n"
|
| 19 |
+
"- Please open GitHub Issues for bug reports, feature requests, or deployment questions."
|
| 20 |
+
)
|
| 21 |
+
|
| 22 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 23 |
+
st.header("License")
|
| 24 |
+
st.markdown(
|
| 25 |
+
"Chaptly AI ships under the MIT License. You are free to fork, adapt, and deploy, provided the license"
|
| 26 |
+
" notice remains intact. See the repository `LICENSE` file for full terms."
|
| 27 |
+
)
|
| 28 |
+
|
| 29 |
+
st.markdown("<hr>", unsafe_allow_html=True)
|
| 30 |
+
st.header("Security & Responsible Use")
|
| 31 |
+
st.markdown(
|
| 32 |
+
"- Keep API keys and proxy credentials out of public repos.\n"
|
| 33 |
+
"- Only ingest content from the approved educational channel list.\n"
|
| 34 |
+
"- Contact us immediately if you suspect a credential leak or data exposure."
|
| 35 |
+
)
|
| 36 |
+
|
| 37 |
+
|
| 38 |
+
if __name__ == "__main__":
|
| 39 |
+
contact_page()
|
src/pages/_home_page.py
ADDED
|
@@ -0,0 +1,628 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
from __future__ import annotations
|
| 2 |
+
|
| 3 |
+
from typing import Any, Dict, List, Tuple
|
| 4 |
+
|
| 5 |
+
import requests
|
| 6 |
+
import streamlit as st
|
| 7 |
+
|
| 8 |
+
from utils.helpers import (
|
| 9 |
+
ask_question,
|
| 10 |
+
fetch_bookmarks,
|
| 11 |
+
fetch_job_status,
|
| 12 |
+
fetch_quiz,
|
| 13 |
+
fetch_summary,
|
| 14 |
+
get_image_base64,
|
| 15 |
+
get_remote_image_url,
|
| 16 |
+
list_cached_videos,
|
| 17 |
+
ping_health,
|
| 18 |
+
resolve_image_source,
|
| 19 |
+
semantic_search,
|
| 20 |
+
seconds_to_timestamp,
|
| 21 |
+
start_ingestion,
|
| 22 |
+
youtube_timestamp_link,
|
| 23 |
+
)
|
| 24 |
+
from utils.settings import APPROVED_CHANNELS
|
| 25 |
+
|
| 26 |
+
BOOKMARK_SUMMARY_WORDS = 100
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
def _init_session_state() -> None:
|
| 30 |
+
defaults = {
|
| 31 |
+
"step_done": 0,
|
| 32 |
+
"auto_open": {1: True, 2: False, 3: False, 4: False, 5: False},
|
| 33 |
+
"selected_video_id": "",
|
| 34 |
+
"selected_video_title": "",
|
| 35 |
+
"selected_channel_name": "",
|
| 36 |
+
"job_id_by_video": {},
|
| 37 |
+
"recent_job_status": None,
|
| 38 |
+
"cached_videos": [],
|
| 39 |
+
"bookmarks_by_video": {},
|
| 40 |
+
"bookmark_summaries_by_video": {},
|
| 41 |
+
"summary_by_video": {},
|
| 42 |
+
"quiz_by_video": {},
|
| 43 |
+
"search_results_by_video": {},
|
| 44 |
+
"qa_history_by_video": {},
|
| 45 |
+
}
|
| 46 |
+
for key, value in defaults.items():
|
| 47 |
+
st.session_state.setdefault(key, value)
|
| 48 |
+
st.session_state.setdefault("chat_history", [])
|
| 49 |
+
st.session_state.setdefault("chat_video_id", "")
|
| 50 |
+
if not st.session_state.get("cached_videos"):
|
| 51 |
+
st.session_state["cached_videos"] = list_cached_videos()
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
def _is_step_open(step: int) -> bool:
|
| 55 |
+
return bool(st.session_state.get("auto_open", {}).get(step, False))
|
| 56 |
+
|
| 57 |
+
|
| 58 |
+
def _advance_to_step(step: int) -> None:
|
| 59 |
+
st.session_state["step_done"] = max(st.session_state["step_done"], step)
|
| 60 |
+
if step < 5:
|
| 61 |
+
st.session_state["auto_open"][step] = False
|
| 62 |
+
st.session_state["auto_open"][step + 1] = True
|
| 63 |
+
_set_expander_override(_step_expander_key(step + 1), True)
|
| 64 |
+
|
| 65 |
+
|
| 66 |
+
def _expander_overrides() -> Dict[str, bool]:
|
| 67 |
+
return st.session_state.setdefault("_expander_overrides", {})
|
| 68 |
+
|
| 69 |
+
|
| 70 |
+
def _set_expander_override(key: str, expanded: bool) -> None:
|
| 71 |
+
_expander_overrides()[key] = expanded
|
| 72 |
+
st.session_state.pop(f"_expander_initialized_{key}", None)
|
| 73 |
+
|
| 74 |
+
|
| 75 |
+
def _expander_container(key: str, label: str, default_open: bool):
|
| 76 |
+
overrides = _expander_overrides()
|
| 77 |
+
init_key = f"_expander_initialized_{key}"
|
| 78 |
+
expanded_arg = None
|
| 79 |
+
if key in overrides:
|
| 80 |
+
expanded_arg = overrides.pop(key)
|
| 81 |
+
elif not st.session_state.get(init_key):
|
| 82 |
+
expanded_arg = default_open
|
| 83 |
+
if expanded_arg is None:
|
| 84 |
+
container = st.expander(label)
|
| 85 |
+
else:
|
| 86 |
+
container = st.expander(label, expanded=expanded_arg)
|
| 87 |
+
st.session_state[init_key] = True
|
| 88 |
+
return container
|
| 89 |
+
|
| 90 |
+
|
| 91 |
+
def _step_expander_key(step: int) -> str:
|
| 92 |
+
return f"step_{step}"
|
| 93 |
+
|
| 94 |
+
|
| 95 |
+
def _step_expander(step: int, label: str):
|
| 96 |
+
return _expander_container(_step_expander_key(step), label, _is_step_open(step))
|
| 97 |
+
|
| 98 |
+
|
| 99 |
+
def _named_expander(key: str, label: str, default_open: bool = False):
|
| 100 |
+
return _expander_container(key, label, default_open)
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
def _refresh_cached_videos_list() -> None:
|
| 104 |
+
if hasattr(list_cached_videos, "clear"):
|
| 105 |
+
list_cached_videos.clear()
|
| 106 |
+
st.session_state["cached_videos"] = list_cached_videos()
|
| 107 |
+
|
| 108 |
+
|
| 109 |
+
def _render_sidebar_stepper() -> None:
|
| 110 |
+
with st.sidebar:
|
| 111 |
+
st.markdown("### Progress")
|
| 112 |
+
sidebar_labels = [
|
| 113 |
+
"Insert YouTube Lecture URL",
|
| 114 |
+
"Browse bookmarks",
|
| 115 |
+
"Summary & Quizzes",
|
| 116 |
+
"Q&A",
|
| 117 |
+
"Smart Search (Optional)",
|
| 118 |
+
]
|
| 119 |
+
for step, label in enumerate(sidebar_labels, start=1):
|
| 120 |
+
status = "✅" if st.session_state["step_done"] >= step else "⬜️"
|
| 121 |
+
st.write(f"{status} Step {step}: {label}")
|
| 122 |
+
|
| 123 |
+
|
| 124 |
+
def _render_api_status() -> None:
|
| 125 |
+
try:
|
| 126 |
+
health = ping_health()
|
| 127 |
+
if health.get("status") == "ok":
|
| 128 |
+
st.caption("✅ API online")
|
| 129 |
+
else:
|
| 130 |
+
st.caption("❌ API offline")
|
| 131 |
+
except RuntimeError as exc:
|
| 132 |
+
st.caption(f"❌ {str(exc)}")
|
| 133 |
+
|
| 134 |
+
|
| 135 |
+
def _fetch_youtube_metadata(video_url: str) -> Dict[str, Any] | None:
|
| 136 |
+
if not video_url:
|
| 137 |
+
return None
|
| 138 |
+
oembed_url = f"https://www.youtube.com/oembed?url={video_url}&format=json"
|
| 139 |
+
try:
|
| 140 |
+
response = requests.get(oembed_url, timeout=10)
|
| 141 |
+
if response.status_code == 200:
|
| 142 |
+
return response.json()
|
| 143 |
+
except requests.RequestException:
|
| 144 |
+
return None
|
| 145 |
+
return None
|
| 146 |
+
|
| 147 |
+
|
| 148 |
+
def _render_whitelist_expander() -> None:
|
| 149 |
+
channel_data = [
|
| 150 |
+
("MIT OpenCourseWare.png", "https://www.youtube.com/@mitocw", "MIT OpenCourseWare"),
|
| 151 |
+
("Stanford Online.png", "https://www.youtube.com/@stanfordonline", "Stanford Online"),
|
| 152 |
+
("Harvard.png", "https://www.youtube.com/@harvard", "Harvard"),
|
| 153 |
+
("freeCodeCamp.png", "https://www.youtube.com/@freecodecamp", "freeCodeCamp.org"),
|
| 154 |
+
("TEDx.png", "https://www.youtube.com/@TEDx", "TEDx Talks"),
|
| 155 |
+
("SciShow.png", "https://www.youtube.com/@SciShow", "SciShow"),
|
| 156 |
+
("Udacity.png", "https://www.youtube.com/@Udacity", "Udacity"),
|
| 157 |
+
("ProgrammingWithMosh.png", "https://www.youtube.com/@programmingwithmosh", "Programming with Mosh"),
|
| 158 |
+
("Computerphile.png", "https://www.youtube.com/@Computerphile", "Computerphile"),
|
| 159 |
+
("edX.png", "https://www.youtube.com/@edXOnline", "edX"),
|
| 160 |
+
("TED.png", "https://www.youtube.com/@TED", "TED"),
|
| 161 |
+
("YaleCourses.png", "https://www.youtube.com/@YaleCourses", "YaleCourses"),
|
| 162 |
+
("Veritasium.png", "https://www.youtube.com/@veritasium", "Veritasium"),
|
| 163 |
+
("3blue1brown.png", "https://www.youtube.com/@3blue1brown", "3blue1brown"),
|
| 164 |
+
("CrashCourse.png", "https://www.youtube.com/@crashcourse", "CrashCourse"),
|
| 165 |
+
("KhanAcademy.png", "https://www.youtube.com/@khanacademy", "Khan Academy"),
|
| 166 |
+
("minutephysics.png", "https://www.youtube.com/@minutephysics", "minutephysics"),
|
| 167 |
+
("numberphile.png", "https://www.youtube.com/@numberphile", "numberphile"),
|
| 168 |
+
("TEDEd.png", "https://www.youtube.com/@TEDEd", "TED-Ed"),
|
| 169 |
+
("coursera.png", "https://www.youtube.com/@coursera", "Coursera"),
|
| 170 |
+
]
|
| 171 |
+
num_cols = 4
|
| 172 |
+
with st.expander("Whitelisted YouTube Channels ✅", expanded=False):
|
| 173 |
+
for row_start in range(0, len(channel_data), num_cols):
|
| 174 |
+
cols = st.columns(num_cols)
|
| 175 |
+
for col_idx in range(num_cols):
|
| 176 |
+
idx = row_start + col_idx
|
| 177 |
+
if idx >= len(channel_data):
|
| 178 |
+
continue
|
| 179 |
+
img_filename, url, alt = channel_data[idx]
|
| 180 |
+
img_base64 = get_image_base64(img_filename)
|
| 181 |
+
img_src = (
|
| 182 |
+
f"data:image/png;base64,{img_base64}"
|
| 183 |
+
if img_base64
|
| 184 |
+
else get_remote_image_url(img_filename)
|
| 185 |
+
)
|
| 186 |
+
with cols[col_idx]:
|
| 187 |
+
st.markdown(
|
| 188 |
+
f"""
|
| 189 |
+
<a href='{url}' target='_blank'>
|
| 190 |
+
<img src='{img_src}' style='display:block;margin:auto;width:48px;height:48px;object-fit:contain;' alt='{alt}'/>
|
| 191 |
+
</a>
|
| 192 |
+
""",
|
| 193 |
+
unsafe_allow_html=True,
|
| 194 |
+
)
|
| 195 |
+
st.markdown(
|
| 196 |
+
f"<div style='text-align:center;'><a href='{url}' target='_blank'>{alt}</a></div>",
|
| 197 |
+
unsafe_allow_html=True,
|
| 198 |
+
)
|
| 199 |
+
|
| 200 |
+
|
| 201 |
+
def _render_step_one() -> None:
|
| 202 |
+
with _step_expander(1, "Step 1 — Insert YouTube Lecture URL"):
|
| 203 |
+
video_url = st.text_input(
|
| 204 |
+
"YouTube URL",
|
| 205 |
+
value=st.session_state.get("step1_video_url", ""),
|
| 206 |
+
placeholder="https://www.youtube.com/watch?v=GOgA8JGUiwI",
|
| 207 |
+
key="step1_video_url_input",
|
| 208 |
+
)
|
| 209 |
+
metadata = st.session_state.get("step1_metadata")
|
| 210 |
+
if video_url and video_url != st.session_state.get("step1_metadata_url"):
|
| 211 |
+
metadata = _fetch_youtube_metadata(video_url)
|
| 212 |
+
st.session_state["step1_metadata"] = metadata
|
| 213 |
+
st.session_state["step1_metadata_url"] = video_url
|
| 214 |
+
if metadata:
|
| 215 |
+
st.markdown(f"<span style='font-size:1.3rem;color:#F63366;font-weight:600;'>{metadata.get('title', 'Untitled lecture')}</span>", unsafe_allow_html=True)
|
| 216 |
+
st.markdown(f"<span style='font-size:1.3rem;color:#666;font-weight:500;'>Channel: {metadata.get('author_name', 'Unknown')}</span>", unsafe_allow_html=True)
|
| 217 |
+
st.video(video_url)
|
| 218 |
+
elif video_url:
|
| 219 |
+
st.warning("Could not fetch metadata for this URL.")
|
| 220 |
+
run_col, refresh_col = st.columns([3, 1])
|
| 221 |
+
with run_col:
|
| 222 |
+
if st.button("Run", type="primary", disabled=not bool(video_url), key="run_btn_step1"):
|
| 223 |
+
with st.spinner("Running ingestion..."):
|
| 224 |
+
_handle_run(video_url, metadata) if video_url else None
|
| 225 |
+
with refresh_col:
|
| 226 |
+
st.button(
|
| 227 |
+
"Refresh Job Status",
|
| 228 |
+
disabled=not bool(video_url),
|
| 229 |
+
on_click=_handle_refresh_job_status if video_url else None,
|
| 230 |
+
key="refresh_job_status_btn"
|
| 231 |
+
)
|
| 232 |
+
if st.session_state.get("recent_job_status"):
|
| 233 |
+
status = st.session_state["recent_job_status"]
|
| 234 |
+
state_raw = status.get("state", "unknown") or "unknown"
|
| 235 |
+
state = state_raw.lower()
|
| 236 |
+
message = status.get("message", "")
|
| 237 |
+
job_id = status.get("job_id")
|
| 238 |
+
show_processing_hint = False
|
| 239 |
+
processing_states = {"queued", "pending", "running", "processing", "started", "submitted"}
|
| 240 |
+
if state == "failed" and "not in the approved list" in message:
|
| 241 |
+
st.error(f"Job {job_id} — failed: YouTube Channel not in the approved list.")
|
| 242 |
+
elif state == "failed":
|
| 243 |
+
st.error(f"Job {job_id} — failed: {message}")
|
| 244 |
+
else:
|
| 245 |
+
st.info(f"Job {job_id} — {state_raw}: {message}")
|
| 246 |
+
if state in processing_states:
|
| 247 |
+
show_processing_hint = True
|
| 248 |
+
if show_processing_hint:
|
| 249 |
+
st.info("Processing may take some time to ingest the YouTube video, transcribe it, and convert it into embeddings.")
|
| 250 |
+
# Whitelisted Youtube Channels expander closed by default
|
| 251 |
+
_render_whitelist_expander()
|
| 252 |
+
with st.expander("What does Run and Job Refresh Status do?", expanded=False):
|
| 253 |
+
st.markdown(
|
| 254 |
+
"- Checks whether the lecture artifacts already exist in S3\n"
|
| 255 |
+
"- Queues ingestion via the FastAPI backend if missing\n"
|
| 256 |
+
"- `Refresh job status` polls `/videos/process/{job_id}` until the artifacts are ready."
|
| 257 |
+
)
|
| 258 |
+
_render_cached_videos()
|
| 259 |
+
|
| 260 |
+
|
| 261 |
+
def _handle_run(video_url: str, metadata: Dict[str, Any] | None) -> None:
|
| 262 |
+
if not video_url or not metadata:
|
| 263 |
+
st.warning("Provide a valid YouTube URL and ensure metadata loads before running.")
|
| 264 |
+
return
|
| 265 |
+
try:
|
| 266 |
+
response = start_ingestion(video_url)
|
| 267 |
+
except RuntimeError as exc:
|
| 268 |
+
st.error(str(exc))
|
| 269 |
+
_render_whitelist_hint()
|
| 270 |
+
return
|
| 271 |
+
video_id = response.get("video_id")
|
| 272 |
+
job_id = response.get("job_id")
|
| 273 |
+
if video_id and job_id:
|
| 274 |
+
st.session_state["job_id_by_video"][video_id] = job_id
|
| 275 |
+
st.session_state["selected_video_id"] = video_id
|
| 276 |
+
st.session_state["selected_video_title"] = metadata.get("title", video_id)
|
| 277 |
+
st.session_state["selected_channel_name"] = metadata.get("author_name", "")
|
| 278 |
+
# Instead of showing ingestion queued, check job status first
|
| 279 |
+
try:
|
| 280 |
+
status = fetch_job_status(job_id)
|
| 281 |
+
st.session_state["recent_job_status"] = status
|
| 282 |
+
except RuntimeError as exc:
|
| 283 |
+
st.session_state["recent_job_status"] = {"job_id": job_id, "state": "failed", "message": str(exc)}
|
| 284 |
+
_advance_to_step(1)
|
| 285 |
+
else:
|
| 286 |
+
st.warning("Backend did not return a job_id/video_id. Check logs.")
|
| 287 |
+
|
| 288 |
+
|
| 289 |
+
def _handle_refresh_job_status() -> None:
|
| 290 |
+
video_id = st.session_state.get("selected_video_id")
|
| 291 |
+
if not video_id:
|
| 292 |
+
st.info("Select or ingest a video first.")
|
| 293 |
+
return
|
| 294 |
+
job_id = st.session_state["job_id_by_video"].get(video_id)
|
| 295 |
+
if not job_id:
|
| 296 |
+
st.warning("No job associated with this video yet.")
|
| 297 |
+
return
|
| 298 |
+
try:
|
| 299 |
+
status = fetch_job_status(job_id)
|
| 300 |
+
st.session_state["recent_job_status"] = status
|
| 301 |
+
_refresh_cached_videos_list()
|
| 302 |
+
# Do NOT advance step or change auto_open here, so expander state is preserved
|
| 303 |
+
st.info(f"State: {status.get('state')} — {status.get('message', '')}")
|
| 304 |
+
except RuntimeError as exc:
|
| 305 |
+
st.error(str(exc))
|
| 306 |
+
|
| 307 |
+
|
| 308 |
+
def _render_whitelist_hint() -> None:
|
| 309 |
+
st.warning("Channel not currently approved. Approved channels include:")
|
| 310 |
+
st.write(", ".join(APPROVED_CHANNELS))
|
| 311 |
+
|
| 312 |
+
|
| 313 |
+
def _render_cached_videos() -> None:
|
| 314 |
+
with _named_expander("cached_videos", "Cached Videos", default_open=True):
|
| 315 |
+
col_refresh, _ = st.columns([1, 3])
|
| 316 |
+
if col_refresh.button("Refresh list", key="refresh_cache_list"):
|
| 317 |
+
_refresh_cached_videos_list()
|
| 318 |
+
cached = st.session_state.get("cached_videos") or []
|
| 319 |
+
if not cached:
|
| 320 |
+
st.info("No cached videos detected yet.")
|
| 321 |
+
return
|
| 322 |
+
# Make scrollable if more than 4 videos
|
| 323 |
+
max_height = "400px" if len(cached) > 4 else "auto"
|
| 324 |
+
st.markdown(f"<div style='max-height:{max_height};overflow-y:auto;'>", unsafe_allow_html=True)
|
| 325 |
+
for video in cached:
|
| 326 |
+
video_id = video.get("video_id")
|
| 327 |
+
video_title = video.get("title")
|
| 328 |
+
channel_name = video.get("channel_name")
|
| 329 |
+
thumbnail_url = video.get("thumbnail_url")
|
| 330 |
+
video_url = video.get("url") or f"https://www.youtube.com/watch?v={video_id}"
|
| 331 |
+
# If title or channel_name missing, fetch metadata
|
| 332 |
+
if not video_title or not channel_name:
|
| 333 |
+
metadata = _fetch_youtube_metadata(video_url)
|
| 334 |
+
if metadata:
|
| 335 |
+
video_title = metadata.get("title", video_id)
|
| 336 |
+
channel_name = metadata.get("author_name", "")
|
| 337 |
+
else:
|
| 338 |
+
video_title = video_title or video_id
|
| 339 |
+
channel_name = channel_name or ""
|
| 340 |
+
cols = st.columns([1, 3, 1])
|
| 341 |
+
# Render thumbnail, fallback to YouTube default if missing
|
| 342 |
+
if thumbnail_url:
|
| 343 |
+
cols[0].image(thumbnail_url, width='stretch')
|
| 344 |
+
else:
|
| 345 |
+
yt_thumb = f"https://img.youtube.com/vi/{video_id}/hqdefault.jpg"
|
| 346 |
+
cols[0].image(yt_thumb, width='stretch')
|
| 347 |
+
# Show video name and channel name
|
| 348 |
+
cols[1].markdown(f"<span style='font-size:1.1rem;font-weight:600;color:#F63366;'>Video: {video_title}</span>", unsafe_allow_html=True)
|
| 349 |
+
cols[1].markdown(f"<span style='font-size:1.1rem;font-weight:500;color:#666;'>Channel: {channel_name}</span>", unsafe_allow_html=True)
|
| 350 |
+
cols[1].markdown(f"[Watch on YouTube ↗]({video_url})")
|
| 351 |
+
if cols[2].button("Use this video", key=f"use_{video_id}"):
|
| 352 |
+
st.session_state["selected_video_id"] = video_id
|
| 353 |
+
st.session_state["selected_video_title"] = video_title
|
| 354 |
+
st.session_state["selected_channel_name"] = channel_name
|
| 355 |
+
_advance_to_step(1)
|
| 356 |
+
st.markdown("</div>", unsafe_allow_html=True)
|
| 357 |
+
|
| 358 |
+
|
| 359 |
+
def _select_video(label: str, key: str) -> str:
|
| 360 |
+
cached = st.session_state.get("cached_videos") or []
|
| 361 |
+
options: List[Tuple[str, str]] = []
|
| 362 |
+
selected_id = st.session_state.get("selected_video_id", "")
|
| 363 |
+
selected_label = st.session_state.get("selected_video_title")
|
| 364 |
+
selected_channel = st.session_state.get("selected_channel_name")
|
| 365 |
+
# If selected_label or selected_channel missing, fetch metadata
|
| 366 |
+
if selected_id:
|
| 367 |
+
if not selected_label or not selected_channel:
|
| 368 |
+
# Find video_url from cached videos
|
| 369 |
+
cached = st.session_state.get("cached_videos") or []
|
| 370 |
+
video_url = None
|
| 371 |
+
for video in cached:
|
| 372 |
+
if video.get("video_id") == selected_id:
|
| 373 |
+
video_url = video.get("url") or f"https://www.youtube.com/watch?v={selected_id}"
|
| 374 |
+
break
|
| 375 |
+
if video_url:
|
| 376 |
+
metadata = _fetch_youtube_metadata(video_url)
|
| 377 |
+
if metadata:
|
| 378 |
+
selected_label = metadata.get("title", selected_id)
|
| 379 |
+
selected_channel = metadata.get("author_name", "")
|
| 380 |
+
st.session_state["selected_video_title"] = selected_label
|
| 381 |
+
st.session_state["selected_channel_name"] = selected_channel
|
| 382 |
+
else:
|
| 383 |
+
selected_label = selected_label or selected_id
|
| 384 |
+
selected_channel = selected_channel or ""
|
| 385 |
+
options.append((selected_id, f"{selected_label} ({selected_channel})"))
|
| 386 |
+
for video in cached:
|
| 387 |
+
video_id = video.get("video_id")
|
| 388 |
+
video_title = video.get("title")
|
| 389 |
+
channel_name = video.get("channel_name")
|
| 390 |
+
video_url = video.get("url") or f"https://www.youtube.com/watch?v={video_id}"
|
| 391 |
+
# If title or channel_name missing, fetch metadata
|
| 392 |
+
if not video_title or not channel_name:
|
| 393 |
+
metadata = _fetch_youtube_metadata(video_url)
|
| 394 |
+
if metadata:
|
| 395 |
+
video_title = metadata.get("title", video_id)
|
| 396 |
+
channel_name = metadata.get("author_name", "")
|
| 397 |
+
else:
|
| 398 |
+
video_title = video_title or video_id
|
| 399 |
+
channel_name = channel_name or ""
|
| 400 |
+
if video_id and video_id != selected_id:
|
| 401 |
+
options.append((video_id, f"{video_title} ({channel_name})"))
|
| 402 |
+
if not options:
|
| 403 |
+
options.append(("", "No cached videos yet"))
|
| 404 |
+
# Always use 'Video Title' as the field name
|
| 405 |
+
choice = st.selectbox("Video Title", options, key=key, format_func=lambda item: item[1])
|
| 406 |
+
video_id = choice[0] if isinstance(choice, tuple) else choice
|
| 407 |
+
if video_id:
|
| 408 |
+
st.session_state["selected_video_id"] = video_id
|
| 409 |
+
# Update title and channel name for selected video
|
| 410 |
+
for video in cached:
|
| 411 |
+
if video.get("video_id") == video_id:
|
| 412 |
+
st.session_state["selected_video_title"] = video.get("title", video_id)
|
| 413 |
+
st.session_state["selected_channel_name"] = video.get("channel_name", "")
|
| 414 |
+
break
|
| 415 |
+
return video_id
|
| 416 |
+
|
| 417 |
+
|
| 418 |
+
def _render_step_two() -> None:
|
| 419 |
+
with _step_expander(2, "Step 2 — Browse bookmarks"):
|
| 420 |
+
video_id = _select_video("Video", key="bookmarks_video_select")
|
| 421 |
+
cols = st.columns(2)
|
| 422 |
+
min_sections = cols[0].slider("Min sections", 1, 10, 3)
|
| 423 |
+
max_sections = cols[1].slider("Max sections", 3, 15, 8)
|
| 424 |
+
if st.button("Browse bookmarks", key="browse_bookmarks_btn"):
|
| 425 |
+
with st.spinner("Fetching bookmarks..."):
|
| 426 |
+
if not video_id:
|
| 427 |
+
st.warning("Select a video first.")
|
| 428 |
+
return
|
| 429 |
+
try:
|
| 430 |
+
bookmarks = list(fetch_bookmarks(video_id, max_sections=max_sections, min_sections=min_sections))
|
| 431 |
+
st.session_state["bookmarks_by_video"][video_id] = bookmarks
|
| 432 |
+
st.session_state["bookmark_summaries_by_video"][video_id] = _summarize_bookmarks(video_id, bookmarks)
|
| 433 |
+
_advance_to_step(2)
|
| 434 |
+
except RuntimeError as exc:
|
| 435 |
+
st.error(str(exc))
|
| 436 |
+
|
| 437 |
+
_bookmarks = st.session_state["bookmarks_by_video"].get(video_id) or []
|
| 438 |
+
_summaries = st.session_state["bookmark_summaries_by_video"].get(video_id) or []
|
| 439 |
+
if _bookmarks:
|
| 440 |
+
st.markdown("#### Bookmarks")
|
| 441 |
+
for idx, bookmark in enumerate(_bookmarks):
|
| 442 |
+
timestamp = int(bookmark.get("timestamp_seconds") or 0)
|
| 443 |
+
ts_str = bookmark.get("timestamp") or seconds_to_timestamp(timestamp)
|
| 444 |
+
link = youtube_timestamp_link(video_id, timestamp)
|
| 445 |
+
title = bookmark.get("title", f"Section {idx + 1}")
|
| 446 |
+
st.markdown(f"**{idx + 1}. {title}** — `{ts_str}` [Watch ↗]({link})")
|
| 447 |
+
summary = _summaries[idx]["summary"] if idx < len(_summaries) else bookmark.get("description", "")
|
| 448 |
+
st.write(summary)
|
| 449 |
+
sources = _summaries[idx].get("sources", []) if idx < len(_summaries) else []
|
| 450 |
+
if sources:
|
| 451 |
+
with st.expander("Sources", expanded=False):
|
| 452 |
+
for source in sources:
|
| 453 |
+
ts = int(source.get("timestamp_seconds") or 0)
|
| 454 |
+
ts_str_source = source.get("timestamp") or seconds_to_timestamp(ts)
|
| 455 |
+
link_source = youtube_timestamp_link(source.get("video_id", video_id), ts)
|
| 456 |
+
st.write(f"[{ts_str_source}] {source.get('text', '')}")
|
| 457 |
+
st.markdown(f"[Open clip ↗]({link_source})")
|
| 458 |
+
st.divider()
|
| 459 |
+
|
| 460 |
+
|
| 461 |
+
def _summarize_bookmarks(video_id: str, bookmarks: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
|
| 462 |
+
results: List[Dict[str, Any]] = []
|
| 463 |
+
for idx, bookmark in enumerate(bookmarks):
|
| 464 |
+
bookmark_title = bookmark.get("title") or f"Section {idx + 1}"
|
| 465 |
+
prompt = (
|
| 466 |
+
f"Summarize the section of the lecture about '{bookmark_title}' in {BOOKMARK_SUMMARY_WORDS} words or fewer. Highlight the key ideas only."
|
| 467 |
+
)
|
| 468 |
+
try:
|
| 469 |
+
response = ask_question(video_id, prompt)
|
| 470 |
+
results.append({"summary": response.get("answer", ""), "sources": response.get("sources", [])})
|
| 471 |
+
except RuntimeError:
|
| 472 |
+
results.append({"summary": bookmark.get("description", "Summary unavailable."), "sources": []})
|
| 473 |
+
return results
|
| 474 |
+
|
| 475 |
+
|
| 476 |
+
def _render_step_three() -> None:
|
| 477 |
+
with _step_expander(3, "Step 3 — Summary & quizzes"):
|
| 478 |
+
video_id = _select_video("Video", key="summary_video_select")
|
| 479 |
+
style_display = st.selectbox(
|
| 480 |
+
"Quiz style",
|
| 481 |
+
[
|
| 482 |
+
"Mixed",
|
| 483 |
+
"Multiple Choice Questions (MCQ)",
|
| 484 |
+
"Open-ended Questions",
|
| 485 |
+
],
|
| 486 |
+
key="quiz_style_display",
|
| 487 |
+
)
|
| 488 |
+
style_map = {
|
| 489 |
+
"Mixed": "mixed",
|
| 490 |
+
"Multiple Choice Questions (MCQ)": "mcq",
|
| 491 |
+
"Open-ended Questions": "open",
|
| 492 |
+
}
|
| 493 |
+
num_questions = st.slider("Number of questions", 1, 10, 3, key="quiz_question_slider")
|
| 494 |
+
max_words = st.slider("Summary length (words)", 200, 500, 200, key="summary_word_slider")
|
| 495 |
+
if st.button("Summary & quizzes", key="summary_quiz_btn"):
|
| 496 |
+
with st.spinner("Generating summary and quiz..."):
|
| 497 |
+
if not video_id:
|
| 498 |
+
st.warning("Select a video first.")
|
| 499 |
+
return
|
| 500 |
+
try:
|
| 501 |
+
st.session_state["summary_by_video"][video_id] = fetch_summary(video_id, max_words=max_words)
|
| 502 |
+
st.session_state["quiz_by_video"][video_id] = list(
|
| 503 |
+
fetch_quiz(video_id, num_questions=num_questions, style=style_map[style_display])
|
| 504 |
+
)
|
| 505 |
+
_advance_to_step(3)
|
| 506 |
+
except RuntimeError as exc:
|
| 507 |
+
st.error(str(exc))
|
| 508 |
+
summary_payload = st.session_state["summary_by_video"].get(video_id)
|
| 509 |
+
quiz_items = st.session_state["quiz_by_video"].get(video_id)
|
| 510 |
+
bookmark_summaries = st.session_state["bookmark_summaries_by_video"].get(video_id, [])
|
| 511 |
+
if summary_payload or quiz_items:
|
| 512 |
+
overall_tab, quiz_tab = st.tabs(["Overall", "Quiz"])
|
| 513 |
+
with overall_tab:
|
| 514 |
+
if summary_payload:
|
| 515 |
+
summary_text = summary_payload.get("summary", "")
|
| 516 |
+
st.write(summary_text)
|
| 517 |
+
if summary_text.strip() == "Insufficient context.":
|
| 518 |
+
st.warning("If you see 'Insufficient context.', the lecture may not be fully processed yet—try re-running ingestion or checking the video's status.")
|
| 519 |
+
else:
|
| 520 |
+
st.info("Run the summary to populate this tab.")
|
| 521 |
+
with quiz_tab:
|
| 522 |
+
if quiz_items:
|
| 523 |
+
for idx, item in enumerate(quiz_items, start=1):
|
| 524 |
+
st.markdown(f"**Q{idx}: {item.get('question')}**")
|
| 525 |
+
choices = item.get("choices") or []
|
| 526 |
+
for choice in choices:
|
| 527 |
+
st.write(f"- {choice}")
|
| 528 |
+
st.write(f"**Answer:** {item.get('answer')}")
|
| 529 |
+
if item.get("explanation"):
|
| 530 |
+
st.caption(item["explanation"])
|
| 531 |
+
else:
|
| 532 |
+
st.info("Generate a quiz to populate this tab.")
|
| 533 |
+
|
| 534 |
+
|
| 535 |
+
def _render_step_four() -> None:
|
| 536 |
+
with _step_expander(5, "Step 5 — Smart Search (Optional)"):
|
| 537 |
+
video_id = _select_video("Video", key="search_video_select")
|
| 538 |
+
query = st.text_area(
|
| 539 |
+
"Query",
|
| 540 |
+
key="semantic_query_input",
|
| 541 |
+
height=80,
|
| 542 |
+
placeholder="Locate the key segments in the video that discusses the core subject of the video (please be as specific as possible)."
|
| 543 |
+
)
|
| 544 |
+
st.caption("Enter a natural language query to find relevant segments in the video. For example, you can ask for key topics, explanations, or specific concepts. Please be as specific as possible in your query.")
|
| 545 |
+
limit = st.slider("Results", 1, 10, 4, key="semantic_limit_slider")
|
| 546 |
+
st.caption("The number of top matching segments to display based on your query.")
|
| 547 |
+
if st.button("Search", key="semantic_search_btn"):
|
| 548 |
+
with st.spinner("Searching..."):
|
| 549 |
+
if not video_id or not query:
|
| 550 |
+
st.warning("Provide a video and query.")
|
| 551 |
+
return
|
| 552 |
+
try:
|
| 553 |
+
results = list(semantic_search(query, video_id, limit))
|
| 554 |
+
st.session_state["search_results_by_video"][video_id] = results
|
| 555 |
+
_advance_to_step(4)
|
| 556 |
+
except RuntimeError as exc:
|
| 557 |
+
st.error(str(exc))
|
| 558 |
+
|
| 559 |
+
results = st.session_state["search_results_by_video"].get(video_id) or []
|
| 560 |
+
for item in results:
|
| 561 |
+
ts = int(item.get("timestamp_seconds") or 0)
|
| 562 |
+
ts_str = seconds_to_timestamp(ts)
|
| 563 |
+
link = youtube_timestamp_link(video_id, ts)
|
| 564 |
+
st.markdown(f"`{ts_str}` {item.get('text', '')}")
|
| 565 |
+
st.markdown(f"[Open clip ↗]({link})")
|
| 566 |
+
|
| 567 |
+
|
| 568 |
+
def _render_step_five() -> None:
|
| 569 |
+
with _step_expander(4, "Step 4 — Q&A"):
|
| 570 |
+
video_id = _select_video("Video", key="qa_video_select")
|
| 571 |
+
question = st.text_area(
|
| 572 |
+
"Question",
|
| 573 |
+
key="qa_question_input",
|
| 574 |
+
height=80,
|
| 575 |
+
placeholder="Ask a grounded question"
|
| 576 |
+
)
|
| 577 |
+
if st.button("Run", key="qa_generate_btn"):
|
| 578 |
+
if not video_id or not question:
|
| 579 |
+
st.warning("Provide a question and select a video.")
|
| 580 |
+
return
|
| 581 |
+
try:
|
| 582 |
+
response = ask_question(video_id, question)
|
| 583 |
+
history = st.session_state["qa_history_by_video"].setdefault(video_id, [])
|
| 584 |
+
history.append({"question": question, "answer": response.get("answer", ""), "sources": response.get("sources", [])})
|
| 585 |
+
_advance_to_step(5)
|
| 586 |
+
except RuntimeError as exc:
|
| 587 |
+
st.error(str(exc))
|
| 588 |
+
|
| 589 |
+
history = st.session_state["qa_history_by_video"].get(video_id) or []
|
| 590 |
+
if history:
|
| 591 |
+
st.markdown("#### Multi-turn Q&A History")
|
| 592 |
+
for idx, item in enumerate(history, start=1):
|
| 593 |
+
st.markdown(f"<div style='background:#FFF0F5;border-radius:10px;padding:14px 14px 10px 14px;margin-bottom:12px;border:1px solid #F63366;'>"
|
| 594 |
+
f"<b style='color:#F63366'>Q{idx}:</b> <span style='color:#D72660;font-weight:500'>{item.get('question')}</span><br>"
|
| 595 |
+
f"<b style='color:#F63366'>A{idx}:</b> <span style='color:#333'>{item.get('answer', '')}</span>"
|
| 596 |
+
"</div>", unsafe_allow_html=True)
|
| 597 |
+
if item.get("sources"):
|
| 598 |
+
with st.expander("Sources", expanded=False):
|
| 599 |
+
for source in item["sources"]:
|
| 600 |
+
ts = int(source.get("timestamp_seconds") or 0)
|
| 601 |
+
ts_str = source.get("timestamp") or seconds_to_timestamp(ts)
|
| 602 |
+
link = youtube_timestamp_link(source.get("video_id", video_id), ts)
|
| 603 |
+
st.write(f"[{ts_str}] {source.get('text', '')}")
|
| 604 |
+
st.markdown(f"[Open clip ↗]({link})")
|
| 605 |
+
|
| 606 |
+
|
| 607 |
+
def home_page() -> None:
|
| 608 |
+
st.markdown("""
|
| 609 |
+
<div style='display: flex; align-items: center;'>
|
| 610 |
+
<span style='font-size: 2.5rem; margin-right: 0.5rem;'>📚</span>
|
| 611 |
+
<span style='font-size: 2.2rem; font-weight: bold;'>Chaptly AI</span>
|
| 612 |
+
</div>
|
| 613 |
+
""", unsafe_allow_html=True)
|
| 614 |
+
st.markdown("<span style='font-size:1.3rem;color:#F63366;font-weight:500;'>Your AI-powered YouTube study companion</span>", unsafe_allow_html=True)
|
| 615 |
+
st.caption("Chaptly AI: Transcribe, Summarize, Generate Bookmarks, Quizzes and Q&A.")
|
| 616 |
+
_init_session_state()
|
| 617 |
+
_render_sidebar_stepper()
|
| 618 |
+
_render_api_status()
|
| 619 |
+
_render_step_one()
|
| 620 |
+
_render_step_two()
|
| 621 |
+
_render_step_three()
|
| 622 |
+
_render_step_five()
|
| 623 |
+
_render_step_four()
|
| 624 |
+
|
| 625 |
+
|
| 626 |
+
if __name__ == "__main__":
|
| 627 |
+
st.set_page_config(page_title="Chaptly AI", page_icon="📚", layout="wide")
|
| 628 |
+
home_page()
|
src/utils/__init__.py
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
"""Utility helpers for the Streamlit frontend."""
|
src/utils/helpers.py
ADDED
|
@@ -0,0 +1,317 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"""Helper utilities for the Streamlit front-end."""
|
| 2 |
+
|
| 3 |
+
from __future__ import annotations
|
| 4 |
+
|
| 5 |
+
import base64
|
| 6 |
+
import hashlib
|
| 7 |
+
import hmac
|
| 8 |
+
import json
|
| 9 |
+
import os
|
| 10 |
+
import time
|
| 11 |
+
from dataclasses import dataclass
|
| 12 |
+
from functools import lru_cache
|
| 13 |
+
from pathlib import Path
|
| 14 |
+
from typing import Any, Dict, Iterable, Optional
|
| 15 |
+
|
| 16 |
+
import requests
|
| 17 |
+
import streamlit as st
|
| 18 |
+
from botocore.exceptions import ClientError
|
| 19 |
+
import boto3
|
| 20 |
+
|
| 21 |
+
from utils.settings import HF_IMG_BASE_URL
|
| 22 |
+
|
| 23 |
+
DEFAULT_TIMEOUT = 30
|
| 24 |
+
_URL_ENV_KEY = "CHAPTLY_API_URL"
|
| 25 |
+
_API_KEY_ENV_KEY = "CHAPTLY_API_KEY"
|
| 26 |
+
_HMAC_SECRET_ENV_KEY = "CHAPTLY_API_SECRET"
|
| 27 |
+
_S3_BUCKET_ENV_KEY = "CHAPTLY_S3_BUCKET"
|
| 28 |
+
_AWS_REGION_ENV_KEY = "AWS_REGION"
|
| 29 |
+
_SIG_HEADER = "X-Signature"
|
| 30 |
+
_TS_HEADER = "X-Timestamp"
|
| 31 |
+
|
| 32 |
+
DEFAULT_S3_BUCKET = "chaptly-rag"
|
| 33 |
+
DEFAULT_AWS_REGION = "ap-southeast-1"
|
| 34 |
+
IMAGE_REQUEST_TIMEOUT = 10
|
| 35 |
+
_IMG_DIR = Path(__file__).resolve().parents[2] / "img"
|
| 36 |
+
|
| 37 |
+
|
| 38 |
+
@dataclass(frozen=True)
|
| 39 |
+
class APIConfig:
|
| 40 |
+
base_url: str
|
| 41 |
+
api_key: str
|
| 42 |
+
hmac_secret: str
|
| 43 |
+
|
| 44 |
+
|
| 45 |
+
def _get_secret_or_env(key: str, default: str = "") -> str:
|
| 46 |
+
return os.environ.get(key, default).strip()
|
| 47 |
+
|
| 48 |
+
|
| 49 |
+
@st.cache_resource(show_spinner=False)
|
| 50 |
+
def _get_s3_client():
|
| 51 |
+
region = _get_secret_or_env(_AWS_REGION_ENV_KEY, DEFAULT_AWS_REGION) or None
|
| 52 |
+
return boto3.client("s3", region_name=region)
|
| 53 |
+
|
| 54 |
+
|
| 55 |
+
def _get_s3_bucket_name() -> str:
|
| 56 |
+
return _get_secret_or_env(_S3_BUCKET_ENV_KEY, DEFAULT_S3_BUCKET) or DEFAULT_S3_BUCKET
|
| 57 |
+
|
| 58 |
+
|
| 59 |
+
@st.cache_data(show_spinner=False)
|
| 60 |
+
def get_api_config() -> APIConfig:
|
| 61 |
+
"""Return the API URL/key pair, cached for the session."""
|
| 62 |
+
base = _get_secret_or_env(_URL_ENV_KEY)
|
| 63 |
+
api_key = _get_secret_or_env(_API_KEY_ENV_KEY)
|
| 64 |
+
secret = _get_secret_or_env(_HMAC_SECRET_ENV_KEY)
|
| 65 |
+
return APIConfig(base_url=base.rstrip("/"), api_key=api_key, hmac_secret=secret)
|
| 66 |
+
|
| 67 |
+
|
| 68 |
+
def _request(
|
| 69 |
+
method: str,
|
| 70 |
+
path: str,
|
| 71 |
+
*,
|
| 72 |
+
params: Optional[Dict[str, Any]] = None,
|
| 73 |
+
json_payload: Optional[Dict[str, Any]] = None,
|
| 74 |
+
) -> Dict[str, Any]:
|
| 75 |
+
config = get_api_config()
|
| 76 |
+
if not config.base_url:
|
| 77 |
+
raise RuntimeError("CHAPTLY_API_URL is not configured. Set it in Streamlit secrets or environment.")
|
| 78 |
+
if not config.api_key:
|
| 79 |
+
raise RuntimeError("CHAPTLY_API_KEY is not configured. Set it in Streamlit secrets or environment.")
|
| 80 |
+
if not config.hmac_secret:
|
| 81 |
+
raise RuntimeError("CHAPTLY_API_SECRET is not configured. Set it in Streamlit secrets or environment.")
|
| 82 |
+
|
| 83 |
+
url = f"{config.base_url}{path}"
|
| 84 |
+
body_bytes = _serialize_json(json_payload) if json_payload is not None else b""
|
| 85 |
+
if json_payload is not None:
|
| 86 |
+
headers = {"Content-Type": "application/json"}
|
| 87 |
+
else:
|
| 88 |
+
headers = {}
|
| 89 |
+
headers["X-API-Key"] = config.api_key
|
| 90 |
+
_timestamp, _signature = _sign_request(method, path, body_bytes, config.hmac_secret)
|
| 91 |
+
headers[_TS_HEADER] = _timestamp
|
| 92 |
+
headers[_SIG_HEADER] = _signature
|
| 93 |
+
|
| 94 |
+
try:
|
| 95 |
+
resp = requests.request(
|
| 96 |
+
method,
|
| 97 |
+
url,
|
| 98 |
+
headers=headers,
|
| 99 |
+
params=params,
|
| 100 |
+
data=body_bytes if body_bytes else None,
|
| 101 |
+
timeout=DEFAULT_TIMEOUT,
|
| 102 |
+
)
|
| 103 |
+
except requests.RequestException as exc:
|
| 104 |
+
raise RuntimeError(f"Network error contacting API: {exc}") from exc
|
| 105 |
+
|
| 106 |
+
if resp.status_code >= 400:
|
| 107 |
+
error_detail: Any
|
| 108 |
+
try:
|
| 109 |
+
error_detail = resp.json()
|
| 110 |
+
except ValueError:
|
| 111 |
+
error_detail = resp.text
|
| 112 |
+
message = _extract_error_message(error_detail)
|
| 113 |
+
raise RuntimeError(f"API error ({resp.status_code}): {message}")
|
| 114 |
+
|
| 115 |
+
try:
|
| 116 |
+
return resp.json()
|
| 117 |
+
except ValueError as exc:
|
| 118 |
+
raise RuntimeError("API returned invalid JSON") from exc
|
| 119 |
+
|
| 120 |
+
|
| 121 |
+
def _serialize_json(payload: Dict[str, Any]) -> bytes:
|
| 122 |
+
return json.dumps(payload, ensure_ascii=False, separators=(",", ":"), sort_keys=True).encode("utf-8")
|
| 123 |
+
|
| 124 |
+
|
| 125 |
+
def _sign_request(method: str, path: str, body: bytes, secret: str) -> tuple[str, str]:
|
| 126 |
+
timestamp = str(int(time.time()))
|
| 127 |
+
body_hash = hashlib.sha256(body).hexdigest()
|
| 128 |
+
canonical = "\n".join([
|
| 129 |
+
method.upper(),
|
| 130 |
+
path,
|
| 131 |
+
body_hash,
|
| 132 |
+
timestamp,
|
| 133 |
+
])
|
| 134 |
+
signature = hmac.new(secret.encode("utf-8"), canonical.encode("utf-8"), hashlib.sha256).hexdigest()
|
| 135 |
+
return timestamp, signature
|
| 136 |
+
|
| 137 |
+
|
| 138 |
+
def _extract_error_message(error_detail: Any) -> str:
|
| 139 |
+
if isinstance(error_detail, dict):
|
| 140 |
+
if "detail" in error_detail and isinstance(error_detail["detail"], str):
|
| 141 |
+
return error_detail["detail"]
|
| 142 |
+
if "message" in error_detail and isinstance(error_detail["message"], str):
|
| 143 |
+
return error_detail["message"]
|
| 144 |
+
return str(error_detail)
|
| 145 |
+
|
| 146 |
+
|
| 147 |
+
def ping_health() -> Dict[str, Any]:
|
| 148 |
+
return _request("GET", "/health")
|
| 149 |
+
|
| 150 |
+
|
| 151 |
+
def start_ingestion(video_url: str) -> Dict[str, Any]:
|
| 152 |
+
return _request("POST", "/videos/process", params={"url": video_url})
|
| 153 |
+
|
| 154 |
+
|
| 155 |
+
def fetch_job_status(job_id: str) -> Dict[str, Any]:
|
| 156 |
+
return _request("GET", f"/videos/process/{job_id}")
|
| 157 |
+
|
| 158 |
+
|
| 159 |
+
def fetch_bookmarks(video_id: str, *, max_sections: int, min_sections: int) -> Iterable[Dict[str, Any]]:
|
| 160 |
+
payload = _request(
|
| 161 |
+
"GET",
|
| 162 |
+
f"/videos/{video_id}/bookmarks",
|
| 163 |
+
params={"max_sections": max_sections, "min_sections": min_sections},
|
| 164 |
+
)
|
| 165 |
+
return payload
|
| 166 |
+
|
| 167 |
+
|
| 168 |
+
def ask_question(video_id: str, query: str, limit: int = 4) -> Dict[str, Any]:
|
| 169 |
+
return _request(
|
| 170 |
+
"POST",
|
| 171 |
+
f"/videos/{video_id}/qa",
|
| 172 |
+
json_payload={"query": query, "limit": limit},
|
| 173 |
+
)
|
| 174 |
+
|
| 175 |
+
|
| 176 |
+
def fetch_summary(video_id: str, max_words: int = 150) -> Dict[str, Any]:
|
| 177 |
+
return _request("GET", f"/videos/{video_id}/summary", params={"max_words": max_words})
|
| 178 |
+
|
| 179 |
+
|
| 180 |
+
def fetch_quiz(video_id: str, num_questions: int = 3, style: str = "mixed") -> Iterable[Dict[str, Any]]:
|
| 181 |
+
return _request(
|
| 182 |
+
"GET",
|
| 183 |
+
f"/videos/{video_id}/quiz",
|
| 184 |
+
params={"num_questions": num_questions, "style": style},
|
| 185 |
+
)
|
| 186 |
+
|
| 187 |
+
|
| 188 |
+
def semantic_search(query: str, video_id: str, limit: int = 4) -> Iterable[Dict[str, Any]]:
|
| 189 |
+
return _request(
|
| 190 |
+
"POST",
|
| 191 |
+
"/search",
|
| 192 |
+
json_payload={"query": query, "video_id": video_id, "limit": limit},
|
| 193 |
+
)
|
| 194 |
+
|
| 195 |
+
|
| 196 |
+
def seconds_to_timestamp(total_seconds: int) -> str:
|
| 197 |
+
minutes, seconds = divmod(max(total_seconds, 0), 60)
|
| 198 |
+
return f"{minutes:02d}:{seconds:02d}"
|
| 199 |
+
|
| 200 |
+
|
| 201 |
+
def youtube_timestamp_link(video_id: str, timestamp_seconds: Optional[int]) -> str:
|
| 202 |
+
seconds = int(timestamp_seconds or 0)
|
| 203 |
+
return f"https://www.youtube.com/watch?v={video_id}&t={seconds}s"
|
| 204 |
+
|
| 205 |
+
|
| 206 |
+
def render_error(message: str) -> None:
|
| 207 |
+
st.error(message)
|
| 208 |
+
|
| 209 |
+
|
| 210 |
+
def render_success(message: str) -> None:
|
| 211 |
+
st.success(message)
|
| 212 |
+
|
| 213 |
+
|
| 214 |
+
def _build_remote_image_url(filename: str) -> str:
|
| 215 |
+
sanitized = filename.lstrip("/")
|
| 216 |
+
return f"{HF_IMG_BASE_URL.rstrip('/')}/{sanitized}"
|
| 217 |
+
|
| 218 |
+
|
| 219 |
+
def get_remote_image_url(filename: str) -> str:
|
| 220 |
+
"""Public helper to retrieve the remote URL that serves the given asset."""
|
| 221 |
+
return _build_remote_image_url(filename)
|
| 222 |
+
|
| 223 |
+
|
| 224 |
+
def resolve_image_source(filename: str) -> str:
|
| 225 |
+
"""Return a local path if available, otherwise fall back to the remote asset URL."""
|
| 226 |
+
path = _IMG_DIR / filename
|
| 227 |
+
if path.exists():
|
| 228 |
+
return str(path)
|
| 229 |
+
return _build_remote_image_url(filename)
|
| 230 |
+
|
| 231 |
+
|
| 232 |
+
def _load_remote_image_bytes(filename: str) -> Optional[bytes]:
|
| 233 |
+
url = _build_remote_image_url(filename)
|
| 234 |
+
try:
|
| 235 |
+
resp = requests.get(url, timeout=IMAGE_REQUEST_TIMEOUT)
|
| 236 |
+
if resp.status_code == 200:
|
| 237 |
+
return resp.content
|
| 238 |
+
except requests.RequestException:
|
| 239 |
+
return None
|
| 240 |
+
return None
|
| 241 |
+
|
| 242 |
+
|
| 243 |
+
@lru_cache(maxsize=128)
|
| 244 |
+
def get_image_base64(filename: str) -> Optional[str]:
|
| 245 |
+
"""Return a base64-encoded representation of an image from disk or remote storage."""
|
| 246 |
+
path = _IMG_DIR / filename
|
| 247 |
+
if path.exists():
|
| 248 |
+
try:
|
| 249 |
+
return base64.b64encode(path.read_bytes()).decode("utf-8")
|
| 250 |
+
except OSError:
|
| 251 |
+
pass
|
| 252 |
+
data = _load_remote_image_bytes(filename)
|
| 253 |
+
if data is None:
|
| 254 |
+
return None
|
| 255 |
+
return base64.b64encode(data).decode("utf-8")
|
| 256 |
+
|
| 257 |
+
|
| 258 |
+
def _object_exists(key: str) -> bool:
|
| 259 |
+
s3 = _get_s3_client()
|
| 260 |
+
bucket = _get_s3_bucket_name()
|
| 261 |
+
try:
|
| 262 |
+
s3.head_object(Bucket=bucket, Key=key)
|
| 263 |
+
return True
|
| 264 |
+
except ClientError as exc:
|
| 265 |
+
if exc.response.get("Error", {}).get("Code") in {"404", "NoSuchKey"}:
|
| 266 |
+
return False
|
| 267 |
+
raise RuntimeError(f"Unable to read S3 object {key}: {exc}") from exc
|
| 268 |
+
|
| 269 |
+
|
| 270 |
+
def is_video_cached(video_id: str) -> bool:
|
| 271 |
+
if not video_id:
|
| 272 |
+
return False
|
| 273 |
+
video_prefix = video_id.strip().strip("/")
|
| 274 |
+
chunks_key = f"{video_prefix}/chunks.json"
|
| 275 |
+
embeddings_key = f"{video_prefix}/embeddings.npy"
|
| 276 |
+
return _object_exists(chunks_key) and _object_exists(embeddings_key)
|
| 277 |
+
|
| 278 |
+
|
| 279 |
+
def _load_video_metadata(video_id: str) -> Dict[str, Any]:
|
| 280 |
+
s3 = _get_s3_client()
|
| 281 |
+
bucket = _get_s3_bucket_name()
|
| 282 |
+
artifacts_key = f"{video_id}/artifacts.json"
|
| 283 |
+
try:
|
| 284 |
+
obj = s3.get_object(Bucket=bucket, Key=artifacts_key)
|
| 285 |
+
data = json.loads(obj["Body"].read())
|
| 286 |
+
return {
|
| 287 |
+
"video_id": video_id,
|
| 288 |
+
"title": data.get("title") or video_id,
|
| 289 |
+
"channel_name": data.get("channel") or data.get("channel_name", ""),
|
| 290 |
+
"thumbnail_url": data.get("thumbnail_url"),
|
| 291 |
+
"url": data.get("url") or f"https://www.youtube.com/watch?v={video_id}",
|
| 292 |
+
}
|
| 293 |
+
except ClientError:
|
| 294 |
+
return {
|
| 295 |
+
"video_id": video_id,
|
| 296 |
+
"title": video_id,
|
| 297 |
+
"channel_name": "",
|
| 298 |
+
"thumbnail_url": None,
|
| 299 |
+
"url": f"https://www.youtube.com/watch?v={video_id}",
|
| 300 |
+
}
|
| 301 |
+
|
| 302 |
+
|
| 303 |
+
@st.cache_data(show_spinner=False, ttl=300)
|
| 304 |
+
def list_cached_videos() -> list[Dict[str, Any]]:
|
| 305 |
+
s3 = _get_s3_client()
|
| 306 |
+
bucket = _get_s3_bucket_name()
|
| 307 |
+
paginator = s3.get_paginator("list_objects_v2")
|
| 308 |
+
items: list[Dict[str, Any]] = []
|
| 309 |
+
for page in paginator.paginate(Bucket=bucket, Delimiter="/"):
|
| 310 |
+
for prefix in page.get("CommonPrefixes", []):
|
| 311 |
+
video_id = prefix.get("Prefix", "").rstrip("/")
|
| 312 |
+
if not video_id or video_id == "lambda":
|
| 313 |
+
continue
|
| 314 |
+
if is_video_cached(video_id):
|
| 315 |
+
metadata = _load_video_metadata(video_id)
|
| 316 |
+
items.append(metadata)
|
| 317 |
+
return sorted(items, key=lambda item: item.get("title", ""))
|
src/utils/settings.py
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# pylint: disable=missing-module-docstring
|
| 2 |
+
|
| 3 |
+
import os
|
| 4 |
+
|
| 5 |
+
# List of approved YouTube channels from Terms of Use
|
| 6 |
+
APPROVED_CHANNELS = [
|
| 7 |
+
# Academic Institutions
|
| 8 |
+
"MIT OpenCourseWare", "stanford online", "harvard", "YaleCourses",
|
| 9 |
+
|
| 10 |
+
# Educational Platforms
|
| 11 |
+
"Khan Academy", "Coursera", "edx", "udacity",
|
| 12 |
+
|
| 13 |
+
# Educational Content Creators
|
| 14 |
+
"crashcourse", "TED-Ed", "TED", "TEDx Talks", "3blue1brown", "numberphile",
|
| 15 |
+
"Computerphile", "SciShow", "veritasium", "minutephysics",
|
| 16 |
+
"programmingwithmosh", "freecodecamp.org"
|
| 17 |
+
]
|
| 18 |
+
|
| 19 |
+
APPROVED_CHANNEL_IDS = {
|
| 20 |
+
"MIT OpenCourseWare" : "UCEBb1b_L6zDS3xTUrIALZOw",
|
| 21 |
+
"stanford online" : "UCBa5G_ESCn8Yd4vw5U-gIcg",
|
| 22 |
+
"Stanford Online" : "UCBa5G_ESCn8Yd4vw5U-gIcg",
|
| 23 |
+
"harvard" : "UCiR_s0m_o_6x4Qv9F9Kj_1A",
|
| 24 |
+
"Harvard" : "UCiR_s0m_o_6x4Qv9F9Kj_1A",
|
| 25 |
+
"YaleCourses" : "UC-Lg4S121Qk2pPqB09yD3Xg",
|
| 26 |
+
"Khan Academy" : "UC4a-Gbdw7KEp5o7L5d_22wQ",
|
| 27 |
+
"Coursera" : "UCF0m58Cj3iC_qD1L7I2d26Q",
|
| 28 |
+
"edx" : "UCLx1L9tN206S8_61xW_B2qA",
|
| 29 |
+
"udacity" : "UClC7-L9_h7qT9B02D0HhBKA",
|
| 30 |
+
"crashcourse" : "UCX6b17PVsYBQ0ip5gyeme-Q",
|
| 31 |
+
"TED-Ed" : "UC_y-x5QvP93pBqD41zE3e3A",
|
| 32 |
+
"TED" : "UCAuUUnT6oFdlLEx-H-v7Y0A",
|
| 33 |
+
"TEDx Talks" : "UCsooa4yRKGN_zEE8iknghZA",
|
| 34 |
+
"3blue1brown" : "UCYO_jab_esuFRV4b17AJtAw",
|
| 35 |
+
"numberphile" : "UCsT0gAGB4I5rR_n_tM8Qz-A",
|
| 36 |
+
"Computerphile" : "UC9-y-6csu5WGm29I7JiwpnA",
|
| 37 |
+
"SciShow" : "UCZYTClx2T1of7BRZ86-8fow",
|
| 38 |
+
"veritasium" : "UCHnyfMqiRRG1u-2MsSQLbXA",
|
| 39 |
+
"minutephysics" : "UCUHW94eEFW7hkUMVaZz4eDg",
|
| 40 |
+
"programmingwithmosh" : "UCWv7g_L_jL4L_gT43hS-x2A",
|
| 41 |
+
"freecodecamp.org" : "UC8butISFwT-Wl7EV0hUK0BQ"
|
| 42 |
+
}
|
| 43 |
+
|
| 44 |
+
HF_SPACE_ID = os.getenv("HF_SPACE_ID", "Jing997/chaptly")
|
| 45 |
+
HF_SPACE_BRANCH = os.getenv("HF_SPACE_BRANCH", "main")
|
| 46 |
+
HF_ASSET_BASE_URL = os.getenv(
|
| 47 |
+
"HF_ASSET_BASE_URL",
|
| 48 |
+
f"https://huggingface.co/spaces/{HF_SPACE_ID}/resolve/{HF_SPACE_BRANCH}",
|
| 49 |
+
)
|
| 50 |
+
HF_IMG_BASE_URL = os.getenv("HF_IMG_BASE_URL", f"{HF_ASSET_BASE_URL}/img")
|