first commit

.gitignore

@@ -0,0 +1,294 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3
+
+RUN useradd -m -u 1000 user
+USER user
+ENV HOME=/home/user \
+    PATH=/home/user/.local/bin:$PATH
+
+COPY --chown=user . $HOME/roadmapapi
+
+WORKDIR $HOME/roadmapapi
+
+RUN mkdir $HOME/.cache
+
+RUN pip install --no-cache-dir --upgrade -r requirements.txt
+
+CMD ["gunicorn", "-w", "5", "-b", "0.0.0.0:7860","server:app"]

requirements.txt

@@ -0,0 +1,45 @@
+annotated-types==0.7.0
+anyio==4.6.0
+blinker==1.8.2
+cachetools==5.5.0
+certifi==2024.8.30
+charset-normalizer==3.3.2
+click==8.1.7
+distro==1.9.0
+Flask==3.0.3
+Flask-Cors==5.0.0
+google-ai-generativelanguage==0.6.10
+google-api-core==2.20.0
+google-api-python-client==2.147.0
+google-auth==2.35.0
+google-auth-httplib2==0.2.0
+google-generativeai==0.8.2
+googleapis-common-protos==1.65.0
+groq==0.11.0
+grpcio==1.66.2
+grpcio-status==1.66.2
+gunicorn==23.0.0
+h11==0.14.0
+httpcore==1.0.6
+httplib2==0.22.0
+httpx==0.27.2
+idna==3.10
+itsdangerous==2.2.0
+Jinja2==3.1.4
+MarkupSafe==2.1.5
+packaging==24.1
+proto-plus==1.24.0
+protobuf==5.28.2
+pyasn1==0.6.1
+pyasn1_modules==0.4.1
+pydantic==2.9.2
+pydantic_core==2.23.4
+pyparsing==3.1.4
+requests==2.32.3
+rsa==4.9
+sniffio==1.3.1
+tqdm==4.66.5
+typing_extensions==4.12.2
+uritemplate==4.1.1
+urllib3==2.2.3
+Werkzeug==3.0.4

server.py

@@ -0,0 +1,137 @@
+import os
+import json
+
+from flask import Flask, request
+from flask_cors import CORS
+
+import google.generativeai
+google.generativeai.configure(
+    api_key=os.environ.get("GEMINI_API_KEY"))
+
+app = Flask(__name__)
+CORS(app)
+
+
+def output_sanitizer(prompt: str) -> dict:
+    """
+    return dictionary from llm output
+    """
+    begin = prompt.find("{")
+    end = prompt.find("}")
+    output = prompt[begin: end + 1]
+    
+    try:
+        output = json.loads(output)
+    except json.JSONDecodeError:
+        return {}
+    
+    return output
+
+
+def dict_style_changer(file: dict) -> dict: 
+    """
+    parses it in such a way so that mermaid won't crash due to semicolons and such
+    """
+    """
+    {"1[a]" : ["2[b]", "3[c]"], "4[d]" : ["5[e]", "6[f]"]}
+    """
+    new = {}
+    count = 1
+
+    for k, v in file.items():
+        new_key = f"{count}[{k}]"
+        count += 1
+        temp = []
+
+        for i in v:
+            new_value = f"{count}[{i}]"
+            count += 1
+            temp.append(new_value)
+        
+        new[new_key] = temp
+
+    return new
+
+
+def dict_to_mermaid(file: dict) -> str:
+    """
+    returns a mermaid.js syntax to be rendered for the roadmap
+    """
+    file = dict_style_changer(file)
+    output = """
+    flowchart TB\n\t
+    """
+    arrow = " --> "
+    thick_arrow = " ==> "
+
+    for k, v in file.items():
+        output += f"subgraph {k}\n\t{arrow.join(v)}\n\tend\n\t"
+    
+    output += thick_arrow.join(list(file.keys()))
+
+    return output
+
+
+def get_completion(message: str, current_knowledge: str) -> str:
+    """
+    Returns a string with mermaid syntax.
+    """
+    sys_message = f"""
+You are required to provide a learning roadmap for the given topic. The learner profile is provided. Use these data to give a very detailed learning roadmap. Use the output format shown below. Remember to optimize the roadmap as per the learners profile.
+
+Return the output in JSON format.
+Example:
+{{
+    "<Topic>": [
+        "<sub topic 1>", 
+        "<sub topic 2>"
+    ],
+    "<Topic>": [
+        "<sub topic 1>", 
+        "<sub topic 2>"
+    ]
+}}
+
+Topic name: {message}
+Learner profile: {current_knowledge}
+"""
+    llm_model = google.generativeai.GenerativeModel('gemini-1.5-pro')
+    chat_completion = llm_model.generate_content(sys_message)
+    print(chat_completion)
+    chat_completion_text = chat_completion.to_dict()['candidates'][0]['content']['parts'][0]['text']
+    chat_completion_text = chat_completion_text.replace("(", "")
+    chat_completion_text = chat_completion_text.replace(")", "")
+
+    print(dict_to_mermaid(output_sanitizer(chat_completion_text)))
+    return dict_to_mermaid(output_sanitizer(chat_completion_text))
+
+
+
+@app.route("/gemini_output", methods=['POST'])
+def gemini_output():
+    message = request.get_json()
+    print(message)
+    if message['prompt'] == "chess":
+        return {'response': """flowchart TB
+
+    subgraph 1[Fundamentals]
+        2[Objective of the game] --> 3[Chessboard setup] --> 4[Piece movement King, Queen, Rook, Bishop, Knight, Pawn] --> 5[Special moves Castling, En Passant] --> 6[Check, Checkmate, and Stalemate]
+        end
+        subgraph 7[Basic Tactics]
+        8[Piece value and development] --> 9[Controlling the center] --> 10[Forks] --> 11[Pins] --> 12[Skewers] --> 13[Discovered attacks] --> 14[Double attacks] --> 15[Traps]
+        end
+        subgraph 16[Openings]
+        17[Principles of opening theory] --> 18[Common opening traps to avoid] --> 19[Learning a few standard openings e.g., Italian Game, Ruy Lopez, Sicilian Defense] --> 20[Understanding opening goals control of the center, piece development, king safety]
+        end
+        subgraph 21[Middlegame Strategy]
+        22[Planning and evaluating positions] --> 23[Pawn structures and their weaknesses] --> 24[Identifying tactical opportunities] --> 25[Positional play improving piece placement, creating weaknesses] --> 26[Attacking and defending techniques]
+        end
+        subgraph 27[Endgames]
+        28[Basic checkmates King and Queen, King and Rook] --> 29[Theoretical endgames King and Pawn vs King, Rook and Pawn vs Rook] --> 30[Key endgame principles opposition, triangulation, key squares] --> 31[Practice common endgame patterns]
+        end
+        subgraph 32[Beyond the Basics]
+        33[Studying annotated master games] --> 34[Analyzing your own games] --> 35[Solving chess puzzles and tactics] --> 36[Participating in tournaments and online play] --> 37[Utilizing chess software and engines for analysis and training] --> 38[Exploring advanced concepts e.g., prophylaxis, positional sacrifice]
+        end
+        1[Fundamentals] ==> 7[Basic Tactics] ==> 16[Openings] ==> 21[Middlegame Strategy] ==> 27[Endgames] ==> 32[Beyond the Basics]"""}
+    # return {"prompt": "hi " + message['prompt']}
+    return {"response": get_completion(message['prompt'], message['current_knowledge'])}