├── agent ├── __init__.py ├── settings.py ├── kb.py ├── writer.py ├── think.py ├── research.py ├── summary.py └── code.py ├── lib ├── __init__.py ├── pako.py └── utils.py ├── .env.example ├── mcp └── kb_exploer.py ├── README.md ├── pyproject.toml ├── .gitignore ├── cli.py └── LICENSE.txt /agent/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /lib/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /agent/settings.py: -------------------------------------------------------------------------------- 1 | GEMINI_MODEL_ID = "gemini-2.5-flash-preview-04-17" 2 | # GEMINI_MODEL_ID = "gemini-2.0-flash" 3 | GROQ_MODEL_ID = "llama3-8b-8192" 4 | -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | GOOGLE_API_KEY=Your_Google_API_Key 2 | GROQ_API_KEY=Your_GROQ_API_Key 3 | RESEND_API_KEY=Your_Resend_API_Key 4 | EMAIL_FROM=Your_Email_From # E.g "TSW " 5 | -------------------------------------------------------------------------------- /mcp/kb_exploer.py: -------------------------------------------------------------------------------- 1 | from agent.kb import list_kb_entries 2 | from mcp.server.fastmcp import FastMCP 3 | 4 | mcp = FastMCP("My-KB") 5 | 6 | config = "/Users/hujian/projects/creative/tsw-cli/config/kb.json" 7 | 8 | 9 | @mcp.resource("tsw://kb") 10 | def get_entry() -> str: 11 | return list_kb_entries(config) 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tsw-cli 2 | 3 | A command line interface for your tiny smart workers. 4 | 5 | ## How to Run 6 | 7 | 1. configure your environment 8 | 1. `uv sync` 9 | 1. `source .venv/bin/activate` 10 | 1. `uv pip install .` 11 | 1. `tsw-cli --help` 12 | 1. `tsw-cli --config ` 13 | 14 | Note: 15 | 16 | - for environment configuration, you can use the `.env.example` file 17 | - normally, each command has a `--config` option to specify the configuration file. for its details, you can find them in codes. 18 | - the default PG schema for Knowledge is `ai`, you can find it with `\dn` in psql. 19 | 20 | ## MCP Server 21 | 22 | prerequisites: add source as the dependency 23 | 24 | - `uv add --dev .` 25 | - `uv build` 26 | - `uv sync` 27 | 28 | development: 29 | 30 | - test: `mcp dev mcp/kb_exploer.py` 31 | - install to claude: `mcp install mcp/kb_exploer.py --with-editable .` 32 | -------------------------------------------------------------------------------- /lib/pako.py: -------------------------------------------------------------------------------- 1 | # Reference: 2 | # https://github.com/mermaid-js/mermaid-live-editor/discussions/1291#discussioncomment-6837936 3 | import base64 4 | import json 5 | import zlib 6 | 7 | import requests 8 | 9 | 10 | def _js_string_to_byte(data): 11 | return bytes(data, "ascii") 12 | 13 | 14 | def _js_bytes_to_string(data): 15 | return data.decode("ascii") 16 | 17 | 18 | def _js_btoa(data): 19 | return base64.urlsafe_b64encode(data) 20 | 21 | 22 | def _pako_deflate(data): 23 | compress = zlib.compressobj(9, zlib.DEFLATED, 15, 8, zlib.Z_DEFAULT_STRATEGY) 24 | compressed_data = compress.compress(data) 25 | compressed_data += compress.flush() 26 | return compressed_data 27 | 28 | 29 | def generate_pako_link(graphMarkdown: str): 30 | jGraph = {"code": graphMarkdown, "mermaid": {"theme": "default"}} 31 | byteStr = _js_string_to_byte(json.dumps(jGraph)) 32 | deflated = _pako_deflate(byteStr) 33 | dEncode = _js_btoa(deflated) 34 | link = "http://mermaid.ink/img/pako:" + _js_bytes_to_string(dEncode) 35 | return link 36 | 37 | 38 | def generate_image_dataurl(link: str): 39 | r = requests.get(link) 40 | return f"data:image/png;base64,{base64.b64encode(r.content).decode()}" 41 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools>=42", "wheel"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [project] 6 | authors = [ 7 | {name = "foxgem", email = "jianhgreat@hotmail.com"}, 8 | ] 9 | license = {text = "GPL3"} 10 | requires-python = "<4.0,>=3.12" 11 | dependencies = [ 12 | "typer<1.0.0,>=0.15.1", 13 | "agno<2.0.0,>=1.0.3", 14 | "markdown-pdf<2.0.0,>=1.3.3", 15 | "pydantic-settings<3.0.0,>=2.7.1", 16 | "pydantic-core<3.0.0,>=2.27.2", 17 | "pydantic<3.0.0,>=2.10.6", 18 | "python-dotenv<2.0.0,>=1.0.1", 19 | "duckduckgo-search<8.0.0,>=7.3.0", 20 | "resend<3.0.0,>=2.6.0", 21 | "markdown<4.0,>=3.7", 22 | "pypdf<6.0.0,>=5.2.0", 23 | "sqlalchemy<3.0.0,>=2.0.38", 24 | "pgvector<1.0.0,>=0.3.6", 25 | "psycopg[binary]<4.0.0,>=3.2.4", 26 | "googlesearch-python<2.0.0,>=1.3.0", 27 | "pycountry<25.0.0,>=24.6.1", 28 | "groq<1.0.0,>=0.18.0", 29 | "markdownify<1.0.0,>=0.14.1", 30 | "mcp<2.0.0,>=1.3.0", 31 | "google-genai>=1.3.0", 32 | "repomix>=0.2.2", 33 | "pymupdf4llm>=0.0.16", 34 | "youtube-transcript-api>=1.0.2", 35 | ] 36 | name = "tsw-cli" 37 | version = "0.1.0" 38 | description = "tsw-cli" 39 | readme = "README.md" 40 | 41 | [dependency-groups] 42 | dev = [ 43 | "tsw-cli", 44 | ] 45 | 46 | [tool.uv.sources] 47 | tsw-cli = { workspace = true } 48 | 49 | [tool.setuptools] 50 | packages = ["lib", "agent"] 51 | py-modules = ["cli"] 52 | 53 | [project.scripts] 54 | tsw-cli = "cli:main" -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 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 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | wheels/ 22 | share/python-wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .nox/ 42 | .coverage 43 | .coverage.* 44 | .cache 45 | nosetests.xml 46 | coverage.xml 47 | *.cover 48 | *.py,cover 49 | .hypothesis/ 50 | .pytest_cache/ 51 | cover/ 52 | 53 | # Translations 54 | *.mo 55 | *.pot 56 | 57 | # Django stuff: 58 | *.log 59 | local_settings.py 60 | db.sqlite3 61 | db.sqlite3-journal 62 | 63 | # Flask stuff: 64 | instance/ 65 | .webassets-cache 66 | 67 | # Scrapy stuff: 68 | .scrapy 69 | 70 | # Sphinx documentation 71 | docs/_build/ 72 | doc/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # celery beat schedule file 88 | celerybeat-schedule 89 | 90 | # SageMath parsed files 91 | *.sage.py 92 | 93 | # Environments 94 | .env 95 | .venv 96 | env/ 97 | venv/ 98 | ENV/ 99 | env.bak/ 100 | venv.bak/ 101 | 102 | # Spyder project settings 103 | .spyderproject 104 | .spyderworkspace 105 | 106 | # Rope project settings 107 | .ropeproject 108 | 109 | # mkdocs documentation 110 | /site 111 | 112 | # mypy 113 | .mypy_cache/ 114 | .dmypy.json 115 | dmypy.json 116 | 117 | # Pyre type checker 118 | .pyre/ 119 | 120 | # pytype static type analyzer 121 | .pytype/ 122 | 123 | # Cython debug symbols 124 | cython_debug/ 125 | 126 | # db files 127 | *.db 128 | 129 | # tmp dirs/files 130 | tmp 131 | .DS_Store 132 | *.out 133 | 134 | # data dir 135 | output 136 | config 137 | data -------------------------------------------------------------------------------- /agent/kb.py: -------------------------------------------------------------------------------- 1 | import json 2 | 3 | from agno.embedder.google import GeminiEmbedder 4 | from agno.knowledge.pdf import PDFKnowledgeBase, PDFReader 5 | from agno.vectordb.pgvector import PgVector 6 | from pydantic import BaseModel, Field 7 | from sqlalchemy.sql.expression import delete, select 8 | 9 | 10 | class Config(BaseModel): 11 | # example: "postgresql+psycopg://user:password@127.0.0.1:5432/db" 12 | pg_url: str = Field(description="KB database URL") 13 | 14 | 15 | def list_kb_entries(config: str): 16 | c = _load_config(config) 17 | db: PgVector = PgVector( 18 | table_name="pdf_documents", 19 | db_url=c.pg_url, 20 | embedder=GeminiEmbedder(), 21 | ) 22 | 23 | try: 24 | with db.Session() as sess, sess.begin(): 25 | stmt = select(db.table.c.name).distinct() 26 | result = sess.execute(stmt) 27 | entries = "\n".join([row[0] for row in result]) 28 | print(entries) 29 | return entries 30 | except Exception as e: 31 | print(f"Error getting document names from table '{db.table.fullname}': {e}") 32 | 33 | 34 | def generate_kb_entry(resourceUrl: str, config: str, upsert=False): 35 | c = _load_config(config) 36 | kb = PDFKnowledgeBase( 37 | path=resourceUrl, 38 | vector_db=PgVector( 39 | table_name="pdf_documents", 40 | db_url=c.pg_url, 41 | embedder=GeminiEmbedder(), 42 | ), 43 | reader=PDFReader(chunk=True), 44 | ) 45 | kb.load( 46 | recreate=False, 47 | upsert=upsert, 48 | ) 49 | 50 | 51 | def _load_config(config: str): 52 | with open(config, "r") as file: 53 | json_data = json.load(file) 54 | c = Config.model_validate(json_data) 55 | return c 56 | 57 | 58 | def remove_kb_entry( 59 | name: str, 60 | config: str, 61 | ): 62 | c = _load_config(config) 63 | db: PgVector = PgVector( 64 | table_name="pdf_documents", 65 | db_url=c.pg_url, 66 | embedder=GeminiEmbedder(), 67 | ) 68 | if not db.name_exists(name): 69 | print(f"No such entry: {name}") 70 | return 71 | 72 | try: 73 | with db.Session() as sess, sess.begin(): 74 | stmt = delete(db.table).where(db.table.c.name == name) 75 | sess.execute(stmt) 76 | sess.commit() 77 | except Exception as e: 78 | print(f"Error getting count from table '{db.table.fullname}': {e}") 79 | sess.rollback() 80 | -------------------------------------------------------------------------------- /cli.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | import typer 4 | from dotenv import load_dotenv 5 | 6 | from agent.code import explain_repo, pack_repo 7 | from agent.kb import generate_kb_entry, list_kb_entries, remove_kb_entry 8 | from agent.research import start_research 9 | from agent.summary import generate_summary 10 | from agent.think import deep_think 11 | from agent.writer import write_article 12 | 13 | load_dotenv() 14 | 15 | app = typer.Typer(help="a command line interface for your tiny smart workers.") 16 | kb_app = typer.Typer(help="Commands related to the knowledge base.") 17 | code_app = typer.Typer(help="Commands related to the coding.") 18 | 19 | 20 | @app.command() 21 | def research( 22 | config: str = typer.Argument(..., help="config file path"), 23 | ): 24 | """ 25 | Generate a deep research report for a given topic. 26 | """ 27 | start_research(config) 28 | 29 | 30 | @app.command() 31 | def think( 32 | config: str = typer.Argument(..., help="config file path"), 33 | ): 34 | """ 35 | Deeply think about a given link. 36 | """ 37 | deep_think(config) 38 | 39 | 40 | @app.command() 41 | def write( 42 | config: str = typer.Argument(None, help="config file path"), 43 | ): 44 | """ 45 | Write a new article. 46 | """ 47 | write_article(config) 48 | 49 | 50 | @app.command() 51 | def summarise( 52 | config: str = typer.Argument(None, help="config file path"), 53 | ): 54 | """ 55 | Generate a summary for a given source. 56 | """ 57 | generate_summary(config) 58 | 59 | 60 | @kb_app.command() 61 | def list( 62 | config: str = typer.Argument(None, help="config file path"), 63 | ): 64 | """ 65 | List all knowledge base entries 66 | """ 67 | list_kb_entries(config) 68 | 69 | 70 | @kb_app.command() 71 | def create( 72 | file: str = typer.Argument(..., help="File for KB entry"), 73 | config: str = typer.Option(None, help="config file path"), 74 | ): 75 | """ 76 | Create a new knowledge base entry. 77 | """ 78 | generate_kb_entry(file, config) 79 | 80 | 81 | @kb_app.command() 82 | def refresh( 83 | file: str = typer.Argument(..., help="File for KB entry"), 84 | config: str = typer.Option(None, help="config file path"), 85 | ): 86 | """ 87 | Create a new knowledge base entry. 88 | """ 89 | generate_kb_entry(file, config, True) 90 | 91 | 92 | @kb_app.command() 93 | def remove( 94 | name: str = typer.Argument(..., help="name for KB entry"), 95 | config: str = typer.Option(None, help="config file path"), 96 | ): 97 | """ 98 | Delete a knowledge base entry. 99 | """ 100 | remove_kb_entry(name, config) 101 | 102 | 103 | @code_app.command() 104 | def explain( 105 | config: str = typer.Argument(..., help="config file path"), 106 | ): 107 | """ 108 | Explain a given code repo. 109 | """ 110 | explain_repo(config) 111 | 112 | 113 | @code_app.command() 114 | def pack( 115 | config: str = typer.Argument(..., help="config file path"), 116 | ): 117 | """ 118 | Pack a given code repo. 119 | """ 120 | pack_repo(config) 121 | 122 | 123 | app.add_typer(kb_app, name="kb") 124 | app.add_typer(code_app, name="code") 125 | 126 | 127 | def main(): 128 | if len(sys.argv) == 1: 129 | sys.argv.append("--help") 130 | elif len(sys.argv) == 2 and sys.argv[1] in ["kb", "code"]: 131 | sys.argv.append("--help") 132 | app() 133 | 134 | 135 | if __name__ == "__main__": 136 | main() 137 | -------------------------------------------------------------------------------- /agent/writer.py: -------------------------------------------------------------------------------- 1 | import json 2 | import time 3 | from textwrap import dedent 4 | from typing import List, Literal 5 | 6 | from agno.agent import Agent 7 | from agno.models.google import Gemini 8 | from pydantic import BaseModel, Field 9 | 10 | from agent.settings import GEMINI_MODEL_ID 11 | from lib.utils import output_content, read, search_topic 12 | 13 | MAX_REVISIONS = 5 14 | 15 | reference_history = [] 16 | expected_output = dedent("""\ 17 | A professional technical article in markdown format: 18 | 19 | # {Compelling Title That Captures the Topic's Essence} 20 | 21 | ## Tags 22 | {tags} 23 | 24 | {the body of the article in multiple sections} 25 | 26 | ## References 27 | {List of sources, citations, and links} 28 | \ 29 | """) 30 | 31 | 32 | class Config(BaseModel): 33 | agenda: str = Field(description="A file path to the agenda") 34 | tags: List[str] = Field(default=[], description="List of tags for the research") 35 | lang: str = Field(default="english", description="Language for the article") 36 | tranlations: List[str] = Field( 37 | default=["chinese"], description="List of languages for translation" 38 | ) 39 | revisions: int = Field( 40 | default=3, le=MAX_REVISIONS, description="Number of revisions" 41 | ) 42 | reviewers: List[str] | None = Field( 43 | default=None, description="List of human reviewers for the article" 44 | ) 45 | format: Literal["md", "pdf"] = Field( 46 | default="md", description="Output format of the article" 47 | ) 48 | 49 | 50 | def write_draft(agenda: str, tags: List[str] = []) -> str: 51 | results = search_topic(",".join(tags), 3, reference_history) 52 | reference_history.extend(results["links"]) 53 | writer = Agent( 54 | name="Writer Agent", 55 | model=Gemini(id=GEMINI_MODEL_ID), 56 | description="You are a professional technical writer and an expert in the field.", 57 | instructions=[ 58 | "you will be given an agenda and some references documents to write a technical article.", 59 | "your readers are technical experts, so the article should be detailed and informative.", 60 | "you can use the references to write the article, but don't copy-paste.", 61 | "the final article should be less than 3000 characters", 62 | ], 63 | expected_output=expected_output, 64 | markdown=True, 65 | ) 66 | return writer.run( 67 | f"Agenda:\n{agenda}\nTags:\n{','.join(tags)}\nReference Document:\n{results['articles']}\nReferences Links:\n{reference_history}" 68 | ).content 69 | 70 | 71 | def revise_draft(draft: str, feedback: str) -> str: 72 | writer = Agent( 73 | name="Writer Agent", 74 | model=Gemini(id=GEMINI_MODEL_ID), 75 | description="You are a professional technical writer and an expert in the field.", 76 | instructions=[ 77 | "your article has been reviewed and you have received feedback.", 78 | "revise the article based on the feedback.", 79 | ], 80 | expected_output=expected_output, 81 | markdown=True, 82 | ) 83 | return writer.run(f"Draft:\n{draft}\nFeedback:\n{feedback}").content 84 | 85 | 86 | def review_draft(draft: str) -> str: 87 | editor = Agent( 88 | name="Editor Agent", 89 | model=Gemini(id=GEMINI_MODEL_ID), 90 | description="You are a professional technical editor.", 91 | instructions=[ 92 | "given a draft of an article, read it and give feedback to improve its quality, readability and accuracy.", 93 | "only return your feedback, no other information or explanation.", 94 | "the feedback should be less than 200 characters", 95 | ], 96 | markdown=True, 97 | ) 98 | return editor.run(draft).content 99 | 100 | 101 | def load_config(config: str | None) -> Config: 102 | if config is None: 103 | return Config() 104 | with open(config, "r") as file: 105 | json_data = json.load(file) 106 | return Config.model_validate(json_data) 107 | 108 | 109 | def write_article(config: str): 110 | c = load_config(config) 111 | agenda = read(c.agenda) 112 | print("Writing Draft ------------------>") 113 | draft = write_draft(agenda, c.tags) 114 | for i in range(c.revisions): 115 | print(f"Reviewing Draft: {i + 1} ------------------>") 116 | feedback = review_draft(draft) 117 | if not feedback: 118 | print("No feedback received. Article is ready.") 119 | break 120 | draft = revise_draft(draft, feedback) 121 | print("Saving ------------------>") 122 | topic = f"article{int(time.time())}" 123 | output_content(topic, c.format, draft) 124 | # if c.receivers: 125 | # send_mail(topic, c.receivers, draft) 126 | -------------------------------------------------------------------------------- /lib/utils.py: -------------------------------------------------------------------------------- 1 | import os 2 | from typing import List 3 | 4 | import markdown 5 | import pymupdf4llm 6 | import requests 7 | import resend 8 | from googlesearch import search 9 | from markdown_pdf import MarkdownPdf, Section 10 | from markdownify import markdownify as md 11 | from youtube_transcript_api import YouTubeTranscriptApi 12 | 13 | output_dir = "output" 14 | os.makedirs(output_dir, exist_ok=True) 15 | 16 | 17 | def generate_pdf(name: str, markdown: str) -> None: 18 | """ 19 | Generates a PDF from the given markdown content. 20 | 21 | Args: 22 | name (str): pdf file name. 23 | markdown (str): The markdown content for the pdf. 24 | 25 | Returns: 26 | None 27 | """ 28 | pdf = MarkdownPdf() 29 | pdf.add_section(Section(markdown)) 30 | try: 31 | pdf.save(f"{output_dir}/{name}.pdf") 32 | except IOError as e: 33 | print(f"Failed to save PDF report: {e}") 34 | 35 | 36 | def write(filename: str, markdown: str, append=False) -> None: 37 | mode = "a" if append else "w" 38 | with open(f"{output_dir}/{filename}", mode) as f: 39 | f.write(markdown) 40 | 41 | 42 | def read(filename: str) -> str: 43 | with open(filename, "r") as f: 44 | return f.read() 45 | 46 | 47 | def exist(file: str) -> bool: 48 | return os.path.exists(file) 49 | 50 | 51 | def extract_text_from_pdf(file: str) -> str: 52 | md_text = pymupdf4llm.to_markdown(file) 53 | return md_text 54 | 55 | 56 | def extract_text_from_youtube(video_id: str) -> str: 57 | ytt_api = YouTubeTranscriptApi() 58 | transcript = ytt_api.fetch(video_id, ["en", "zh"]) 59 | text = "\n".join([snippet.text for snippet in transcript]) 60 | return text 61 | 62 | 63 | def download(link: str, filename: str) -> None: 64 | r = requests.get(link) 65 | with open(f"{output_dir}/{filename}", "wb") as f: 66 | f.write(r.content) 67 | 68 | 69 | def filename(file: str) -> str: 70 | return ".".join(os.path.basename(file).split(".")[0:-1]) 71 | 72 | 73 | def clean_repomix_output(file: str) -> str: 74 | raw_text = read(file) 75 | lines = raw_text.split("\n") 76 | start_line = lines.index("# Repository Structure") 77 | 78 | if start_line == -1: 79 | return raw_text 80 | 81 | return "\n".join(lines[start_line:]) 82 | 83 | 84 | def output_content(topic, format, content): 85 | if format == "md": 86 | write(f"{topic}.md", content) 87 | elif format == "pdf": 88 | generate_pdf(topic, content) 89 | else: 90 | print(f"Invalid format({format}). Please choose either 'md' or 'pdf'.") 91 | 92 | 93 | def send_mail(topic: str, receivers: List[str], content: str): 94 | html = markdown.markdown(content) 95 | resend.api_key = os.getenv("RESEND_API_KEY") 96 | email_from = os.getenv("EMAIL_FROM") 97 | resend.Emails.send( 98 | { 99 | "from": email_from, 100 | "to": receivers, 101 | "subject": topic, 102 | "html": html, 103 | } 104 | ) 105 | 106 | 107 | def search_topic( 108 | topic: str, num_results=10, visited_links: List[str] = [] 109 | ) -> List[dict]: 110 | results: dict = { 111 | "links": [], 112 | "articles": [], 113 | } 114 | result = search(topic, num_results=num_results, unique=True, sleep_interval=1) 115 | for link in result: 116 | if link in visited_links: 117 | print(f"Skipping already visited link: {link}") 118 | continue 119 | 120 | print(f"Fetching content from {link}") 121 | content = fetch_content_as_md(link) 122 | if content: 123 | results["links"].append(link) 124 | results["articles"].append(content) 125 | return results 126 | 127 | 128 | def fetch_content_as_md(url: str) -> str | None: 129 | try: 130 | if url.startswith("https://www.youtube.com/watch?v="): 131 | video_id = url.split("v=")[1] 132 | content = extract_text_from_youtube(video_id) 133 | return md(content) 134 | 135 | r = requests.get(url, timeout=5, headers={"User-Agent": "Mozilla/5.0"}) 136 | if r.status_code != 200: 137 | print(f"Failed to fetch content from {url}") 138 | return None 139 | 140 | content_type: str = ( 141 | r.headers["content-type"].lower() if "content-type" in r.headers else "" 142 | ) 143 | content = "" 144 | if "text/html" in content_type: 145 | content = r.text 146 | elif "application/pdf" in content_type: 147 | download(url, filename(url)) 148 | content = extract_text_from_pdf(f"{output_dir}/{filename(url)}") 149 | else: 150 | print(f"Unsupported content type: {content_type} for url: {url}") 151 | return None 152 | 153 | return md(content) 154 | except Exception: 155 | print(f"Failed to fetch content from {url}") 156 | 157 | 158 | def truncate_prompt(prompt: str, max_tokens: int, truncator) -> str: 159 | if len(prompt) > max_tokens: 160 | prompt = truncator(prompt, max_tokens) 161 | return prompt 162 | 163 | 164 | def get_block_body(text: str) -> str: 165 | # Remove the first and last lines for ``` blocks in markdown ``` 166 | if text.startswith("```") and text.endswith("```"): 167 | return "\n".join(text.split("\n")[1:-1]) 168 | return text 169 | -------------------------------------------------------------------------------- /agent/think.py: -------------------------------------------------------------------------------- 1 | import json 2 | import time 3 | from textwrap import dedent 4 | from typing import List, Literal 5 | 6 | from agno.agent import Agent 7 | from agno.models.google import Gemini 8 | from pydantic import BaseModel, Field 9 | 10 | from agent.settings import GEMINI_MODEL_ID 11 | from lib.utils import fetch_content_as_md, get_block_body, output_content, send_mail 12 | 13 | question_history: List[str] = [] 14 | thinking_history: List[str] = [] 15 | 16 | modes = { 17 | "critical": { 18 | "reader": dedent("""\ 19 | You're a reader with great insight and critical thinking. 20 | You will be given an article, the question history and answer history. 21 | You must ask 5 questions based on the given information, remember don't repeat the same or similar questions. 22 | each question should be clear and concise. 23 | output questions only, no explanation or unnecessary information.\ 24 | """), 25 | "writer": dedent("""\ 26 | You're the writer of a given article. 27 | You are responsible for answering the questions about your article. 28 | You must be objective and support your answers with evidence. 29 | Try to understand why the questions are being asked. 30 | If you find the questions are helpful to fix your article, then you're on the right track. 31 | """), 32 | }, 33 | "faq": { 34 | "reader": dedent("""\ 35 | You're a reader trying to understand the aticle and learn more about it. 36 | You will be given an article, the question history and answer history. 37 | You must ask 5 questions based on the given information, remember don't repeat the same or similar questions. 38 | each question should be clear and concise. 39 | output questions only, no explanation or unnecessary information.\ 40 | """), 41 | "writer": dedent("""\ 42 | You're the writer of a given article. 43 | You are responsible for answering the questions about your article. 44 | Try to help the reader understand the article better.\ 45 | """), 46 | }, 47 | # "creative": {}, 48 | # "strategic": {}, 49 | } 50 | 51 | 52 | class Config(BaseModel): 53 | link: str = Field(description="Link to think about") 54 | mode: Literal["critical", "faq"] = Field( 55 | default=["critical"], description="thinking mode" 56 | ) 57 | loops: int = Field(default=5, description="Loops for the thinking") 58 | lang: str = Field(default="english", description="Language for the report") 59 | receivers: List[str] | None = Field( 60 | default=None, description="List of email receivers" 61 | ) 62 | format: Literal["md", "pdf"] = Field( 63 | default="md", description="Output format of the report" 64 | ) 65 | 66 | 67 | def ask_questions(article: str, config: Config, max_length: int) -> str: 68 | reader = Agent( 69 | name="Reader Agent", 70 | model=Gemini(id=GEMINI_MODEL_ID), 71 | description=modes[config.mode]["reader"], 72 | instructions=[ 73 | f"the whole content should be less than {max_length} characters.", 74 | f"the output language: {config.lang}.", 75 | ], 76 | markdown=True, 77 | ) 78 | prompt: str = ( 79 | f"Article:\n{article}\nAsked Questions:\n{question_history}\nAnswers to Questions:\n{thinking_history}" 80 | if question_history 81 | else f"Article:\n{article}" 82 | ) 83 | questions = reader.run(prompt).content 84 | question_history.append(questions) 85 | return questions 86 | 87 | 88 | def answer_questions( 89 | article: str, question: str, config: Config, max_length: int 90 | ) -> str: 91 | writer = Agent( 92 | name="writer Agent", 93 | model=Gemini(id=GEMINI_MODEL_ID), 94 | description=modes[config.mode]["writer"], 95 | instructions=[ 96 | f"the whole content should be less than {max_length} characters.", 97 | f"the output language: {config.lang}.", 98 | ], 99 | markdown=True, 100 | ) 101 | prompt: str = f"Article:\n{article}\nQuestions:\n{question}" 102 | answers = writer.run(prompt).content 103 | thinking_history.append(answers) 104 | return answers 105 | 106 | 107 | def output_thinking() -> str: 108 | return "\n".join( 109 | [ 110 | f"## Question:\n\n {question}\n\n## Answer: \n\n{answer}" 111 | for question, answer in zip(question_history, thinking_history) 112 | ] 113 | ) 114 | 115 | 116 | def format_thinking(content: str, config: Config) -> str: 117 | formatter = Agent( 118 | name="formatter Agent", 119 | model=Gemini(id=GEMINI_MODEL_ID), 120 | description="You are a excellent formatter.", 121 | instructions=[ 122 | "you will be given a document with questions and answers, please format it properly:", 123 | "1. keep each question and answer pair in a separate section with correct numbering.", 124 | "2. the meaning of questions and answers should not be changed.", 125 | f"3. the document should be written in {config.lang}, translate the content if necessary but ignore the code and the abbreviations", 126 | "4. only the formatted document, no additional information.", 127 | ], 128 | markdown=True, 129 | ) 130 | return formatter.run(content).content 131 | 132 | 133 | def load_config(config: str) -> Config: 134 | with open(config, "r") as file: 135 | json_data = json.load(file) 136 | return Config.model_validate(json_data) 137 | 138 | 139 | def deep_think(config: str): 140 | c = load_config(config) 141 | link = c.link 142 | article = fetch_content_as_md(link) 143 | if not article: 144 | print(f"Failed to fetch the content from {link}, exiting.") 145 | return 146 | 147 | for i in range(c.loops): 148 | print(f"Thinking Loop {i + 1} ---------------->") 149 | questions = ask_questions(article, c, 300) 150 | if not questions: 151 | print("No more questions, exiting.") 152 | break 153 | 154 | answers = answer_questions(article, questions, c, 600) 155 | 156 | print("Outputing ------------------>") 157 | if not questions or not answers: 158 | print("No questions or answers to output, exiting.") 159 | return 160 | 161 | content = output_thinking() 162 | 163 | print("Formatting ------------------>") 164 | content = get_block_body(format_thinking(content, c)) 165 | content = f"# Thinking(Mode: {c.mode}) on {link}\n\n{content}" 166 | topic = f"{c.mode}{int(time.time())}" 167 | output_content(topic, c.format, content) 168 | if c.receivers: 169 | send_mail(topic, c.receivers, content) 170 | -------------------------------------------------------------------------------- /agent/research.py: -------------------------------------------------------------------------------- 1 | # Reference: https://github.com/dzhng/deep-research 2 | 3 | import json 4 | import time 5 | from textwrap import dedent 6 | from typing import List, Literal 7 | 8 | from agno.agent import Agent 9 | from agno.models.google import Gemini 10 | from agno.models.groq import Groq 11 | from pydantic import BaseModel, Field 12 | 13 | from agent.settings import GEMINI_MODEL_ID, GROQ_MODEL_ID 14 | from lib.utils import get_block_body, output_content, search_topic, send_mail 15 | 16 | learnings: List[str] = [] 17 | insights: List[str] = [] 18 | generated_queries: List[str] = [] 19 | references: List[str] = [] 20 | 21 | system_prompt = dedent("""\ 22 | You are an expert researcher. Follow these instructions when responding: 23 | - You may be asked to research subjects that is after your knowledge cutoff, assume the user is right when presented with news. 24 | - The user is a highly experienced analyst, no need to simplify it, be as detailed as possible and make sure your response is correct. 25 | - Be highly organized. 26 | - Suggest solutions that I didn't think about. 27 | - Be proactive and anticipate my needs. 28 | - Treat me as an expert in all subject matter. 29 | - Mistakes erode my trust, so be accurate and thorough. 30 | - Provide detailed explanations, I'm comfortable with lots of detail. 31 | - Value good arguments over authorities, the source is irrelevant. 32 | - Consider new technologies and contrarian ideas, not just the conventional wisdom. 33 | - You may use high levels of speculation or prediction, just flag it for me.\ 34 | """) 35 | 36 | 37 | class Config(BaseModel): 38 | topic: str = Field(description="Research topic") 39 | hints: list[str] = Field(default=[], description="hints for the task") 40 | depth: int = Field(default=2, description="Depth of the research") 41 | breadth: int = Field(default=1, description="Breadth of the research") 42 | lang: str = Field(default="english", description="Language for the report") 43 | receivers: List[str] | None = Field( 44 | default=None, description="List of email receivers" 45 | ) 46 | format: Literal["md", "pdf"] = Field( 47 | default="md", description="Output format of the report" 48 | ) 49 | 50 | 51 | def summary_learnings(topic: str, max_length: int): 52 | if not learnings: 53 | return "" 54 | 55 | print("-------summarizing learning-------------->") 56 | all_learnings = "\n".join(learnings) 57 | reader = Agent( 58 | name="Reader Agent", 59 | model=Gemini(id=GEMINI_MODEL_ID), 60 | description="you are an insightful reader and can extract the key points from the text.", 61 | instructions=[ 62 | "extract the key points related to the topic from the given text.", 63 | "don't include the irrelevant information.", 64 | "don't miss any important points.", 65 | f"the maximum length of the summary is {max_length} characters.", 66 | ], 67 | ) 68 | insights.append(reader.run(f"Topic:\n{topic}\nLearnings:\n{all_learnings}").content) 69 | learnings.clear() 70 | 71 | 72 | def plan_research(topic: str, hints: List[str] = []) -> str: 73 | planner = Agent( 74 | name="Planner Agent", 75 | model=Groq(id=GROQ_MODEL_ID, temperature=0), 76 | description=system_prompt, 77 | instructions=[ 78 | "you will be given a research topic and some hints, generate a google search query based on them.", 79 | "you will also be given the history of previous queries and what you have learnt.", 80 | "don't repeat the same or similar queries, try to generate new ones.", 81 | "use what you have learnt to inspire you to generate new queries.", 82 | "the generated query should be relevant to the topic and the hints, it can be creative but shouldn't be off-topic.", 83 | "the generated query should be several keywords for a google search.", 84 | "only return the generated query, no other information or explanation.", 85 | ], 86 | ) 87 | try: 88 | goal: str = ( 89 | f"Research Topic:\n{topic}\nWhat I have learnt:\n{','.join(insights)}" 90 | if insights 91 | else f"Research Topic:\n{topic}" 92 | ) 93 | h: str = f"\nHints:\n{','.join(hints)}" if hints else "" 94 | history: str = ( 95 | f"\nOld Query Keywords:\n{','.join(generated_queries)}" 96 | if generated_queries 97 | else "" 98 | ) 99 | result = planner.run(f"{goal}{h}{history}").content 100 | generated_queries.append(result) 101 | except Exception as e: 102 | print(e) 103 | result = "" 104 | return result 105 | 106 | 107 | def read_articles(topic: str, articles: List[str], max_length: int): 108 | analyst = Agent( 109 | name="Analyst Agent", 110 | model=Gemini(id=GEMINI_MODEL_ID), 111 | description=system_prompt, 112 | instructions=[ 113 | "learn the information related to the research topic in the articles.", 114 | "include the citations which are relevant to the topic.", 115 | "ignore the unrelated information.", 116 | "generate a mid-report based on the gathered information.", 117 | f"the report should be clear and concise, the whole content should be less than {max_length} characters.", 118 | ], 119 | markdown=True, 120 | ) 121 | for article in articles: 122 | print("---Reading article-------------->") 123 | learnings.append(analyst.run(f"Topic:\n{topic}\nArticles:\n{article}").content) 124 | time.sleep(5) 125 | 126 | 127 | def write_final_report(topic: str, lang: str) -> str: 128 | researcher = Agent( 129 | name="Researcher Agent", 130 | model=Gemini(id=GEMINI_MODEL_ID), 131 | description=system_prompt, 132 | instructions=[ 133 | "generate a professional research report based on the topic and what you have learnt.", 134 | "the report reader is an expert, so no need to simplify it.", 135 | f"Write the report in language: {lang}.", 136 | ], 137 | expected_output=dedent("""\ 138 | A professional research report in markdown format: 139 | 140 | # {Compelling Title That Captures the Topic's Essence} 141 | 142 | ## Summary 143 | {Brief overview of key findings and significance} 144 | 145 | ## Introduction 146 | {A brief introduction to the topic and the purpose of the report} 147 | {Background information on the topic and explain how the research was conducted} 148 | 149 | 150 | ## Subtopic 151 | {Key findings and analysis on the subtopic} 152 | 153 | ### Suggested Actions 154 | {Possible actions or recommendations} 155 | {Risks and challenges} 156 | 157 | 158 | ## Insights 159 | {Key insights and conclusions from the research} 160 | 161 | ## Conclusion 162 | {Summary of the generated content} 163 | {Highlight the key takeaways} 164 | 165 | ## References 166 | {List of sources, citations, and links} 167 | 168 | --- 169 | Report generated by TSW-X 170 | Advanced Research Systems Division 171 | Date: {current_date}\ 172 | """), 173 | show_tool_calls=True, 174 | markdown=True, 175 | add_datetime_to_instructions=True, 176 | ) 177 | return researcher.run( 178 | f"Topic:\n{topic}\nMy Learnings:\n{insights}\nReferences:\n{references}" 179 | ).content 180 | 181 | 182 | def load_config(config: str) -> Config: 183 | with open(config, "r") as file: 184 | json_data = json.load(file) 185 | return Config.model_validate(json_data) 186 | 187 | 188 | def start_research(config: str): 189 | c = load_config(config) 190 | topic = c.topic 191 | for i in range(c.depth): 192 | print(f"Researching Depth {i + 1} ---------------->") 193 | plan = plan_research(topic, c.hints) 194 | if not plan: 195 | print("No plan to search for, ignoring this depth.") 196 | continue 197 | print(f"Searching for: {plan}") 198 | results = search_topic(plan, c.breadth, references) 199 | references.extend(results["links"]) 200 | read_articles(topic, results["articles"], 500) 201 | summary_learnings(topic, 250) 202 | print("Generating Final Report ------------------>") 203 | if not insights: 204 | print("No insights to generate a report, exiting.") 205 | return 206 | report = get_block_body(write_final_report(topic, c.lang)) 207 | output_content(topic, c.format, report) 208 | if c.receivers: 209 | send_mail(topic, c.receivers, report) 210 | -------------------------------------------------------------------------------- /agent/summary.py: -------------------------------------------------------------------------------- 1 | import json 2 | import re 3 | from textwrap import dedent 4 | from typing import Literal 5 | 6 | from agno.agent import Agent, RunResponse 7 | from agno.models.google import Gemini 8 | from pydantic import BaseModel, Field 9 | 10 | from agent.settings import GEMINI_MODEL_ID 11 | from lib.utils import ( 12 | extract_text_from_pdf, 13 | extract_text_from_youtube, 14 | fetch_content_as_md, 15 | get_block_body, 16 | write, 17 | ) 18 | 19 | mindmapPrompt = """ 20 | Based on the given article: 21 | 1. try to summary and extra the key points for the diagram generation. 22 | 2. these key points must be informative and concise. 23 | 3. these key points should highlight the author's viewpoints. 24 | 4. try to keep the key points in a logical order. 25 | 5. don't include any extra explanation and irrelevant information. 26 | 27 | Use them to generate a Mindmap. 28 | Mindmap syntax rules: 29 | - Each line should not have any quotes marks 30 | - Do not include 'mermaid' at the start of the diagram 31 | - Do not use 3-nesting parentheses for root, ie: "root((Mixture of Experts (MoE)))". The correct is "root((MoE))" 32 | - Do not use abbreviations with parentheses in the middle of a line, but it can be used at the end of a line 33 | - Do not use any special characters in the diagram except emojis 34 | - Keep function name without parameters when you are reading a programming article, ie: free, not free() 35 | - Can only have one root node, ie no other node can be at the same level as the root node. 36 | - Basic structure example: 37 | 38 | mindmap 39 | Root 40 | A 41 | B 42 | C 43 | 44 | Each node in the mindmap can be different shapes: 45 | 46 | id[I am a square] 47 | 48 | id(I am a rounded square) 49 | 50 | id((I am a circle)) 51 | 52 | id))I am a bang(( 53 | 54 | id)I am a cloud( 55 | 56 | id{{I am a hexagon}} 57 | 58 | I am the default shape 59 | 60 | Icons can be used in the mindmap with syntax: "::icon()" 61 | 62 | Markdown string can be used like the following: 63 | 64 | mindmap 65 | id1["`**Root** with 66 | a second line 67 | Unicode works too: 🤓`"] 68 | id2["`The dog in **the** hog... a *very long text* that wraps to a new line`"] 69 | id3[Regular labels still works] 70 | 71 | Here is a mindmap example: 72 | 73 | mindmap 74 | root((mindmap)) 75 | Origins 76 | Long history 77 | ::icon(fa fa-book) 78 | Popularisation 79 | British popular psychology author Tony Buzan 80 | Research 81 | On effectiveness
and features 82 | On Automatic creation 83 | Uses 84 | Creative techniques 85 | Strategic planning 86 | Argument mapping 87 | Tools 88 | Pen and paper 89 | Mermaid 90 | 91 | The max depth of the generated mindmap should be 3. 92 | 93 | The output syntax should be correct. Try to avoid the following common errors: 94 | - never use " in the output 95 | - ```mermaid in the output 96 | 97 | - Gating network (G) decides experts (E) 98 | - fixed: Gating network decides experts 99 | - root((Mixture of Experts (MoE))) 100 | - fixed: root((MoE)) 101 | - 2017: Shazeer et al. (Google) - 137B LSTM 102 | - fixed: 2017: Shazeer et al. Google 137B LSTM 103 | - calloc() 104 | - fixed: calloc 105 | - sbrk(0) returns current break 106 | - fixed: sbrk:0 returns current break 107 | - Allocate N + sizeof(header_t) bytes 108 | - fixed: Allocate N + sizeof header_t bytes 109 | 110 | Review the output to ensure it is logical and follows the correct syntax, if not, correct it. 111 | """ 112 | 113 | 114 | class SourceConfig(BaseModel): 115 | source: str = Field(description="Source to be summarized") 116 | source_type: Literal["pdf", "youtube", "url"] = Field( 117 | default="pdf", description="Type of the source" 118 | ) 119 | 120 | 121 | class Config(BaseModel): 122 | sources: list[SourceConfig] = Field(description="List of sources to be summarized") 123 | type: Literal["mindmap", "text", "both"] = Field( 124 | default="both", description="Type of summary" 125 | ) 126 | output_file: str = Field(description="Output filename") 127 | 128 | 129 | def load_config(config: str) -> Config: 130 | with open(config, "r") as file: 131 | json_data = json.load(file) 132 | return Config.model_validate(json_data) 133 | 134 | 135 | mindmap_agent = Agent( 136 | name="Mindmap Agent", 137 | model=Gemini(id=GEMINI_MODEL_ID), 138 | description="You are an MermaidJS diagram generator. You can generate stunning MermaidJS diagram codes.", 139 | instructions=mindmapPrompt, 140 | markdown=False, 141 | ) 142 | 143 | summary_agent = Agent( 144 | name="Summary Agent", 145 | model=Gemini(id=GEMINI_MODEL_ID), 146 | description="You are a good paper reader and need to explain what you have read to others.", 147 | instructions=[ 148 | "1. find the main points of the document.", 149 | "2. for each main point, provide a informative summary and explain the implementation if needed.", 150 | "3. for each complex concept, provide a brief explanation.", 151 | "4. make the whole summary readable and engaging.", 152 | ], 153 | expected_output=dedent("""\ 154 | A concise summary in markdown format: 155 | 156 | # {A Title That Captures the Essence of the Text} 157 | 158 | ## Summary 159 | {Brief overview of key findings and significance} 160 | 161 | ## Terminology 162 | - {Term 1}: {Definition} 163 | - {Term 2}: {Definition} 164 | 165 | ## Main Points 166 | ### Point 1 167 | {Main point 1} 168 | {Explanation or implementation} 169 | 170 | ### Point 2 171 | {Main point 2} 172 | {Explanation or implementation} 173 | 174 | ## Improvements And Creativity 175 | {Main improvements and creativity in the text} 176 | 177 | ## Insights 178 | {Your insights on the text} 179 | {Your predictions or recommendations} 180 | 181 | ## References 182 | - [Source 1](link) - Link in given text 183 | - [Source 2](link) - Link in given text 184 | - [Source 3](link) - Link in given text 185 | 186 | --- 187 | Report generated by TSW-X 188 | Advanced Research Systems Division 189 | Date: {current_date}\ 190 | """), 191 | markdown=True, 192 | add_datetime_to_instructions=True, 193 | ) 194 | 195 | summary_team = Agent( 196 | name="Summary Team", 197 | model=Gemini(id=GEMINI_MODEL_ID), 198 | team=[mindmap_agent, summary_agent], 199 | instructions=[ 200 | "First, search hackernews for what the user is asking about.", 201 | "Then, ask the article reader to read the links for the stories to get more information.", 202 | "Important: you must provide the article reader with the links to read.", 203 | "Then, ask the web searcher to search for each story to get more information.", 204 | "Finally, provide a thoughtful and engaging summary.", 205 | ], 206 | show_tool_calls=True, 207 | markdown=True, 208 | ) 209 | 210 | 211 | def generate_summary(config: str): 212 | config = load_config(config) 213 | 214 | type = config.type 215 | if type not in ["mindmap", "text", "both"]: 216 | print(f"Summary type {type} not supported.") 217 | 218 | combined_text = "" 219 | 220 | for source_config in config.sources: 221 | source = source_config.source 222 | source_type = source_config.source_type 223 | 224 | if source_type not in ["pdf", "youtube", "url"]: 225 | print(f"Source type {source_type} not supported") 226 | return 227 | 228 | if source_type == "pdf": 229 | text = extract_text_from_pdf(source) 230 | elif source_type == "youtube": 231 | text = extract_text_from_youtube(source) 232 | elif source_type == "url": 233 | text = fetch_content_as_md(source) 234 | 235 | if text: 236 | combined_text += text + "\n\n" 237 | else: 238 | print(f"No text extracted from source: {source}") 239 | 240 | if not combined_text: 241 | print("No text extracted from any sources.") 242 | return 243 | 244 | output_name = config.output_file 245 | 246 | if type == "mindmap": 247 | mindmap = _generate_mindmap(combined_text) 248 | write(f"{output_name}.mm", f"```mermaid\n{mindmap}\n```") 249 | elif type == "text": 250 | summary = _generate_text(combined_text) 251 | write(f"{output_name}.md", summary) 252 | else: 253 | mindmap, summary = _generate_both(combined_text) 254 | lines = summary.split("\n") 255 | lines.insert(1, f"\n## Mindmap\n```mermaid\n{mindmap}\n```") 256 | summary = "\n".join(lines) 257 | write(f"{output_name}.md", summary) 258 | 259 | 260 | def _generate_mindmap(text: str) -> str: 261 | result: RunResponse = mindmap_agent.run(text) 262 | print("raw:\n", result.content) 263 | cleaned_result = _clean_text(result.content) 264 | print("cleaned:\n", cleaned_result) 265 | # image_link = generate_pako_link(cleaned_result) 266 | # print("visit link:\n", image_link) 267 | return cleaned_result 268 | 269 | 270 | def _generate_text(text: str) -> str: 271 | return get_block_body(summary_agent.run(text).content) 272 | 273 | 274 | def _generate_both(text: str) -> tuple: 275 | mindmap = _generate_mindmap(text) 276 | summary = _generate_text(text) 277 | return mindmap, summary 278 | 279 | 280 | def _clean_text(text: str): 281 | text = get_block_body(text) 282 | lines = [] 283 | for line in text.split("\n"): 284 | if "root((" in line: 285 | pattern = r"(\(\([^()]*?)\s+\([^()]*?\)(.*?\)\))" 286 | 287 | def replacer(match): 288 | return f"{match.group(1)}{match.group(2)}" 289 | 290 | line = re.sub(pattern, replacer, line) 291 | else: 292 | pattern = r"\s*\([^()]*?\)\s*(?=:|\w|\s)" 293 | line = re.sub(pattern, "", line) 294 | lines.append(line) 295 | 296 | mmMarkdown = "\n".join(lines) 297 | if not mmMarkdown.startswith("mindmap"): 298 | mmMarkdown = f"mindmap\n{mmMarkdown}" 299 | return mmMarkdown 300 | -------------------------------------------------------------------------------- /agent/code.py: -------------------------------------------------------------------------------- 1 | import json 2 | from os import path 3 | from textwrap import dedent 4 | from typing import List, Literal 5 | 6 | from agno.agent import Agent 7 | from agno.models.google import Gemini 8 | from pydantic import BaseModel, Field 9 | from repomix import RepomixConfig, RepoProcessor 10 | 11 | from agent.settings import GEMINI_MODEL_ID 12 | from lib.utils import clean_repomix_output, exist, read, write 13 | 14 | 15 | class Config(BaseModel): 16 | repo: str = Field(description="repo url") 17 | output: str = Field(description="repo mix output file path") 18 | report: str = Field(description="final report file path") 19 | ignore: List[str] = Field(description="ignore files") 20 | mode: Literal["explanation", "tutorial", "review"] = Field( 21 | description="mode", default="explanation" 22 | ) 23 | 24 | 25 | def load_config(config: str) -> Config: 26 | with open(config, "r") as file: 27 | json_data = json.load(file) 28 | return Config.model_validate(json_data) 29 | 30 | 31 | def pack_code_into_markdown(c: Config): 32 | repo_file = f"output/{c.output}" 33 | if not exist(repo_file): 34 | config = RepomixConfig() 35 | config.output.file_path = repo_file 36 | config.ignore.use_gitignore = True 37 | config.ignore.custom_patterns = c.ignore 38 | 39 | if path.isdir(c.repo): 40 | processor = RepoProcessor(directory=c.repo, config=config) 41 | else: 42 | processor = RepoProcessor(repo_url=c.repo, config=config) 43 | result = processor.process() 44 | print("--------------------") 45 | print("Packing code into a markdown file...") 46 | print("-------- Result ------------") 47 | print(f"Total files: {result.total_files}") 48 | print(f"Total characters: {result.total_chars}") 49 | print(f"Total tokens: {result.total_tokens}") 50 | print(f"Output saved to: {result.config.output.file_path}") 51 | print("-------- Result ------------") 52 | cleaned_output = clean_repomix_output(repo_file) 53 | write(c.output, cleaned_output) 54 | return cleaned_output 55 | return read(repo_file) 56 | 57 | 58 | code_explainer_agent = Agent( 59 | name="Code Agent: Explainer", 60 | model=Gemini(id=GEMINI_MODEL_ID), 61 | description=dedent("""\ 62 | You are a good coder and need to explain what you have written to others. 63 | - The reader is a highly experienced developer, so no need to explain basic concepts." 64 | - Don't do function by function explanation, focus on the classes and modules and how they interact. 65 | - If there are any functions or classes that are used in multiple places(at least 3 times), highlight them and explain them. 66 | - If there are any design patterns used, explain them. 67 | - If there are any algorithms used, explain them. 68 | - Ignore those helper functions or classes. 69 | - Your tasks are to help the reader can grasp the codebase quickly, then they can start working on it or use it. 70 | - Be highly organized.\ 71 | """), 72 | instructions=[ 73 | "You will be given a text including the whole repository code.", 74 | "Explain the purpose of the repo and the problem it solves.", 75 | "Organize the code into sections and explain each section.", 76 | "Each section includes a group of functions or classes that are related to each other.", 77 | "Find SQL or 3rd party API calls and explain them.", 78 | "Highlight any important dependencies or running instructions that the coder points out.", 79 | "Provide insights, design experiences and creativity.", 80 | ], 81 | expected_output=dedent("""\ 82 | A concise code explanation in markdown format: 83 | 84 | # {A Title That Captures the Essence of the Text} 85 | 86 | ## Summary 87 | {Brief overview of the codebase and the problem it solves} 88 | 89 | ## Modules 90 | - {Module 1}: {responsibility} 91 | - {Module 2}: {responsibility} 92 | 93 | ## Code Structure 94 | ### Section 1 95 | {Main purpose of the section} 96 | {Explanation of the functions or classes} 97 | {Important dependencies or running instructions} 98 | 99 | ### Section 2 100 | {Main purpose of the section} 101 | {Explanation of the functions or classes} 102 | {Important dependencies or running instructions} 103 | 104 | ## Db Schema 105 | {Explanation of the database schema} 106 | {Table 1}: {Description} 107 | {Table 2}: {Description} 108 | 109 | ## External API Calls 110 | - {API 1}: {Explanation} 111 | - {API 2}: {Explanation} 112 | 113 | ## Insights 114 | {Your insights on the text} 115 | {The design experiences of the codebase} 116 | {The creativity in the codebase} 117 | 118 | --- 119 | Report generated by TSW-X 120 | Advanced Research Systems Division 121 | Date: {current_date}\ 122 | """), 123 | markdown=False, 124 | add_datetime_to_instructions=True, 125 | ) 126 | 127 | 128 | code_teacher_agent = Agent( 129 | name="Code Agent: Teacher", 130 | model=Gemini(id=GEMINI_MODEL_ID), 131 | description=dedent("""\ 132 | You are a good coder and need to teach others how to use your code. 133 | - Other developers want to use your codebase in their projects, so you need to teach them. 134 | - The whole tutorial must inlcude code examples with explanation core concepts. 135 | - The reader is a beginner, so you need to explain basic concepts. 136 | - Be highly organized.\ 137 | """), 138 | instructions=[ 139 | "You will be given a text including the whole repository code.", 140 | "Explain the purpose of the repo and the problem it solves.", 141 | "Explain the main concepts or functions that the reader needs to know.", 142 | "Provide code examples and explain them.", 143 | "Don't include any deprecated code or functions.", 144 | ], 145 | expected_output=dedent("""\ 146 | A concise code explanation in markdown format: 147 | 148 | # {A Title That Captures the Essence of the Text} 149 | 150 | ## Summary 151 | {Brief overview of the codebase and the problem it solves} 152 | 153 | ## Main Concepts 154 | - {Concept 1}: {Explanation} 155 | - {Concept 2}: {Explanation} 156 | 157 | ## Installation 158 | {Installation instructions} 159 | {External dependencies or running environment prerequisites} 160 | 161 | ## Getting Started 162 | {An end-to-end example that show how to use the codebase} 163 | {Explanation of the example} 164 | 165 | ## Code Examples 166 | ### Example 1 167 | {problem solved by the example} 168 | {Code snippet} 169 | {Explanation of the code snippet} 170 | 171 | ### Example 2 172 | {problem solved by the example} 173 | {Code snippet} 174 | {Explanation of the code snippet} 175 | 176 | {The maximum number of examples is 10} 177 | {Each example should be unique and solve a different problem} 178 | {If you have more than 10 examples, group them into sections} 179 | {If you find there are no examples, you can stop here} 180 | 181 | ## Advanced Usage 182 | ### Exception Handling 183 | {Explanation of how to handle exceptions} 184 | {Code snippet} 185 | 186 | ### Performance Optimization 187 | {Explanation of how to optimize the code} 188 | {Code snippet} 189 | 190 | ### Security 191 | {Explanation of how to secure the code} 192 | {Code snippet} 193 | 194 | ### Customization 195 | {Explanation of how to customize the code} 196 | {Code snippet} 197 | 198 | ## Best Practices 199 | {Best practices for using the codebase} 200 | {Common pitfalls and how to avoid them} 201 | 202 | ## Conclusion 203 | {A brief conclusion of the tutorial} 204 | 205 | ## References 206 | {References to other useful resources} 207 | 208 | --- 209 | Report generated by TSW-X 210 | Advanced Research Systems Division 211 | Date: {current_date}\ 212 | """), 213 | markdown=False, 214 | add_datetime_to_instructions=True, 215 | ) 216 | 217 | code_reviewer_agent = Agent( 218 | name="Code Agent: Reviewer", 219 | model=Gemini(id=GEMINI_MODEL_ID), 220 | description=dedent("""\ 221 | You are a good code reviewer and keen to find bugs and potential issues in the code. 222 | - Don't include any linting issues or code style problems because there are tools for that. 223 | - Focus on duplicate code, performance issues, security vulnerabilities, and potential bugs. 224 | - If the code doesn't follow the best practices, point them out. 225 | - If the code doesn't follow the conventions of the language, point them out. 226 | - Be highly organized.\ 227 | """), 228 | instructions=[ 229 | "You will be given a text including the whole repository code.", 230 | "Review the code and find any potential issues.", 231 | ], 232 | expected_output=dedent("""\ 233 | A code review report in markdown format: 234 | 235 | # {Code Review Report for the Repository} 236 | 237 | ## Summary 238 | {Brief overview of main issues in the codebase} 239 | 240 | ## Duplicate Code 241 | 242 | ### {file_name 1} 243 | {Code 1}: {Explanation} 244 | 245 | ### {file_name 2} 246 | {Code 2}: {Explanation} 247 | 248 | ## Performance Issues 249 | 250 | ### {file_name 1} 251 | {Code 1}: {Explanation} 252 | 253 | ### {file_name 2} 254 | {Code 2}: {Explanation} 255 | 256 | ## Security Vulnerabilities 257 | 258 | ### {file_name 1} 259 | {Code 1}: {Explanation} 260 | 261 | ### {file_name 2} 262 | {Code 2}: {Explanation} 263 | 264 | ## Potential Bugs 265 | 266 | ### {file_name 1} 267 | {Code 1}: {Explanation} 268 | 269 | ### {file_name 2} 270 | {Code 2}: {Explanation} 271 | 272 | ## Best Practices or Language Conventions 273 | 274 | ### {file_name 1} 275 | {Code 1}: {Explanation} 276 | 277 | ### {file_name 2} 278 | {Code 2}: {Explanation} 279 | 280 | ## Conclusion 281 | {A brief conclusion of the review} 282 | {The overall quality of the codebase} 283 | {The potential improvements that can be made} 284 | {The Recommendations for the developer} 285 | --- 286 | Report generated by TSW-X 287 | Advanced Research Systems Division 288 | Date: {current_date}\ 289 | """), 290 | markdown=False, 291 | add_datetime_to_instructions=True, 292 | ) 293 | 294 | 295 | def pack_repo(config: str): 296 | c = load_config(config) 297 | pack_code_into_markdown(c) 298 | 299 | 300 | def explain_repo(config: str): 301 | c = load_config(config) 302 | code_for_agent = pack_code_into_markdown(c) 303 | 304 | if c.mode == "explanation": 305 | print("Explaining code...") 306 | write(c.report, code_explainer_agent.run(code_for_agent).content) 307 | elif c.mode == "tutorial": 308 | print("Generating tutorial...") 309 | write(c.report, code_teacher_agent.run(code_for_agent).content) 310 | elif c.mode == "review": 311 | print("Reviewing code...") 312 | write(c.report, code_reviewer_agent.run(code_for_agent).content) 313 | else: 314 | print("Invalid mode. Please choose either 'explanation' or 'tutorial'.") 315 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 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 | 635 | Copyright (C) 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 . 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 | Copyright (C) 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 | . 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 | . 675 | --------------------------------------------------------------------------------