initial commit

.gitattributes

@@ -1,35 +0,0 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,160 @@
+# 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/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

app.py

@@ -0,0 +1,462 @@
+import streamlit as st
+from chat_client import chat
+import time
+import pandas as pd
+import os
+from dotenv import load_dotenv
+from search_client import SearchClient
+import math
+import numpy as np
+from sentence_transformers import CrossEncoder
+
+load_dotenv()
+
+
+GOOGLE_SEARCH_ENGINE_ID = os.getenv("GOOGLE_SEARCH_ENGINE_ID")
+GOOGLE_SEARCH_API_KEY = os.getenv("GOOGLE_SEARCH_API_KEY")
+BING_SEARCH_API_KEY = os.getenv("BING_SEARCH_API_KEY")
+COST_PER_1000_TOKENS_INR = 0.139
+CHAT_BOTS = {
+    "Mixtral 8x7B v0.1": "mistralai/Mixtral-8x7B-Instruct-v0.1",
+    "Mistral 7B v0.1": "mistralai/Mistral-7B-Instruct-v0.1",
+}
+
+INITIAL_PROMPT_ENGINEERING = {
+    "SYSTEM_INSTRUCTION": """ You are a knowledgeable author on medical conditions, with a deep expertise in Huntington's disease.
+    You provide extensive, clear information on complex medical topics, treatments, new research and developments.
+    You avoid giving personal medical advice or diagnoses but offers general advice and underscores the importance of consulting healthcare professionals.
+    Your goal is to inform, engage and enlighten users that enquire about Huntington's disease, offering factual data and real-life perspectives with anempathetic tone.
+    You use every search available including web search together with articles and information from 
+        * Journal of Huntington's disease, 
+        * Movement Disorders,
+        * Neurology, 
+        * Journal of Neurology, 
+        * Neurosurgery & Psychiatry, 
+        * HDBuzz,
+        * PubMed, 
+        * Huntington's disease Society of America (HDSA),
+        * Huntington Study Group (HSG), 
+        * Nature Reviews Neurology
+        * ScienceDirect
+    
+    The information you provide should be understandable to laypersons, well-organized, and include credible sources, citations, and an empathetic tone. 
+    It should educate on the scientific aspects and personal challenges of living with Huntington's Disease.""",
+    "SYSTEM_RESPONSE": """Hello! I'm an assistant trained to provide detailed and accurate information on medical conditions, including Huntington's Disease. 
+    I'm here to help answer your questions and provide resources to help you better understand this disease and its impact on individuals and their families. 
+    If you have any questions about HD or related topics, feel free to ask!""",
+    "PRE_CONTEXT": """NOW YOU ARE SEARCHING THE WEB, AND HERE ARE THE CHUNKS RETRIEVED FROM THE WEB.""",
+    "POST_CONTEXT": """ """,  # EMPTY
+    "PRE_PROMPT": """NOW ACCORDING TO THE CONTEXT RETRIEVED FROM THE GENERATE THE CONTENT FOR THE FOLLOWING SUBJECT""",
+    "POST_PROMPT": """
+    Do not repeat yourself
+    """,
+}
+
+googleSearchClient = SearchClient(
+    "google", api_key=GOOGLE_SEARCH_API_KEY, engine_id=GOOGLE_SEARCH_ENGINE_ID
+)
+bingSearchClient = SearchClient("bing", api_key=BING_SEARCH_API_KEY, engine_id=None)
+
+st.set_page_config(
+    page_title="Mixtral Playground",
+    page_icon="📚",
+)
+
+reranker = CrossEncoder("cross-encoder/ms-marco-MiniLM-L-6-v2")
+
+
+def rerank(query, top_k, search_results):
+    chunks = []
+    for result in search_results:
+        text = result["text"]
+        # Chunk the text into segments of 512 words each
+        words = text.split()
+        chunk_size = 512
+        num_chunks = math.ceil(len(words) / chunk_size)
+        for i in range(num_chunks):
+            start = i * chunk_size
+            end = (i + 1) * chunk_size
+            chunk = " ".join(words[start:end])
+            chunks.append((result["link"], chunk))
+
+    # Create sentence combinations with the query
+    sentence_combinations = [[query, chunk[1]] for chunk in chunks]
+
+    # Compute similarity scores for these combinations
+    similarity_scores = reranker.predict(sentence_combinations)
+
+    # Sort scores in decreasing order
+    sim_scores_argsort = reversed(np.argsort(similarity_scores))
+
+    # Rearrange search_results based on the reranked scores
+    reranked_results = []
+    for idx in sim_scores_argsort:
+        link = chunks[idx][0]
+        for result in search_results:
+            if result["link"] == link:
+                reranked_results.append(result)
+                break
+
+    return reranked_results[:top_k]
+
+
+def gen_augmented_prompt_via_websearch(
+    prompt,
+    vendor,
+    n_crawl,
+    top_k,
+    pre_context,
+    post_context,
+    pre_prompt="",
+    post_prompt="",
+    pass_prev=False,
+):
+    """returns a prompt with the context of the query and the top k web search results.
+
+    Args:
+        query (_type_): _description_
+        top_k (_type_): _description_
+        preprompt (str, optional): _description_. Defaults to "".
+        postprompt (str, optional): _description_. Defaults to "".
+    """
+    search_results = []
+    if vendor == "Google":
+        search_results = googleSearchClient.search(prompt, n_crawl)
+    elif vendor == "Bing":
+        search_results = bingSearchClient.search(prompt, n_crawl)
+
+    reranked_results = rerank(prompt, top_k, search_results)
+
+    links = []
+    context = ""
+    for res in reranked_results:
+        context += res["text"] + "\n\n"
+        link = res["link"]
+        links.append(link)
+
+    print(reranked_results)
+
+    prev_input = st.session_state.history[-1][1] if pass_prev else ""
+
+    generated_prompt = f"""
+    {pre_context}
+
+    {context}
+
+    {post_context}
+    
+    {pre_prompt} 
+    
+    {prompt} \n\n
+    
+    {post_prompt}
+
+    {prev_input}
+    """
+    return generated_prompt, links
+
+
+def init_state():
+    if "messages" not in st.session_state:
+        st.session_state.messages = []
+
+    if "tokens_used" not in st.session_state:
+        st.session_state.tokens_used = 0
+
+    if "tps" not in st.session_state:
+        st.session_state.tps = 0
+
+    if "temp" not in st.session_state:
+        st.session_state.temp = 0.8
+
+    if "history" not in st.session_state:
+        st.session_state.history = [
+            [
+                INITIAL_PROMPT_ENGINEERING["SYSTEM_INSTRUCTION"],
+                INITIAL_PROMPT_ENGINEERING["SYSTEM_RESPONSE"],
+            ]
+        ]
+
+    if "n_crawl" not in st.session_state:
+        st.session_state.n_crawl = 5
+
+    if "repetion_penalty" not in st.session_state:
+        st.session_state.repetion_penalty = 1
+
+    if "rag_enabled" not in st.session_state:
+        st.session_state.rag_enabled = True
+
+    if "chat_bot" not in st.session_state:
+        st.session_state.chat_bot = "Mixtral 8x7B v0.1"
+
+    if "search_vendor" not in st.session_state:
+        st.session_state.search_vendor = "Bing"
+
+    if "system_instruction" not in st.session_state:
+        st.session_state.system_instruction = INITIAL_PROMPT_ENGINEERING[
+            "SYSTEM_INSTRUCTION"
+        ]
+
+    if "system_response" not in st.session_state:
+        st.session_state.system_instruction = INITIAL_PROMPT_ENGINEERING[
+            "SYSTEM_RESPONSE"
+        ]
+
+    if "pre_context" not in st.session_state:
+        st.session_state.pre_context = INITIAL_PROMPT_ENGINEERING["PRE_CONTEXT"]
+
+    if "post_context" not in st.session_state:
+        st.session_state.post_context = INITIAL_PROMPT_ENGINEERING["POST_CONTEXT"]
+
+    if "pre_prompt" not in st.session_state:
+        st.session_state.pre_prompt = INITIAL_PROMPT_ENGINEERING["PRE_PROMPT"]
+
+    if "post_prompt" not in st.session_state:
+        st.session_state.post_prompt = INITIAL_PROMPT_ENGINEERING["POST_PROMPT"]
+
+    if "pass_prev" not in st.session_state:
+        st.session_state.pass_prev = False
+
+
+def sidebar():
+    def retrieval_settings():
+        st.markdown("# Web Retrieval")
+        st.session_state.rag_enabled = st.toggle("Activate Web Retrieval", value=True)
+        st.session_state.search_vendor = st.radio(
+            "Select Search Vendor",
+            ["Bing", "Google"],
+            disabled=not st.session_state.rag_enabled,
+        )
+        st.session_state.n_crawl = st.slider(
+            label="Links to Crawl",
+            key=1,
+            min_value=1,
+            max_value=10,
+            value=4,
+            disabled=not st.session_state.rag_enabled,
+        )
+        st.session_state.top_k = st.slider(
+            label="Rerank Factor",
+            key=2,
+            min_value=1,
+            max_value=20,
+            value=4,
+            disabled=not st.session_state.rag_enabled,
+        )
+
+        st.markdown("---")
+
+    def model_analytics():
+        st.markdown("# Model Analytics")
+
+        st.write("Total tokens used :", st.session_state["tokens_used"])
+        st.write("Speed :", st.session_state["tps"], "  tokens/sec")
+        st.write(
+            "Total cost incurred :",
+            round(COST_PER_1000_TOKENS_INR * st.session_state["tokens_used"] / 1000, 3),
+            "INR",
+        )
+
+        st.markdown("---")
+
+    def model_settings():
+        st.markdown("# Model Settings")
+
+        st.session_state.chat_bot = st.sidebar.radio(
+            "Select one:", [key for key, _ in CHAT_BOTS.items()]
+        )
+        st.session_state.temp = st.slider(
+            label="Temperature", min_value=0.0, max_value=1.0, step=0.1, value=0.9
+        )
+
+        st.session_state.max_tokens = st.slider(
+            label="New tokens to generate",
+            min_value=64,
+            max_value=2048,
+            step=32,
+            value=512,
+        )
+
+        st.session_state.repetion_penalty = st.slider(
+            label="Repetion Penalty", min_value=0.0, max_value=1.0, step=0.1, value=1.0
+        )
+
+    with st.sidebar:
+        retrieval_settings()
+        model_analytics()
+        model_settings()
+
+        st.markdown(
+            """
+        > **Created by [Pragnesh Barik](https://barik.super.site) 🔗**
+        """
+        )
+
+
+def prompt_engineering_dashboard():
+    def engineer_prompt():
+        st.session_state.history[0] = [
+            st.session_state.system_instruction,
+            st.session_state.system_response,
+        ]
+
+    with st.expander("Prompt Engineering Dashboard"):
+        st.info(
+            "**The input to the model follows this below template**",
+        )
+        st.code(
+            """
+                    [SYSTEM INSTRUCTION]
+                    [SYSTEM RESPONSE]
+                    
+                    [... LIST OF PREV INPUTS]
+                    
+                    [PRE CONTEXT]
+                    [CONTEXT RETRIEVED FROM THE WEB]
+                    [POST CONTEXT]
+
+                    [PRE PROMPT]
+                    [PROMPT]
+                    [POST PROMPT]
+                    [PREV GENERATED INPUT] # Only if  Pass previous prompt set True  
+
+                    """
+        )
+        st.session_state.system_instruction = st.text_area(
+            label="SYSTEM INSTRUCTION",
+            value=INITIAL_PROMPT_ENGINEERING["SYSTEM_INSTRUCTION"],
+        )
+        st.session_state.system_response = st.text_area(
+            "SYSTEM RESPONSE", value=INITIAL_PROMPT_ENGINEERING["SYSTEM_RESPONSE"]
+        )
+        col1, col2 = st.columns(2)
+        with col1:
+            st.text_input(
+                "PRE CONTEXT",
+                value=INITIAL_PROMPT_ENGINEERING["PRE_CONTEXT"],
+                disabled=not st.session_state.rag_enabled,
+            )
+            st.text_input("PRE PROMPT", value=INITIAL_PROMPT_ENGINEERING["PRE_PROMPT"])
+            st.button("Engineer Prompts", on_click=engineer_prompt)
+
+        with col2:
+            st.text_input(
+                "POST CONTEXT",
+                value=INITIAL_PROMPT_ENGINEERING["POST_CONTEXT"],
+                disabled=not st.session_state.rag_enabled,
+            )
+            st.text_input(
+                "POST PROMPT", value=INITIAL_PROMPT_ENGINEERING["POST_PROMPT"]
+            )
+            pass_prev = st.toggle("Pass previous prompt")
+
+
+def header():
+    st.write("# Mixtral Playground")
+    data = {
+        "Attribute": ["LLM", "Text Vectorizer", "Vector Database", "CPU", "System RAM"],
+        "Information": [
+            "Mixtral-8x7B-Instruct-v0.1",
+            "all-distilroberta-v1",
+            "Hosted Pinecone",
+            "2 vCPU",
+            "16 GB",
+        ],
+    }
+    df = pd.DataFrame(data)
+    st.table(df)
+    prompt_engineering_dashboard()
+
+
+def chat_box():
+    for message in st.session_state.messages:
+        with st.chat_message(message["role"]):
+            st.markdown(message["content"])
+
+
+def generate_chat_stream(prompt):
+    links = []
+    if st.session_state.rag_enabled:
+        with st.spinner("Fetching relevent documents from Web...."):
+            prompt, links = gen_augmented_prompt_via_websearch(
+                prompt=prompt,
+                pre_context=st.session_state.pre_context,
+                post_context=st.session_state.post_context,
+                pre_prompt=st.session_state.pre_prompt,
+                post_prompt=st.session_state.post_prompt,
+                vendor=st.session_state.search_vendor,
+                top_k=st.session_state.top_k,
+                n_crawl=st.session_state.n_crawl,
+            )
+
+    with st.spinner("Generating response..."):
+        chat_stream = chat(
+            prompt,
+            st.session_state.history,
+            chat_client=CHAT_BOTS[st.session_state.chat_bot],
+            temperature=st.session_state.temp,
+            max_new_tokens=st.session_state.max_tokens,
+        )
+
+    return chat_stream, links
+
+
+def stream_handler(chat_stream, placeholder):
+    start_time = time.time()
+    full_response = ""
+
+    for chunk in chat_stream:
+        if chunk.token["text"] != "</s>":
+            full_response += chunk.token["text"]
+            placeholder.markdown(full_response + "▌")
+    placeholder.markdown(full_response)
+
+    end_time = time.time()
+    elapsed_time = end_time - start_time
+    total_tokens_processed = len(full_response.split())
+    tokens_per_second = total_tokens_processed // elapsed_time
+    len_response = (len(prompt.split()) + len(full_response.split())) * 1.25
+    col1, col2, col3 = st.columns(3)
+
+    with col1:
+        st.write(f"**{tokens_per_second} tokens/second**")
+
+    with col2:
+        st.write(f"**{int(len_response)} tokens generated**")
+
+    with col3:
+        st.write(
+            f"**₹ {round(len_response * COST_PER_1000_TOKENS_INR / 1000, 5)} cost incurred**"
+        )
+
+    st.session_state["tps"] = tokens_per_second
+    st.session_state["tokens_used"] = len_response + st.session_state["tokens_used"]
+
+    return full_response
+
+
+def show_source(links):
+    with st.expander("Show source"):
+        for i, link in enumerate(links):
+            st.info(f"{link}")
+
+
+init_state()
+sidebar()
+header()
+chat_box()
+
+if prompt := st.chat_input("Generate Ebook"):
+    st.chat_message("user").markdown(prompt)
+    st.session_state.messages.append({"role": "user", "content": prompt})
+
+    chat_stream, links = generate_chat_stream(prompt)
+
+    with st.chat_message("assistant"):
+        placeholder = st.empty()
+        full_response = stream_handler(chat_stream, placeholder)
+        if st.session_state.rag_enabled:
+            show_source(links)
+
+    st.session_state.history.append([prompt, full_response])
+    st.session_state.messages.append({"role": "assistant", "content": full_response})

chat_client.py

@@ -0,0 +1,50 @@
+from huggingface_hub import InferenceClient
+import os
+from dotenv import load_dotenv
+load_dotenv()
+
+API_TOKEN = os.getenv('HF_TOKEN')
+
+
+def format_prompt(message, history):
+  prompt = "<s>"
+  for user_prompt, bot_response in history:
+    prompt += f"[INST] {user_prompt} [/INST]"
+    prompt += f" {bot_response}</s> "
+  prompt += f"[INST] {message} [/INST]"
+  return prompt
+
+def chat(
+    prompt, history, chat_client = "mistralai/Mistral-7B-Instruct-v0.1",temperature=0.9, max_new_tokens=256, top_p=0.95, repetition_penalty=1.0,
+):
+    client = InferenceClient(
+       chat_client,
+       token=API_TOKEN
+    )
+    temperature = float(temperature)
+    if temperature < 1e-2:
+        temperature = 1e-2
+    top_p = float(top_p)
+
+    generate_kwargs = dict(
+        temperature=temperature,
+        max_new_tokens=max_new_tokens,
+        top_p=top_p,
+        repetition_penalty=repetition_penalty,
+        do_sample=True,
+        seed=42,
+    )
+
+    formatted_prompt = format_prompt(prompt, history)
+
+    stream = client.text_generation(formatted_prompt, **generate_kwargs, stream=True, details=True, return_full_text=False)
+    output = ""
+
+    # for response in stream:
+    #     # print(response)
+    #     output += response.token["text"]
+    #     yield output
+    # return output
+
+
+    return stream

rag/Scripts/Activate.ps1

@@ -0,0 +1,399 @@
+<#
+.Synopsis
+Activate a Python virtual environment for the current PowerShell session.
+
+.Description
+Pushes the python executable for a virtual environment to the front of the
+$Env:PATH environment variable and sets the prompt to signify that you are
+in a Python virtual environment. Makes use of the command line switches as
+well as the `pyvenv.cfg` file values present in the virtual environment.
+
+.Parameter VenvDir
+Path to the directory that contains the virtual environment to activate. The
+default value for this is the parent of the directory that the Activate.ps1
+script is located within.
+
+.Parameter Prompt
+The prompt prefix to display when this virtual environment is activated. By
+default, this prompt is the name of the virtual environment folder (VenvDir)
+surrounded by parentheses and followed by a single space (ie. '(.venv) ').
+
+.Example
+Activate.ps1
+Activates the Python virtual environment that contains the Activate.ps1 script.
+
+.Example
+Activate.ps1 -Verbose
+Activates the Python virtual environment that contains the Activate.ps1 script,
+and shows extra information about the activation as it executes.
+
+.Example
+Activate.ps1 -VenvDir C:\Users\MyUser\Common\.venv
+Activates the Python virtual environment located in the specified location.
+
+.Example
+Activate.ps1 -Prompt "MyPython"
+Activates the Python virtual environment that contains the Activate.ps1 script,
+and prefixes the current prompt with the specified string (surrounded in
+parentheses) while the virtual environment is active.
+
+.Notes
+On Windows, it may be required to enable this Activate.ps1 script by setting the
+execution policy for the user. You can do this by issuing the following PowerShell
+command:
+
+PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+
+For more information on Execution Policies: 
+https://go.microsoft.com/fwlink/?LinkID=135170
+
+#>
+Param(
+    [Parameter(Mandatory = $false)]
+    [String]
+    $VenvDir,
+    [Parameter(Mandatory = $false)]
+    [String]
+    $Prompt
+)
+
+<# Function declarations --------------------------------------------------- #>
+
+<#
+.Synopsis
+Remove all shell session elements added by the Activate script, including the
+addition of the virtual environment's Python executable from the beginning of
+the PATH variable.
+
+.Parameter NonDestructive
+If present, do not remove this function from the global namespace for the
+session.
+
+#>
+function global:deactivate ([switch]$NonDestructive) {
+    # Revert to original values
+
+    # The prior prompt:
+    if (Test-Path -Path Function:_OLD_VIRTUAL_PROMPT) {
+        Copy-Item -Path Function:_OLD_VIRTUAL_PROMPT -Destination Function:prompt
+        Remove-Item -Path Function:_OLD_VIRTUAL_PROMPT
+    }
+
+    # The prior PYTHONHOME:
+    if (Test-Path -Path Env:_OLD_VIRTUAL_PYTHONHOME) {
+        Copy-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME -Destination Env:PYTHONHOME
+        Remove-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME
+    }
+
+    # The prior PATH:
+    if (Test-Path -Path Env:_OLD_VIRTUAL_PATH) {
+        Copy-Item -Path Env:_OLD_VIRTUAL_PATH -Destination Env:PATH
+        Remove-Item -Path Env:_OLD_VIRTUAL_PATH
+    }
+
+    # Just remove the VIRTUAL_ENV altogether:
+    if (Test-Path -Path Env:VIRTUAL_ENV) {
+        Remove-Item -Path env:VIRTUAL_ENV
+    }
+
+    # Just remove the _PYTHON_VENV_PROMPT_PREFIX altogether:
+    if (Get-Variable -Name "_PYTHON_VENV_PROMPT_PREFIX" -ErrorAction SilentlyContinue) {
+        Remove-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Scope Global -Force
+    }
+
+    # Leave deactivate function in the global namespace if requested:
+    if (-not $NonDestructive) {
+        Remove-Item -Path function:deactivate
+    }
+}
+
+<#
+.Description
+Get-PyVenvConfig parses the values from the pyvenv.cfg file located in the
+given folder, and returns them in a map.
+
+For each line in the pyvenv.cfg file, if that line can be parsed into exactly
+two strings separated by `=` (with any amount of whitespace surrounding the =)
+then it is considered a `key = value` line. The left hand string is the key,
+the right hand is the value.
+
+If the value starts with a `'` or a `"` then the first and last character is
+stripped from the value before being captured.
+
+.Parameter ConfigDir
+Path to the directory that contains the `pyvenv.cfg` file.
+#>
+function Get-PyVenvConfig(
+    [String]
+    $ConfigDir
+) {
+    Write-Verbose "Given ConfigDir=$ConfigDir, obtain values in pyvenv.cfg"
+
+    # Ensure the file exists, and issue a warning if it doesn't (but still allow the function to continue).
+    $pyvenvConfigPath = Join-Path -Resolve -Path $ConfigDir -ChildPath 'pyvenv.cfg' -ErrorAction Continue
+
+    # An empty map will be returned if no config file is found.
+    $pyvenvConfig = @{ }
+
+    if ($pyvenvConfigPath) {
+
+        Write-Verbose "File exists, parse `key = value` lines"
+        $pyvenvConfigContent = Get-Content -Path $pyvenvConfigPath
+
+        $pyvenvConfigContent | ForEach-Object {
+            $keyval = $PSItem -split "\s*=\s*", 2
+            if ($keyval[0] -and $keyval[1]) {
+                $val = $keyval[1]
+
+                # Remove extraneous quotations around a string value.
+                if ("'""".Contains($val.Substring(0, 1))) {
+                    $val = $val.Substring(1, $val.Length - 2)
+                }
+
+                $pyvenvConfig[$keyval[0]] = $val
+                Write-Verbose "Adding Key: '$($keyval[0])'='$val'"
+            }
+        }
+    }
+    return $pyvenvConfig
+}
+
+
+<# Begin Activate script --------------------------------------------------- #>
+
+# Determine the containing directory of this script
+$VenvExecPath = Split-Path -Parent $MyInvocation.MyCommand.Definition
+$VenvExecDir = Get-Item -Path $VenvExecPath
+
+Write-Verbose "Activation script is located in path: '$VenvExecPath'"
+Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)"
+Write-Verbose "VenvExecDir Name: '$($VenvExecDir.Name)"
+
+# Set values required in priority: CmdLine, ConfigFile, Default
+# First, get the location of the virtual environment, it might not be
+# VenvExecDir if specified on the command line.
+if ($VenvDir) {
+    Write-Verbose "VenvDir given as parameter, using '$VenvDir' to determine values"
+}
+else {
+    Write-Verbose "VenvDir not given as a parameter, using parent directory name as VenvDir."
+    $VenvDir = $VenvExecDir.Parent.FullName.TrimEnd("\\/")
+    Write-Verbose "VenvDir=$VenvDir"
+}
+
+# Next, read the `pyvenv.cfg` file to determine any required value such
+# as `prompt`.
+$pyvenvCfg = Get-PyVenvConfig -ConfigDir $VenvDir
+
+# Next, set the prompt from the command line, or the config file, or
+# just use the name of the virtual environment folder.
+if ($Prompt) {
+    Write-Verbose "Prompt specified as argument, using '$Prompt'"
+}
+else {
+    Write-Verbose "Prompt not specified as argument to script, checking pyvenv.cfg value"
+    if ($pyvenvCfg -and $pyvenvCfg['prompt']) {
+        Write-Verbose "  Setting based on value in pyvenv.cfg='$($pyvenvCfg['prompt'])'"
+        $Prompt = $pyvenvCfg['prompt'];
+    }
+    else {
+        Write-Verbose "  Setting prompt based on parent's directory's name. (Is the directory name passed to venv module when creating the virtual environment)"
+        Write-Verbose "  Got leaf-name of $VenvDir='$(Split-Path -Path $venvDir -Leaf)'"
+        $Prompt = Split-Path -Path $venvDir -Leaf
+    }
+}
+
+Write-Verbose "Prompt = '$Prompt'"
+Write-Verbose "VenvDir='$VenvDir'"
+
+# Deactivate any currently active virtual environment, but leave the
+# deactivate function in place.
+deactivate -nondestructive
+
+# Now set the environment variable VIRTUAL_ENV, used by many tools to determine
+# that there is an activated venv.
+$env:VIRTUAL_ENV = $VenvDir
+
+if (-not $Env:VIRTUAL_ENV_DISABLE_PROMPT) {
+
+    Write-Verbose "Setting prompt to '$Prompt'"
+
+    # Set the prompt to include the env name
+    # Make sure _OLD_VIRTUAL_PROMPT is global
+    function global:_OLD_VIRTUAL_PROMPT { "" }
+    Copy-Item -Path function:prompt -Destination function:_OLD_VIRTUAL_PROMPT
+    New-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Description "Python virtual environment prompt prefix" -Scope Global -Option ReadOnly -Visibility Public -Value $Prompt
+
+    function global:prompt {
+        Write-Host -NoNewline -ForegroundColor Green "($_PYTHON_VENV_PROMPT_PREFIX) "
+        _OLD_VIRTUAL_PROMPT
+    }
+}
+
+# Clear PYTHONHOME
+if (Test-Path -Path Env:PYTHONHOME) {
+    Copy-Item -Path Env:PYTHONHOME -Destination Env:_OLD_VIRTUAL_PYTHONHOME
+    Remove-Item -Path Env:PYTHONHOME
+}
+
+# Add the venv to the PATH
+Copy-Item -Path Env:PATH -Destination Env:_OLD_VIRTUAL_PATH
+$Env:PATH = "$VenvExecDir$([System.IO.Path]::PathSeparator)$Env:PATH"
+
+# SIG # Begin signature block
+# MIIc9wYJKoZIhvcNAQcCoIIc6DCCHOQCAQExDzANBglghkgBZQMEAgEFADB5Bgor
+# BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG
+# KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCD50itNqbOCCDp6
+# 9ZnhKce5X7vV6KL67iKMbGTUZ4nf36CCC38wggUwMIIEGKADAgECAhAECRgbX9W7
+# ZnVTQ7VvlVAIMA0GCSqGSIb3DQEBCwUAMGUxCzAJBgNVBAYTAlVTMRUwEwYDVQQK
+# EwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xJDAiBgNV
+# BAMTG0RpZ2lDZXJ0IEFzc3VyZWQgSUQgUm9vdCBDQTAeFw0xMzEwMjIxMjAwMDBa
+# Fw0yODEwMjIxMjAwMDBaMHIxCzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2Vy
+# dCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xMTAvBgNVBAMTKERpZ2lD
+# ZXJ0IFNIQTIgQXNzdXJlZCBJRCBDb2RlIFNpZ25pbmcgQ0EwggEiMA0GCSqGSIb3
+# DQEBAQUAA4IBDwAwggEKAoIBAQD407Mcfw4Rr2d3B9MLMUkZz9D7RZmxOttE9X/l
+# qJ3bMtdx6nadBS63j/qSQ8Cl+YnUNxnXtqrwnIal2CWsDnkoOn7p0WfTxvspJ8fT
+# eyOU5JEjlpB3gvmhhCNmElQzUHSxKCa7JGnCwlLyFGeKiUXULaGj6YgsIJWuHEqH
+# CN8M9eJNYBi+qsSyrnAxZjNxPqxwoqvOf+l8y5Kh5TsxHM/q8grkV7tKtel05iv+
+# bMt+dDk2DZDv5LVOpKnqagqrhPOsZ061xPeM0SAlI+sIZD5SlsHyDxL0xY4PwaLo
+# LFH3c7y9hbFig3NBggfkOItqcyDQD2RzPJ6fpjOp/RnfJZPRAgMBAAGjggHNMIIB
+# yTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBhjATBgNVHSUEDDAK
+# BggrBgEFBQcDAzB5BggrBgEFBQcBAQRtMGswJAYIKwYBBQUHMAGGGGh0dHA6Ly9v
+# Y3NwLmRpZ2ljZXJ0LmNvbTBDBggrBgEFBQcwAoY3aHR0cDovL2NhY2VydHMuZGln
+# aWNlcnQuY29tL0RpZ2lDZXJ0QXNzdXJlZElEUm9vdENBLmNydDCBgQYDVR0fBHow
+# eDA6oDigNoY0aHR0cDovL2NybDQuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0QXNzdXJl
+# ZElEUm9vdENBLmNybDA6oDigNoY0aHR0cDovL2NybDMuZGlnaWNlcnQuY29tL0Rp
+# Z2lDZXJ0QXNzdXJlZElEUm9vdENBLmNybDBPBgNVHSAESDBGMDgGCmCGSAGG/WwA
+# AgQwKjAoBggrBgEFBQcCARYcaHR0cHM6Ly93d3cuZGlnaWNlcnQuY29tL0NQUzAK
+# BghghkgBhv1sAzAdBgNVHQ4EFgQUWsS5eyoKo6XqcQPAYPkt9mV1DlgwHwYDVR0j
+# BBgwFoAUReuir/SSy4IxLVGLp6chnfNtyA8wDQYJKoZIhvcNAQELBQADggEBAD7s
+# DVoks/Mi0RXILHwlKXaoHV0cLToaxO8wYdd+C2D9wz0PxK+L/e8q3yBVN7Dh9tGS
+# dQ9RtG6ljlriXiSBThCk7j9xjmMOE0ut119EefM2FAaK95xGTlz/kLEbBw6RFfu6
+# r7VRwo0kriTGxycqoSkoGjpxKAI8LpGjwCUR4pwUR6F6aGivm6dcIFzZcbEMj7uo
+# +MUSaJ/PQMtARKUT8OZkDCUIQjKyNookAv4vcn4c10lFluhZHen6dGRrsutmQ9qz
+# sIzV6Q3d9gEgzpkxYz0IGhizgZtPxpMQBvwHgfqL2vmCSfdibqFT+hKUGIUukpHq
+# aGxEMrJmoecYpJpkUe8wggZHMIIFL6ADAgECAhADPtXtoGXRuMkd/PkqbJvYMA0G
+# CSqGSIb3DQEBCwUAMHIxCzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJ
+# bmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xMTAvBgNVBAMTKERpZ2lDZXJ0
+# IFNIQTIgQXNzdXJlZCBJRCBDb2RlIFNpZ25pbmcgQ0EwHhcNMTgxMjE4MDAwMDAw
+# WhcNMjExMjIyMTIwMDAwWjCBgzELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDU5ldyBI
+# YW1wc2hpcmUxEjAQBgNVBAcTCVdvbGZlYm9ybzEjMCEGA1UEChMaUHl0aG9uIFNv
+# ZnR3YXJlIEZvdW5kYXRpb24xIzAhBgNVBAMTGlB5dGhvbiBTb2Z0d2FyZSBGb3Vu
+# ZGF0aW9uMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAqr2kS7J1uW7o
+# JRxlsdrETAjKarfoH5TI8PWST6Yb2xPooP7vHT4iaVXyL5Lze1f53Jw67Sp+u524
+# fJXf30qHViEWxumy2RWG0nciU2d+mMqzjlaAWSZNF0u4RcvyDJokEV0RUOqI5CG5
+# zPI3W9uQ6LiUk3HCYW6kpH177A5T3pw/Po8O8KErJGn1anaqtIICq99ySxrMad/2
+# hPMBRf6Ndah7f7HPn1gkSSTAoejyuqF5h+B0qI4+JK5+VLvz659VTbAWJsYakkxZ
+# xVWYpFv4KeQSSwoo0DzMvmERsTzNvVBMWhu9OriJNg+QfFmf96zVTu93cZ+r7xMp
+# bXyfIOGKhHMaRuZ8ihuWIx3gI9WHDFX6fBKR8+HlhdkaiBEWIsXRoy+EQUyK7zUs
+# +FqOo2sRYttbs8MTF9YDKFZwyPjn9Wn+gLGd5NUEVyNvD9QVGBEtN7vx87bduJUB
+# 8F4DylEsMtZTfjw/au6AmOnmneK5UcqSJuwRyZaGNk7y3qj06utx+HTTqHgi975U
+# pxfyrwAqkovoZEWBVSpvku8PVhkBXcLmNe6MEHlFiaMoiADAeKmX5RFRkN+VrmYG
+# Tg4zajxfdHeIY8TvLf48tTfmnQJd98geJQv/01NUy/FxuwqAuTkaez5Nl1LxP0Cp
+# THhghzO4FRD4itT2wqTh4jpojw9QZnsCAwEAAaOCAcUwggHBMB8GA1UdIwQYMBaA
+# FFrEuXsqCqOl6nEDwGD5LfZldQ5YMB0GA1UdDgQWBBT8Kr9+1L6s84KcpM97IgE7
+# uI8H8jAOBgNVHQ8BAf8EBAMCB4AwEwYDVR0lBAwwCgYIKwYBBQUHAwMwdwYDVR0f
+# BHAwbjA1oDOgMYYvaHR0cDovL2NybDMuZGlnaWNlcnQuY29tL3NoYTItYXNzdXJl
+# ZC1jcy1nMS5jcmwwNaAzoDGGL2h0dHA6Ly9jcmw0LmRpZ2ljZXJ0LmNvbS9zaGEy
+# LWFzc3VyZWQtY3MtZzEuY3JsMEwGA1UdIARFMEMwNwYJYIZIAYb9bAMBMCowKAYI
+# KwYBBQUHAgEWHGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwCAYGZ4EMAQQB
+# MIGEBggrBgEFBQcBAQR4MHYwJAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmRpZ2lj
+# ZXJ0LmNvbTBOBggrBgEFBQcwAoZCaHR0cDovL2NhY2VydHMuZGlnaWNlcnQuY29t
+# L0RpZ2lDZXJ0U0hBMkFzc3VyZWRJRENvZGVTaWduaW5nQ0EuY3J0MAwGA1UdEwEB
+# /wQCMAAwDQYJKoZIhvcNAQELBQADggEBAEt1oS21X0axiafPjyY+vlYqjWKuUu/Y
+# FuYWIEq6iRRaFabNDhj9RBFQF/aJiE5msrQEOfAD6/6gVSH91lZWBqg6NEeG9T9S
+# XbiAPvJ9CEWFsdkXUrjbWhvCnuZ7kqUuU5BAumI1QRbpYgZL3UA+iZXkmjbGh1ln
+# 8rUhWIxbBYL4Sg2nqpB44p7CUFYkPj/MbwU2gvBV2pXjj5WaskoZtsACMv5g42BN
+# oVLoRAi+ev6s07POt+JtHRIm87lTyuc8wh0swTPUwksKbLU1Zdj9CpqtzXnuVE0w
+# 50exJvRSK3Vt4g+0vigpI3qPmDdpkf9+4Mvy0XMNcqrthw20R+PkIlMxghDOMIIQ
+# ygIBATCBhjByMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkw
+# FwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMTEwLwYDVQQDEyhEaWdpQ2VydCBTSEEy
+# IEFzc3VyZWQgSUQgQ29kZSBTaWduaW5nIENBAhADPtXtoGXRuMkd/PkqbJvYMA0G
+# CWCGSAFlAwQCAQUAoIGYMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisG
+# AQQBgjcCAQsxDjAMBgorBgEEAYI3AgEVMCwGCisGAQQBgjcCAQwxHjAcoBqAGABQ
+# AHkAdABoAG8AbgAgADMALgA5AC4AODAvBgkqhkiG9w0BCQQxIgQgVkkzBKWOaE6h
+# LZ4RPK1x031KWOzGTBHw2wSm0tSdHC0wDQYJKoZIhvcNAQEBBQAEggIAhvnfzv5s
+# LAI424IYB5BiplTY8igc/dXW0L9VargC6yOC4Pyzyz7MNX0iaLUfv0y3nD25u9MG
+# dGPeOmTfSYnPeu9H/ovvhSwj6LjV9DX1TgsfDPfQ3zs3ak51UkJGgRFj2FKbWnHc
+# 8zuXT7C7M9v4XrjWArswdP/+8SvOymWjYHRFM6rwcet5px6n+bYFU1dUwFV2hNFQ
+# 23wDFhTSATWyPGfn81q73EWrBe3cRpWgS7mfmlSt6sCHxVo5xQX2jjlYA1ttL8tu
+# rBZ+socFWyn82fg0nXDg/5lSapUPKSSaGu6vm8lIlpB4Z449brshSTZ2H4W+LrXu
+# ZSR02O/Yd+i/r+KxedyBipw35YAOGedq6ODfis/ixCMqAyo7xjX/Z+rIWHm7Yf0n
+# FQyya8qwjAkrx6pF1NNisXNk/Ue1Fg8d5/o0a2b2u2T6+A+/cBBqnHXqfExlPoqM
+# 0uIEgWJP9wKAYBbjwdC2lTFbxjnTs2iyv+99BQzU9ecWy+Tzu/woJmiQoSjzdWGc
+# I9mzlyqGEvQB6/Udy+K43Ykgr3noQX6SYH6Yfp0acdwitigbnosfykrkmkfdROeK
+# a6/+RMQqOz4KM5h277Qabadqu9yNPv6hk73pn62QpPaRGn+SRIl7ppTjRz1yOU8f
+# 9Y5obr2wfgVizaUnHquRKeuYbWC+mq/65xahgg19MIINeQYKKwYBBAGCNwMDATGC
+# DWkwgg1lBgkqhkiG9w0BBwKggg1WMIINUgIBAzEPMA0GCWCGSAFlAwQCAQUAMHcG
+# CyqGSIb3DQEJEAEEoGgEZjBkAgEBBglghkgBhv1sBwEwMTANBglghkgBZQMEAgEF
+# AAQgsX+p1he5Y83BxbjDF3wcPgaRPcA/hdudlnmnIp4fj8cCECGQNygHZHlOLsxq
+# r1Ok1q0YDzIwMjExMTA1MjA1NjE0WqCCCjcwggT+MIID5qADAgECAhANQkrgvjqI
+# /2BAIc4UAPDdMA0GCSqGSIb3DQEBCwUAMHIxCzAJBgNVBAYTAlVTMRUwEwYDVQQK
+# EwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xMTAvBgNV
+# BAMTKERpZ2lDZXJ0IFNIQTIgQXNzdXJlZCBJRCBUaW1lc3RhbXBpbmcgQ0EwHhcN
+# MjEwMTAxMDAwMDAwWhcNMzEwMTA2MDAwMDAwWjBIMQswCQYDVQQGEwJVUzEXMBUG
+# A1UEChMORGlnaUNlcnQsIEluYy4xIDAeBgNVBAMTF0RpZ2lDZXJ0IFRpbWVzdGFt
+# cCAyMDIxMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwuZhhGfFivUN
+# CKRFymNrUdc6EUK9CnV1TZS0DFC1JhD+HchvkWsMlucaXEjvROW/m2HNFZFiWrj/
+# ZwucY/02aoH6KfjdK3CF3gIY83htvH35x20JPb5qdofpir34hF0edsnkxnZ2OlPR
+# 0dNaNo/Go+EvGzq3YdZz7E5tM4p8XUUtS7FQ5kE6N1aG3JMjjfdQJehk5t3Tjy9X
+# tYcg6w6OLNUj2vRNeEbjA4MxKUpcDDGKSoyIxfcwWvkUrxVfbENJCf0mI1P2jWPo
+# GqtbsR0wwptpgrTb/FZUvB+hh6u+elsKIC9LCcmVp42y+tZji06lchzun3oBc/gZ
+# 1v4NSYS9AQIDAQABo4IBuDCCAbQwDgYDVR0PAQH/BAQDAgeAMAwGA1UdEwEB/wQC
+# MAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQQYDVR0gBDowODA2BglghkgBhv1s
+# BwEwKTAnBggrBgEFBQcCARYbaHR0cDovL3d3dy5kaWdpY2VydC5jb20vQ1BTMB8G
+# A1UdIwQYMBaAFPS24SAd/imu0uRhpbKiJbLIFzVuMB0GA1UdDgQWBBQ2RIaOpLqw
+# Zr68KC0dRDbd42p6vDBxBgNVHR8EajBoMDKgMKAuhixodHRwOi8vY3JsMy5kaWdp
+# Y2VydC5jb20vc2hhMi1hc3N1cmVkLXRzLmNybDAyoDCgLoYsaHR0cDovL2NybDQu
+# ZGlnaWNlcnQuY29tL3NoYTItYXNzdXJlZC10cy5jcmwwgYUGCCsGAQUFBwEBBHkw
+# dzAkBggrBgEFBQcwAYYYaHR0cDovL29jc3AuZGlnaWNlcnQuY29tME8GCCsGAQUF
+# BzAChkNodHRwOi8vY2FjZXJ0cy5kaWdpY2VydC5jb20vRGlnaUNlcnRTSEEyQXNz
+# dXJlZElEVGltZXN0YW1waW5nQ0EuY3J0MA0GCSqGSIb3DQEBCwUAA4IBAQBIHNy1
+# 6ZojvOca5yAOjmdG/UJyUXQKI0ejq5LSJcRwWb4UoOUngaVNFBUZB3nw0QTDhtk7
+# vf5EAmZN7WmkD/a4cM9i6PVRSnh5Nnont/PnUp+Tp+1DnnvntN1BIon7h6JGA078
+# 9P63ZHdjXyNSaYOC+hpT7ZDMjaEXcw3082U5cEvznNZ6e9oMvD0y0BvL9WH8dQgA
+# dryBDvjA4VzPxBFy5xtkSdgimnUVQvUtMjiB2vRgorq0Uvtc4GEkJU+y38kpqHND
+# Udq9Y9YfW5v3LhtPEx33Sg1xfpe39D+E68Hjo0mh+s6nv1bPull2YYlffqe0jmd4
+# +TaY4cso2luHpoovMIIFMTCCBBmgAwIBAgIQCqEl1tYyG35B5AXaNpfCFTANBgkq
+# hkiG9w0BAQsFADBlMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5j
+# MRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMSQwIgYDVQQDExtEaWdpQ2VydCBB
+# c3N1cmVkIElEIFJvb3QgQ0EwHhcNMTYwMTA3MTIwMDAwWhcNMzEwMTA3MTIwMDAw
+# WjByMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQL
+# ExB3d3cuZGlnaWNlcnQuY29tMTEwLwYDVQQDEyhEaWdpQ2VydCBTSEEyIEFzc3Vy
+# ZWQgSUQgVGltZXN0YW1waW5nIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
+# CgKCAQEAvdAy7kvNj3/dqbqCmcU5VChXtiNKxA4HRTNREH3Q+X1NaH7ntqD0jbOI
+# 5Je/YyGQmL8TvFfTw+F+CNZqFAA49y4eO+7MpvYyWf5fZT/gm+vjRkcGGlV+Cyd+
+# wKL1oODeIj8O/36V+/OjuiI+GKwR5PCZA207hXwJ0+5dyJoLVOOoCXFr4M8iEA91
+# z3FyTgqt30A6XLdR4aF5FMZNJCMwXbzsPGBqrC8HzP3w6kfZiFBe/WZuVmEnKYmE
+# UeaC50ZQ/ZQqLKfkdT66mA+Ef58xFNat1fJky3seBdCEGXIX8RcG7z3N1k3vBkL9
+# olMqT4UdxB08r8/arBD13ays6Vb/kwIDAQABo4IBzjCCAcowHQYDVR0OBBYEFPS2
+# 4SAd/imu0uRhpbKiJbLIFzVuMB8GA1UdIwQYMBaAFEXroq/0ksuCMS1Ri6enIZ3z
+# bcgPMBIGA1UdEwEB/wQIMAYBAf8CAQAwDgYDVR0PAQH/BAQDAgGGMBMGA1UdJQQM
+# MAoGCCsGAQUFBwMIMHkGCCsGAQUFBwEBBG0wazAkBggrBgEFBQcwAYYYaHR0cDov
+# L29jc3AuZGlnaWNlcnQuY29tMEMGCCsGAQUFBzAChjdodHRwOi8vY2FjZXJ0cy5k
+# aWdpY2VydC5jb20vRGlnaUNlcnRBc3N1cmVkSURSb290Q0EuY3J0MIGBBgNVHR8E
+# ejB4MDqgOKA2hjRodHRwOi8vY3JsNC5kaWdpY2VydC5jb20vRGlnaUNlcnRBc3N1
+# cmVkSURSb290Q0EuY3JsMDqgOKA2hjRodHRwOi8vY3JsMy5kaWdpY2VydC5jb20v
+# RGlnaUNlcnRBc3N1cmVkSURSb290Q0EuY3JsMFAGA1UdIARJMEcwOAYKYIZIAYb9
+# bAACBDAqMCgGCCsGAQUFBwIBFhxodHRwczovL3d3dy5kaWdpY2VydC5jb20vQ1BT
+# MAsGCWCGSAGG/WwHATANBgkqhkiG9w0BAQsFAAOCAQEAcZUS6VGHVmnN793afKpj
+# erN4zwY3QITvS4S/ys8DAv3Fp8MOIEIsr3fzKx8MIVoqtwU0HWqumfgnoma/Capg
+# 33akOpMP+LLR2HwZYuhegiUexLoceywh4tZbLBQ1QwRostt1AuByx5jWPGTlH0gQ
+# GF+JOGFNYkYkh2OMkVIsrymJ5Xgf1gsUpYDXEkdws3XVk4WTfraSZ/tTYYmo9WuW
+# wPRYaQ18yAGxuSh1t5ljhSKMYcp5lH5Z/IwP42+1ASa2bKXuh1Eh5Fhgm7oMLStt
+# osR+u8QlK0cCCHxJrhO24XxCQijGGFbPQTS2Zl22dHv1VjMiLyI2skuiSpXY9aaO
+# UjGCAoYwggKCAgEBMIGGMHIxCzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2Vy
+# dCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xMTAvBgNVBAMTKERpZ2lD
+# ZXJ0IFNIQTIgQXNzdXJlZCBJRCBUaW1lc3RhbXBpbmcgQ0ECEA1CSuC+Ooj/YEAh
+# zhQA8N0wDQYJYIZIAWUDBAIBBQCggdEwGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJ
+# EAEEMBwGCSqGSIb3DQEJBTEPFw0yMTExMDUyMDU2MTRaMCsGCyqGSIb3DQEJEAIM
+# MRwwGjAYMBYEFOHXgqjhkb7va8oWkbWqtJSmJJvzMC8GCSqGSIb3DQEJBDEiBCAu
+# 6d27aot4QF9oB1Fuus/15RcSvYtxIrhRP5CibpngLTA3BgsqhkiG9w0BCRACLzEo
+# MCYwJDAiBCCzEJAGvArZgweRVyngRANBXIPjKSthTyaWTI01cez1qTANBgkqhkiG
+# 9w0BAQEFAASCAQBEh1HtS0zGaZu71b+EG3d1DpAcoZu4CId3yMekv4ozrPE2qb5P
+# Okr27XOG32KmZBvFxlo6j5lQUZON7IPoKywYw5iXtnG3TbJ6YB7lCjRsHEX0o644
+# QlmuuI4xS3D03PPC+/QgdN2s1KJpkmlJA6mj06KTgXNSSFJUneqEzwkmm5dQxGJ+
+# tfvqo6VKunhceh9guIQJxWqId3tvy4WzSisxSTvT8SyGWeIPfl9aQp+zu0PjAo1H
+# juSRLYoeqK3HsbI8mcpW1/RzkeGoIUy5XyTn4wRLZp1jhiybkWpq/RFKJxuuhb+y
+# 1cwg8ahAw9gcx5ckatOrCn0Iv/zEoNq8wppx
+# SIG # End signature block

rag/Scripts/activate

@@ -0,0 +1,66 @@
+# This file must be used with "source bin/activate" *from bash*
+# you cannot run it directly
+
+deactivate () {
+    # reset old environment variables
+    if [ -n "${_OLD_VIRTUAL_PATH:-}" ] ; then
+        PATH="${_OLD_VIRTUAL_PATH:-}"
+        export PATH
+        unset _OLD_VIRTUAL_PATH
+    fi
+    if [ -n "${_OLD_VIRTUAL_PYTHONHOME:-}" ] ; then
+        PYTHONHOME="${_OLD_VIRTUAL_PYTHONHOME:-}"
+        export PYTHONHOME
+        unset _OLD_VIRTUAL_PYTHONHOME
+    fi
+
+    # This should detect bash and zsh, which have a hash command that must
+    # be called to get it to forget past commands.  Without forgetting
+    # past commands the $PATH changes we made may not be respected
+    if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then
+        hash -r 2> /dev/null
+    fi
+
+    if [ -n "${_OLD_VIRTUAL_PS1:-}" ] ; then
+        PS1="${_OLD_VIRTUAL_PS1:-}"
+        export PS1
+        unset _OLD_VIRTUAL_PS1
+    fi
+
+    unset VIRTUAL_ENV
+    if [ ! "${1:-}" = "nondestructive" ] ; then
+    # Self destruct!
+        unset -f deactivate
+    fi
+}
+
+# unset irrelevant variables
+deactivate nondestructive
+
+VIRTUAL_ENV="E:\Projects\ebook-gen\ebook-gen\rag"
+export VIRTUAL_ENV
+
+_OLD_VIRTUAL_PATH="$PATH"
+PATH="$VIRTUAL_ENV/Scripts:$PATH"
+export PATH
+
+# unset PYTHONHOME if set
+# this will fail if PYTHONHOME is set to the empty string (which is bad anyway)
+# could use `if (set -u; : $PYTHONHOME) ;` in bash
+if [ -n "${PYTHONHOME:-}" ] ; then
+    _OLD_VIRTUAL_PYTHONHOME="${PYTHONHOME:-}"
+    unset PYTHONHOME
+fi
+
+if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT:-}" ] ; then
+    _OLD_VIRTUAL_PS1="${PS1:-}"
+    PS1="(rag) ${PS1:-}"
+    export PS1
+fi
+
+# This should detect bash and zsh, which have a hash command that must
+# be called to get it to forget past commands.  Without forgetting
+# past commands the $PATH changes we made may not be respected
+if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then
+    hash -r 2> /dev/null
+fi

rag/Scripts/activate.bat

@@ -0,0 +1,33 @@
+@echo off
+
+rem This file is UTF-8 encoded, so we need to update the current code page while executing it
+for /f "tokens=2 delims=:." %%a in ('"%SystemRoot%\System32\chcp.com"') do (
+    set _OLD_CODEPAGE=%%a
+)
+if defined _OLD_CODEPAGE (
+    "%SystemRoot%\System32\chcp.com" 65001 > nul
+)
+
+set VIRTUAL_ENV=E:\Projects\ebook-gen\ebook-gen\rag
+
+if not defined PROMPT set PROMPT=$P$G
+
+if defined _OLD_VIRTUAL_PROMPT set PROMPT=%_OLD_VIRTUAL_PROMPT%
+if defined _OLD_VIRTUAL_PYTHONHOME set PYTHONHOME=%_OLD_VIRTUAL_PYTHONHOME%
+
+set _OLD_VIRTUAL_PROMPT=%PROMPT%
+set PROMPT=(rag) %PROMPT%
+
+if defined PYTHONHOME set _OLD_VIRTUAL_PYTHONHOME=%PYTHONHOME%
+set PYTHONHOME=
+
+if defined _OLD_VIRTUAL_PATH set PATH=%_OLD_VIRTUAL_PATH%
+if not defined _OLD_VIRTUAL_PATH set _OLD_VIRTUAL_PATH=%PATH%
+
+set PATH=%VIRTUAL_ENV%\Scripts;%PATH%
+
+:END
+if defined _OLD_CODEPAGE (
+    "%SystemRoot%\System32\chcp.com" %_OLD_CODEPAGE% > nul
+    set _OLD_CODEPAGE=
+)

rag/Scripts/deactivate.bat

@@ -0,0 +1,21 @@
+@echo off
+
+if defined _OLD_VIRTUAL_PROMPT (
+    set "PROMPT=%_OLD_VIRTUAL_PROMPT%"
+)
+set _OLD_VIRTUAL_PROMPT=
+
+if defined _OLD_VIRTUAL_PYTHONHOME (
+    set "PYTHONHOME=%_OLD_VIRTUAL_PYTHONHOME%"
+    set _OLD_VIRTUAL_PYTHONHOME=
+)
+
+if defined _OLD_VIRTUAL_PATH (
+    set "PATH=%_OLD_VIRTUAL_PATH%"
+)
+
+set _OLD_VIRTUAL_PATH=
+
+set VIRTUAL_ENV=
+
+:END

rag/Scripts/pywin32_postinstall.py

@@ -0,0 +1,783 @@
+# postinstall script for pywin32
+#
+# copies PyWinTypesxx.dll and PythonCOMxx.dll into the system directory,
+# and creates a pth file
+import glob
+import os
+import shutil
+import sys
+import sysconfig
+
+try:
+    import winreg as winreg
+except:
+    import winreg
+
+# Send output somewhere so it can be found if necessary...
+import tempfile
+
+tee_f = open(os.path.join(tempfile.gettempdir(), "pywin32_postinstall.log"), "w")
+
+
+class Tee:
+    def __init__(self, file):
+        self.f = file
+
+    def write(self, what):
+        if self.f is not None:
+            try:
+                self.f.write(what.replace("\n", "\r\n"))
+            except IOError:
+                pass
+        tee_f.write(what)
+
+    def flush(self):
+        if self.f is not None:
+            try:
+                self.f.flush()
+            except IOError:
+                pass
+        tee_f.flush()
+
+
+# For some unknown reason, when running under bdist_wininst we will start up
+# with sys.stdout as None but stderr is hooked up. This work-around allows
+# bdist_wininst to see the output we write and display it at the end of
+# the install.
+if sys.stdout is None:
+    sys.stdout = sys.stderr
+
+sys.stderr = Tee(sys.stderr)
+sys.stdout = Tee(sys.stdout)
+
+com_modules = [
+    # module_name,                      class_names
+    ("win32com.servers.interp", "Interpreter"),
+    ("win32com.servers.dictionary", "DictionaryPolicy"),
+    ("win32com.axscript.client.pyscript", "PyScript"),
+]
+
+# Is this a 'silent' install - ie, avoid all dialogs.
+# Different than 'verbose'
+silent = 0
+
+# Verbosity of output messages.
+verbose = 1
+
+root_key_name = "Software\\Python\\PythonCore\\" + sys.winver
+
+try:
+    # When this script is run from inside the bdist_wininst installer,
+    # file_created() and directory_created() are additional builtin
+    # functions which write lines to Python23\pywin32-install.log. This is
+    # a list of actions for the uninstaller, the format is inspired by what
+    # the Wise installer also creates.
+    file_created
+    is_bdist_wininst = True
+except NameError:
+    is_bdist_wininst = False  # we know what it is not - but not what it is :)
+
+    def file_created(file):
+        pass
+
+    def directory_created(directory):
+        pass
+
+    def get_root_hkey():
+        try:
+            winreg.OpenKey(
+                winreg.HKEY_LOCAL_MACHINE, root_key_name, 0, winreg.KEY_CREATE_SUB_KEY
+            )
+            return winreg.HKEY_LOCAL_MACHINE
+        except OSError:
+            # Either not exist, or no permissions to create subkey means
+            # must be HKCU
+            return winreg.HKEY_CURRENT_USER
+
+
+try:
+    create_shortcut
+except NameError:
+    # Create a function with the same signature as create_shortcut provided
+    # by bdist_wininst
+    def create_shortcut(
+        path, description, filename, arguments="", workdir="", iconpath="", iconindex=0
+    ):
+        import pythoncom
+        from win32com.shell import shell
+
+        ilink = pythoncom.CoCreateInstance(
+            shell.CLSID_ShellLink,
+            None,
+            pythoncom.CLSCTX_INPROC_SERVER,
+            shell.IID_IShellLink,
+        )
+        ilink.SetPath(path)
+        ilink.SetDescription(description)
+        if arguments:
+            ilink.SetArguments(arguments)
+        if workdir:
+            ilink.SetWorkingDirectory(workdir)
+        if iconpath or iconindex:
+            ilink.SetIconLocation(iconpath, iconindex)
+        # now save it.
+        ipf = ilink.QueryInterface(pythoncom.IID_IPersistFile)
+        ipf.Save(filename, 0)
+
+    # Support the same list of "path names" as bdist_wininst.
+    def get_special_folder_path(path_name):
+        from win32com.shell import shell, shellcon
+
+        for maybe in """
+            CSIDL_COMMON_STARTMENU CSIDL_STARTMENU CSIDL_COMMON_APPDATA
+            CSIDL_LOCAL_APPDATA CSIDL_APPDATA CSIDL_COMMON_DESKTOPDIRECTORY
+            CSIDL_DESKTOPDIRECTORY CSIDL_COMMON_STARTUP CSIDL_STARTUP
+            CSIDL_COMMON_PROGRAMS CSIDL_PROGRAMS CSIDL_PROGRAM_FILES_COMMON
+            CSIDL_PROGRAM_FILES CSIDL_FONTS""".split():
+            if maybe == path_name:
+                csidl = getattr(shellcon, maybe)
+                return shell.SHGetSpecialFolderPath(0, csidl, False)
+        raise ValueError("%s is an unknown path ID" % (path_name,))
+
+
+def CopyTo(desc, src, dest):
+    import win32api
+    import win32con
+
+    while 1:
+        try:
+            win32api.CopyFile(src, dest, 0)
+            return
+        except win32api.error as details:
+            if details.winerror == 5:  # access denied - user not admin.
+                raise
+            if silent:
+                # Running silent mode - just re-raise the error.
+                raise
+            full_desc = (
+                "Error %s\n\n"
+                "If you have any Python applications running, "
+                "please close them now\nand select 'Retry'\n\n%s"
+                % (desc, details.strerror)
+            )
+            rc = win32api.MessageBox(
+                0, full_desc, "Installation Error", win32con.MB_ABORTRETRYIGNORE
+            )
+            if rc == win32con.IDABORT:
+                raise
+            elif rc == win32con.IDIGNORE:
+                return
+            # else retry - around we go again.
+
+
+# We need to import win32api to determine the Windows system directory,
+# so we can copy our system files there - but importing win32api will
+# load the pywintypes.dll already in the system directory preventing us
+# from updating them!
+# So, we pull the same trick pywintypes.py does, but it loads from
+# our pywintypes_system32 directory.
+def LoadSystemModule(lib_dir, modname):
+    # See if this is a debug build.
+    import importlib.machinery
+    import importlib.util
+
+    suffix = "_d" if "_d.pyd" in importlib.machinery.EXTENSION_SUFFIXES else ""
+    filename = "%s%d%d%s.dll" % (
+        modname,
+        sys.version_info[0],
+        sys.version_info[1],
+        suffix,
+    )
+    filename = os.path.join(lib_dir, "pywin32_system32", filename)
+    loader = importlib.machinery.ExtensionFileLoader(modname, filename)
+    spec = importlib.machinery.ModuleSpec(name=modname, loader=loader, origin=filename)
+    mod = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(mod)
+
+
+def SetPyKeyVal(key_name, value_name, value):
+    root_hkey = get_root_hkey()
+    root_key = winreg.OpenKey(root_hkey, root_key_name)
+    try:
+        my_key = winreg.CreateKey(root_key, key_name)
+        try:
+            winreg.SetValueEx(my_key, value_name, 0, winreg.REG_SZ, value)
+            if verbose:
+                print("-> %s\\%s[%s]=%r" % (root_key_name, key_name, value_name, value))
+        finally:
+            my_key.Close()
+    finally:
+        root_key.Close()
+
+
+def UnsetPyKeyVal(key_name, value_name, delete_key=False):
+    root_hkey = get_root_hkey()
+    root_key = winreg.OpenKey(root_hkey, root_key_name)
+    try:
+        my_key = winreg.OpenKey(root_key, key_name, 0, winreg.KEY_SET_VALUE)
+        try:
+            winreg.DeleteValue(my_key, value_name)
+            if verbose:
+                print("-> DELETE %s\\%s[%s]" % (root_key_name, key_name, value_name))
+        finally:
+            my_key.Close()
+        if delete_key:
+            winreg.DeleteKey(root_key, key_name)
+            if verbose:
+                print("-> DELETE %s\\%s" % (root_key_name, key_name))
+    except OSError as why:
+        winerror = getattr(why, "winerror", why.errno)
+        if winerror != 2:  # file not found
+            raise
+    finally:
+        root_key.Close()
+
+
+def RegisterCOMObjects(register=True):
+    import win32com.server.register
+
+    if register:
+        func = win32com.server.register.RegisterClasses
+    else:
+        func = win32com.server.register.UnregisterClasses
+    flags = {}
+    if not verbose:
+        flags["quiet"] = 1
+    for module, klass_name in com_modules:
+        __import__(module)
+        mod = sys.modules[module]
+        flags["finalize_register"] = getattr(mod, "DllRegisterServer", None)
+        flags["finalize_unregister"] = getattr(mod, "DllUnregisterServer", None)
+        klass = getattr(mod, klass_name)
+        func(klass, **flags)
+
+
+def RegisterHelpFile(register=True, lib_dir=None):
+    if lib_dir is None:
+        lib_dir = sysconfig.get_paths()["platlib"]
+    if register:
+        # Register the .chm help file.
+        chm_file = os.path.join(lib_dir, "PyWin32.chm")
+        if os.path.isfile(chm_file):
+            # This isn't recursive, so if 'Help' doesn't exist, we croak
+            SetPyKeyVal("Help", None, None)
+            SetPyKeyVal("Help\\Pythonwin Reference", None, chm_file)
+            return chm_file
+        else:
+            print("NOTE: PyWin32.chm can not be located, so has not " "been registered")
+    else:
+        UnsetPyKeyVal("Help\\Pythonwin Reference", None, delete_key=True)
+    return None
+
+
+def RegisterPythonwin(register=True, lib_dir=None):
+    """Add (or remove) Pythonwin to context menu for python scripts.
+    ??? Should probably also add Edit command for pys files also.
+    Also need to remove these keys on uninstall, but there's no function
+        like file_created to add registry entries to uninstall log ???
+    """
+    import os
+
+    if lib_dir is None:
+        lib_dir = sysconfig.get_paths()["platlib"]
+    classes_root = get_root_hkey()
+    ## Installer executable doesn't seem to pass anything to postinstall script indicating if it's a debug build,
+    pythonwin_exe = os.path.join(lib_dir, "Pythonwin", "Pythonwin.exe")
+    pythonwin_edit_command = pythonwin_exe + ' -edit "%1"'
+
+    keys_vals = [
+        (
+            "Software\\Microsoft\\Windows\\CurrentVersion\\App Paths\\Pythonwin.exe",
+            "",
+            pythonwin_exe,
+        ),
+        (
+            "Software\\Classes\\Python.File\\shell\\Edit with Pythonwin",
+            "command",
+            pythonwin_edit_command,
+        ),
+        (
+            "Software\\Classes\\Python.NoConFile\\shell\\Edit with Pythonwin",
+            "command",
+            pythonwin_edit_command,
+        ),
+    ]
+
+    try:
+        if register:
+            for key, sub_key, val in keys_vals:
+                ## Since winreg only uses the character Api functions, this can fail if Python
+                ##  is installed to a path containing non-ascii characters
+                hkey = winreg.CreateKey(classes_root, key)
+                if sub_key:
+                    hkey = winreg.CreateKey(hkey, sub_key)
+                winreg.SetValueEx(hkey, None, 0, winreg.REG_SZ, val)
+                hkey.Close()
+        else:
+            for key, sub_key, val in keys_vals:
+                try:
+                    if sub_key:
+                        hkey = winreg.OpenKey(classes_root, key)
+                        winreg.DeleteKey(hkey, sub_key)
+                        hkey.Close()
+                    winreg.DeleteKey(classes_root, key)
+                except OSError as why:
+                    winerror = getattr(why, "winerror", why.errno)
+                    if winerror != 2:  # file not found
+                        raise
+    finally:
+        # tell windows about the change
+        from win32com.shell import shell, shellcon
+
+        shell.SHChangeNotify(
+            shellcon.SHCNE_ASSOCCHANGED, shellcon.SHCNF_IDLIST, None, None
+        )
+
+
+def get_shortcuts_folder():
+    if get_root_hkey() == winreg.HKEY_LOCAL_MACHINE:
+        try:
+            fldr = get_special_folder_path("CSIDL_COMMON_PROGRAMS")
+        except OSError:
+            # No CSIDL_COMMON_PROGRAMS on this platform
+            fldr = get_special_folder_path("CSIDL_PROGRAMS")
+    else:
+        # non-admin install - always goes in this user's start menu.
+        fldr = get_special_folder_path("CSIDL_PROGRAMS")
+
+    try:
+        install_group = winreg.QueryValue(
+            get_root_hkey(), root_key_name + "\\InstallPath\\InstallGroup"
+        )
+    except OSError:
+        vi = sys.version_info
+        install_group = "Python %d.%d" % (vi[0], vi[1])
+    return os.path.join(fldr, install_group)
+
+
+# Get the system directory, which may be the Wow64 directory if we are a 32bit
+# python on a 64bit OS.
+def get_system_dir():
+    import win32api  # we assume this exists.
+
+    try:
+        import pythoncom
+        import win32process
+        from win32com.shell import shell, shellcon
+
+        try:
+            if win32process.IsWow64Process():
+                return shell.SHGetSpecialFolderPath(0, shellcon.CSIDL_SYSTEMX86)
+            return shell.SHGetSpecialFolderPath(0, shellcon.CSIDL_SYSTEM)
+        except (pythoncom.com_error, win32process.error):
+            return win32api.GetSystemDirectory()
+    except ImportError:
+        return win32api.GetSystemDirectory()
+
+
+def fixup_dbi():
+    # We used to have a dbi.pyd with our .pyd files, but now have a .py file.
+    # If the user didn't uninstall, they will find the .pyd which will cause
+    # problems - so handle that.
+    import win32api
+    import win32con
+
+    pyd_name = os.path.join(os.path.dirname(win32api.__file__), "dbi.pyd")
+    pyd_d_name = os.path.join(os.path.dirname(win32api.__file__), "dbi_d.pyd")
+    py_name = os.path.join(os.path.dirname(win32con.__file__), "dbi.py")
+    for this_pyd in (pyd_name, pyd_d_name):
+        this_dest = this_pyd + ".old"
+        if os.path.isfile(this_pyd) and os.path.isfile(py_name):
+            try:
+                if os.path.isfile(this_dest):
+                    print(
+                        "Old dbi '%s' already exists - deleting '%s'"
+                        % (this_dest, this_pyd)
+                    )
+                    os.remove(this_pyd)
+                else:
+                    os.rename(this_pyd, this_dest)
+                    print("renamed '%s'->'%s.old'" % (this_pyd, this_pyd))
+                    file_created(this_pyd + ".old")
+            except os.error as exc:
+                print("FAILED to rename '%s': %s" % (this_pyd, exc))
+
+
+def install(lib_dir):
+    import traceback
+
+    # The .pth file is now installed as a regular file.
+    # Create the .pth file in the site-packages dir, and use only relative paths
+    # We used to write a .pth directly to sys.prefix - clobber it.
+    if os.path.isfile(os.path.join(sys.prefix, "pywin32.pth")):
+        os.unlink(os.path.join(sys.prefix, "pywin32.pth"))
+    # The .pth may be new and therefore not loaded in this session.
+    # Setup the paths just in case.
+    for name in "win32 win32\\lib Pythonwin".split():
+        sys.path.append(os.path.join(lib_dir, name))
+    # It is possible people with old versions installed with still have
+    # pywintypes and pythoncom registered.  We no longer need this, and stale
+    # entries hurt us.
+    for name in "pythoncom pywintypes".split():
+        keyname = "Software\\Python\\PythonCore\\" + sys.winver + "\\Modules\\" + name
+        for root in winreg.HKEY_LOCAL_MACHINE, winreg.HKEY_CURRENT_USER:
+            try:
+                winreg.DeleteKey(root, keyname + "\\Debug")
+            except WindowsError:
+                pass
+            try:
+                winreg.DeleteKey(root, keyname)
+            except WindowsError:
+                pass
+    LoadSystemModule(lib_dir, "pywintypes")
+    LoadSystemModule(lib_dir, "pythoncom")
+    import win32api
+
+    # and now we can get the system directory:
+    files = glob.glob(os.path.join(lib_dir, "pywin32_system32\\*.*"))
+    if not files:
+        raise RuntimeError("No system files to copy!!")
+    # Try the system32 directory first - if that fails due to "access denied",
+    # it implies a non-admin user, and we use sys.prefix
+    for dest_dir in [get_system_dir(), sys.prefix]:
+        # and copy some files over there
+        worked = 0
+        try:
+            for fname in files:
+                base = os.path.basename(fname)
+                dst = os.path.join(dest_dir, base)
+                CopyTo("installing %s" % base, fname, dst)
+                if verbose:
+                    print("Copied %s to %s" % (base, dst))
+                # Register the files with the uninstaller
+                file_created(dst)
+                worked = 1
+                # Nuke any other versions that may exist - having
+                # duplicates causes major headaches.
+                bad_dest_dirs = [
+                    os.path.join(sys.prefix, "Library\\bin"),
+                    os.path.join(sys.prefix, "Lib\\site-packages\\win32"),
+                ]
+                if dest_dir != sys.prefix:
+                    bad_dest_dirs.append(sys.prefix)
+                for bad_dest_dir in bad_dest_dirs:
+                    bad_fname = os.path.join(bad_dest_dir, base)
+                    if os.path.exists(bad_fname):
+                        # let exceptions go here - delete must succeed
+                        os.unlink(bad_fname)
+            if worked:
+                break
+        except win32api.error as details:
+            if details.winerror == 5:
+                # access denied - user not admin - try sys.prefix dir,
+                # but first check that a version doesn't already exist
+                # in that place - otherwise that one will still get used!
+                if os.path.exists(dst):
+                    msg = (
+                        "The file '%s' exists, but can not be replaced "
+                        "due to insufficient permissions.  You must "
+                        "reinstall this software as an Administrator" % dst
+                    )
+                    print(msg)
+                    raise RuntimeError(msg)
+                continue
+            raise
+    else:
+        raise RuntimeError(
+            "You don't have enough permissions to install the system files"
+        )
+
+    # Pythonwin 'compiles' config files - record them for uninstall.
+    pywin_dir = os.path.join(lib_dir, "Pythonwin", "pywin")
+    for fname in glob.glob(os.path.join(pywin_dir, "*.cfg")):
+        file_created(fname[:-1] + "c")  # .cfg->.cfc
+
+    # Register our demo COM objects.
+    try:
+        try:
+            RegisterCOMObjects()
+        except win32api.error as details:
+            if details.winerror != 5:  # ERROR_ACCESS_DENIED
+                raise
+            print("You do not have the permissions to install COM objects.")
+            print("The sample COM objects were not registered.")
+    except Exception:
+        print("FAILED to register the Python COM objects")
+        traceback.print_exc()
+
+    # There may be no main Python key in HKCU if, eg, an admin installed
+    # python itself.
+    winreg.CreateKey(get_root_hkey(), root_key_name)
+
+    chm_file = None
+    try:
+        chm_file = RegisterHelpFile(True, lib_dir)
+    except Exception:
+        print("Failed to register help file")
+        traceback.print_exc()
+    else:
+        if verbose:
+            print("Registered help file")
+
+    # misc other fixups.
+    fixup_dbi()
+
+    # Register Pythonwin in context menu
+    try:
+        RegisterPythonwin(True, lib_dir)
+    except Exception:
+        print("Failed to register pythonwin as editor")
+        traceback.print_exc()
+    else:
+        if verbose:
+            print("Pythonwin has been registered in context menu")
+
+    # Create the win32com\gen_py directory.
+    make_dir = os.path.join(lib_dir, "win32com", "gen_py")
+    if not os.path.isdir(make_dir):
+        if verbose:
+            print("Creating directory %s" % (make_dir,))
+        directory_created(make_dir)
+        os.mkdir(make_dir)
+
+    try:
+        # create shortcuts
+        # CSIDL_COMMON_PROGRAMS only available works on NT/2000/XP, and
+        # will fail there if the user has no admin rights.
+        fldr = get_shortcuts_folder()
+        # If the group doesn't exist, then we don't make shortcuts - its
+        # possible that this isn't a "normal" install.
+        if os.path.isdir(fldr):
+            dst = os.path.join(fldr, "PythonWin.lnk")
+            create_shortcut(
+                os.path.join(lib_dir, "Pythonwin\\Pythonwin.exe"),
+                "The Pythonwin IDE",
+                dst,
+                "",
+                sys.prefix,
+            )
+            file_created(dst)
+            if verbose:
+                print("Shortcut for Pythonwin created")
+            # And the docs.
+            if chm_file:
+                dst = os.path.join(fldr, "Python for Windows Documentation.lnk")
+                doc = "Documentation for the PyWin32 extensions"
+                create_shortcut(chm_file, doc, dst)
+                file_created(dst)
+                if verbose:
+                    print("Shortcut to documentation created")
+        else:
+            if verbose:
+                print("Can't install shortcuts - %r is not a folder" % (fldr,))
+    except Exception as details:
+        print(details)
+
+    # importing win32com.client ensures the gen_py dir created - not strictly
+    # necessary to do now, but this makes the installation "complete"
+    try:
+        import win32com.client  # noqa
+    except ImportError:
+        # Don't let this error sound fatal
+        pass
+    print("The pywin32 extensions were successfully installed.")
+
+    if is_bdist_wininst:
+        # Open a web page with info about the .exe installers being deprecated.
+        import webbrowser
+
+        try:
+            webbrowser.open("https://mhammond.github.io/pywin32_installers.html")
+        except webbrowser.Error:
+            print("Please visit https://mhammond.github.io/pywin32_installers.html")
+
+
+def uninstall(lib_dir):
+    # First ensure our system modules are loaded from pywin32_system, so
+    # we can remove the ones we copied...
+    LoadSystemModule(lib_dir, "pywintypes")
+    LoadSystemModule(lib_dir, "pythoncom")
+
+    try:
+        RegisterCOMObjects(False)
+    except Exception as why:
+        print("Failed to unregister COM objects: %s" % (why,))
+
+    try:
+        RegisterHelpFile(False, lib_dir)
+    except Exception as why:
+        print("Failed to unregister help file: %s" % (why,))
+    else:
+        if verbose:
+            print("Unregistered help file")
+
+    try:
+        RegisterPythonwin(False, lib_dir)
+    except Exception as why:
+        print("Failed to unregister Pythonwin: %s" % (why,))
+    else:
+        if verbose:
+            print("Unregistered Pythonwin")
+
+    try:
+        # remove gen_py directory.
+        gen_dir = os.path.join(lib_dir, "win32com", "gen_py")
+        if os.path.isdir(gen_dir):
+            shutil.rmtree(gen_dir)
+            if verbose:
+                print("Removed directory %s" % (gen_dir,))
+
+        # Remove pythonwin compiled "config" files.
+        pywin_dir = os.path.join(lib_dir, "Pythonwin", "pywin")
+        for fname in glob.glob(os.path.join(pywin_dir, "*.cfc")):
+            os.remove(fname)
+
+        # The dbi.pyd.old files we may have created.
+        try:
+            os.remove(os.path.join(lib_dir, "win32", "dbi.pyd.old"))
+        except os.error:
+            pass
+        try:
+            os.remove(os.path.join(lib_dir, "win32", "dbi_d.pyd.old"))
+        except os.error:
+            pass
+
+    except Exception as why:
+        print("Failed to remove misc files: %s" % (why,))
+
+    try:
+        fldr = get_shortcuts_folder()
+        for link in ("PythonWin.lnk", "Python for Windows Documentation.lnk"):
+            fqlink = os.path.join(fldr, link)
+            if os.path.isfile(fqlink):
+                os.remove(fqlink)
+                if verbose:
+                    print("Removed %s" % (link,))
+    except Exception as why:
+        print("Failed to remove shortcuts: %s" % (why,))
+    # Now remove the system32 files.
+    files = glob.glob(os.path.join(lib_dir, "pywin32_system32\\*.*"))
+    # Try the system32 directory first - if that fails due to "access denied",
+    # it implies a non-admin user, and we use sys.prefix
+    try:
+        for dest_dir in [get_system_dir(), sys.prefix]:
+            # and copy some files over there
+            worked = 0
+            for fname in files:
+                base = os.path.basename(fname)
+                dst = os.path.join(dest_dir, base)
+                if os.path.isfile(dst):
+                    try:
+                        os.remove(dst)
+                        worked = 1
+                        if verbose:
+                            print("Removed file %s" % (dst))
+                    except Exception:
+                        print("FAILED to remove %s" % (dst,))
+            if worked:
+                break
+    except Exception as why:
+        print("FAILED to remove system files: %s" % (why,))
+
+
+# NOTE: If this script is run from inside the bdist_wininst created
+# binary installer or uninstaller, the command line args are either
+# '-install' or '-remove'.
+
+# Important: From inside the binary installer this script MUST NOT
+# call sys.exit() or raise SystemExit, otherwise not only this script
+# but also the installer will terminate! (Is there a way to prevent
+# this from the bdist_wininst C code?)
+
+
+def verify_destination(location):
+    if not os.path.isdir(location):
+        raise argparse.ArgumentTypeError('Path "{}" does not exist!'.format(location))
+    return location
+
+
+def main():
+    import argparse
+
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="""A post-install script for the pywin32 extensions.
+
+    * Typical usage:
+
+    > python pywin32_postinstall.py -install
+
+    If you installed pywin32 via a .exe installer, this should be run
+    automatically after installation, but if it fails you can run it again.
+
+    If you installed pywin32 via PIP, you almost certainly need to run this to
+    setup the environment correctly.
+
+    Execute with script with a '-install' parameter, to ensure the environment
+    is setup correctly.
+    """,
+    )
+    parser.add_argument(
+        "-install",
+        default=False,
+        action="store_true",
+        help="Configure the Python environment correctly for pywin32.",
+    )
+    parser.add_argument(
+        "-remove",
+        default=False,
+        action="store_true",
+        help="Try and remove everything that was installed or copied.",
+    )
+    parser.add_argument(
+        "-wait",
+        type=int,
+        help="Wait for the specified process to terminate before starting.",
+    )
+    parser.add_argument(
+        "-silent",
+        default=False,
+        action="store_true",
+        help='Don\'t display the "Abort/Retry/Ignore" dialog for files in use.',
+    )
+    parser.add_argument(
+        "-quiet",
+        default=False,
+        action="store_true",
+        help="Don't display progress messages.",
+    )
+    parser.add_argument(
+        "-destination",
+        default=sysconfig.get_paths()["platlib"],
+        type=verify_destination,
+        help="Location of the PyWin32 installation",
+    )
+
+    args = parser.parse_args()
+
+    if not args.quiet:
+        print("Parsed arguments are: {}".format(args))
+
+    if not args.install ^ args.remove:
+        parser.error("You need to either choose to -install or -remove!")
+
+    if args.wait is not None:
+        try:
+            os.waitpid(args.wait, 0)
+        except os.error:
+            # child already dead
+            pass
+
+    silent = args.silent
+    verbose = not args.quiet
+
+    if args.install:
+        install(args.destination)
+
+    if args.remove:
+        if not is_bdist_wininst:
+            uninstall(args.destination)
+
+
+if __name__ == "__main__":
+    main()

rag/Scripts/pywin32_testall.py

@@ -0,0 +1,124 @@
+"""A test runner for pywin32"""
+import os
+import site
+import subprocess
+import sys
+
+# locate the dirs based on where this script is - it may be either in the
+# source tree, or in an installed Python 'Scripts' tree.
+this_dir = os.path.dirname(__file__)
+site_packages = [
+    site.getusersitepackages(),
+] + site.getsitepackages()
+
+failures = []
+
+
+# Run a test using subprocess and wait for the result.
+# If we get an returncode != 0, we know that there was an error, but we don't
+# abort immediately - we run as many tests as we can.
+def run_test(script, cmdline_extras):
+    dirname, scriptname = os.path.split(script)
+    # some tests prefer to be run from their directory.
+    cmd = [sys.executable, "-u", scriptname] + cmdline_extras
+    print("--- Running '%s' ---" % script)
+    sys.stdout.flush()
+    result = subprocess.run(cmd, check=False, cwd=dirname)
+    print("*** Test script '%s' exited with %s" % (script, result.returncode))
+    sys.stdout.flush()
+    if result.returncode:
+        failures.append(script)
+
+
+def find_and_run(possible_locations, extras):
+    for maybe in possible_locations:
+        if os.path.isfile(maybe):
+            run_test(maybe, extras)
+            break
+    else:
+        raise RuntimeError(
+            "Failed to locate a test script in one of %s" % possible_locations
+        )
+
+
+def main():
+    import argparse
+
+    code_directories = [this_dir] + site_packages
+
+    parser = argparse.ArgumentParser(
+        description="A script to trigger tests in all subprojects of PyWin32."
+    )
+    parser.add_argument(
+        "-no-user-interaction",
+        default=False,
+        action="store_true",
+        help="(This is now the default - use `-user-interaction` to include them)",
+    )
+
+    parser.add_argument(
+        "-user-interaction",
+        action="store_true",
+        help="Include tests which require user interaction",
+    )
+
+    parser.add_argument(
+        "-skip-adodbapi",
+        default=False,
+        action="store_true",
+        help="Skip the adodbapi tests; useful for CI where there's no provider",
+    )
+
+    args, remains = parser.parse_known_args()
+
+    # win32, win32ui / Pythonwin
+
+    extras = []
+    if args.user_interaction:
+        extras += ["-user-interaction"]
+    extras.extend(remains)
+    scripts = [
+        "win32/test/testall.py",
+        "Pythonwin/pywin/test/all.py",
+    ]
+    for script in scripts:
+        maybes = [os.path.join(directory, script) for directory in code_directories]
+        find_and_run(maybes, extras)
+
+    # win32com
+    maybes = [
+        os.path.join(directory, "win32com", "test", "testall.py")
+        for directory in [
+            os.path.join(this_dir, "com"),
+        ]
+        + site_packages
+    ]
+    extras = remains + ["1"]  # only run "level 1" tests in CI
+    find_and_run(maybes, extras)
+
+    # adodbapi
+    if not args.skip_adodbapi:
+        maybes = [
+            os.path.join(directory, "adodbapi", "test", "adodbapitest.py")
+            for directory in code_directories
+        ]
+        find_and_run(maybes, remains)
+        # This script has a hard-coded sql server name in it, (and markh typically
+        # doesn't have a different server to test on) but there is now supposed to be a server out there on the Internet
+        # just to run these tests, so try it...
+        maybes = [
+            os.path.join(directory, "adodbapi", "test", "test_adodbapi_dbapi20.py")
+            for directory in code_directories
+        ]
+        find_and_run(maybes, remains)
+
+    if failures:
+        print("The following scripts failed")
+        for failure in failures:
+            print(">", failure)
+        sys.exit(1)
+    print("All tests passed \\o/")
+
+
+if __name__ == "__main__":
+    main()

rag/Scripts/streamlit.cmd

@@ -0,0 +1,16 @@
+rem Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022)
+rem
+rem Licensed under the Apache License, Version 2.0 (the "License");
+rem you may not use this file except in compliance with the License.
+rem You may obtain a copy of the License at
+rem
+rem     http://www.apache.org/licenses/LICENSE-2.0
+rem
+rem Unless required by applicable law or agreed to in writing, software
+rem distributed under the License is distributed on an "AS IS" BASIS,
+rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+rem See the License for the specific language governing permissions and
+rem limitations under the License.
+
+@echo OFF
+python -m streamlit %*

rag/etc/jupyter/nbconfig/notebook.d/pydeck.json

@@ -0,0 +1,5 @@
+{
+    "load_extensions": {
+        "pydeck/extension": true
+    }
+}

rag/pyvenv.cfg

@@ -0,0 +1,3 @@
+home = C:\Python39
+include-system-site-packages = false
+version = 3.9.8

rag/share/jupyter/kernels/python3/kernel.json

@@ -0,0 +1,14 @@
+{
+ "argv": [
+  "python",
+  "-m",
+  "ipykernel_launcher",
+  "-f",
+  "{connection_file}"
+ ],
+ "display_name": "Python 3 (ipykernel)",
+ "language": "python",
+ "metadata": {
+  "debugger": true
+ }
+}

rag/share/jupyter/nbextensions/pydeck/extensionRequires.js

@@ -0,0 +1,15 @@
+/* eslint-disable */
+define(function() {
+  'use strict';
+  requirejs.config({
+    map: {
+      '*': {
+        '@deck.gl/jupyter-widget': 'nbextensions/pydeck/index'
+      }
+    }
+  });
+  // Export the required load_ipython_extension function
+  return {
+    load_ipython_extension: function() {}
+  };
+});