recent-state-summarizer 0.0.1__tar.gz

recent-state-summarizer-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 nikkie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

recent-state-summarizer-0.0.1/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: recent-state-summarizer
+Version: 0.0.1
+Summary: Summarize a list of entry titles using LLM
+Author-email: nikkie <takuyafjp+develop@gmail.com>
+License: MIT
+Classifier: Development Status :: 1 - Planning
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: testing
+Provides-Extra: lint
+Provides-Extra: dev
+License-File: LICENSE
+
+# recent-state-summarizer
+
+Summarize blog article titles with the OpenAI API
+
+a.k.a. _RSS_ 😃
+
+## Setup
+
+```
+$ pip install recent-state-summarizer
+```
+
+⚠️ Set `OPENAI_API_KEY` environment variable.  
+ref: https://platform.openai.com/account/api-keys
+
+## Usage
+
+```
+$ omae-douyo https://nikkie-ftnext.hatenablog.com/archive/2023/4
+
+この人物は最近、プログラミングに関することを中心にして活動しています。
+
+（略）
+
+最近は、株式会社はてなに入社したようです。
+```
+
+Currently support:
+
+- はてなブログ（Hatena blog）
+
+To see help, type `omae-douyo -h`.
+
+## Development
+
+### Sub commands
+
+Fetch only:
+
+```
+python -m recent_state_summarizer.fetch -h
+```
+
+Summarize only:  
+It's convenient to omit fetching in tuning the prompt.
+
+```
+python -m recent_state_summarizer.summarize -h
+```
+
+### Environment
+
+```
+$ git clone https://github.com/ftnext/recent-state-summarizer.git
+$ cd recent-state-summarizer
+
+$ python -m venv venv
+$ source venv/bin/activate
+(venv) $ pip install -r requirements.lock
+(venv) $ pip install -e '.'
+```

recent-state-summarizer-0.0.1/README.md

@@ -0,0 +1,61 @@
+# recent-state-summarizer
+
+Summarize blog article titles with the OpenAI API
+
+a.k.a. _RSS_ 😃
+
+## Setup
+
+```
+$ pip install recent-state-summarizer
+```
+
+⚠️ Set `OPENAI_API_KEY` environment variable.  
+ref: https://platform.openai.com/account/api-keys
+
+## Usage
+
+```
+$ omae-douyo https://nikkie-ftnext.hatenablog.com/archive/2023/4
+
+この人物は最近、プログラミングに関することを中心にして活動しています。
+
+（略）
+
+最近は、株式会社はてなに入社したようです。
+```
+
+Currently support:
+
+- はてなブログ（Hatena blog）
+
+To see help, type `omae-douyo -h`.
+
+## Development
+
+### Sub commands
+
+Fetch only:
+
+```
+python -m recent_state_summarizer.fetch -h
+```
+
+Summarize only:  
+It's convenient to omit fetching in tuning the prompt.
+
+```
+python -m recent_state_summarizer.summarize -h
+```
+
+### Environment
+
+```
+$ git clone https://github.com/ftnext/recent-state-summarizer.git
+$ cd recent-state-summarizer
+
+$ python -m venv venv
+$ source venv/bin/activate
+(venv) $ pip install -r requirements.lock
+(venv) $ pip install -e '.'
+```

recent-state-summarizer-0.0.1/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "recent-state-summarizer"
+authors = [
+    {name = "nikkie", email = "takuyafjp+develop@gmail.com"},
+]
+description = "Summarize a list of entry titles using LLM"
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.8"
+license = {text = "MIT"}
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+    "beautifulsoup4",
+    "openai",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+testing = ["pytest"]
+lint = ["flake8", "black", "isort"]
+dev = ["wheel", "build", "twine"]
+
+[project.scripts]
+omae-douyo = "recent_state_summarizer.__main__:main"
+
+[tool.setuptools.packages.find]
+exclude = ["tests"]
+
+[tool.setuptools.dynamic]
+version = {attr = "recent_state_summarizer.__version__"}

recent-state-summarizer-0.0.1/recent_state_summarizer/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

recent-state-summarizer-0.0.1/recent_state_summarizer/__main__.py

@@ -0,0 +1,36 @@
+import argparse
+from textwrap import dedent
+
+from recent_state_summarizer.fetch import fetch_titles_as_bullet_list
+from recent_state_summarizer.summarize import summarize_titles
+
+
+def parse_args():
+    help_message = """
+    Summarize blog article titles with the OpenAI API.
+
+    ⚠️ Set `OPENAI_API_KEY` environment variable.
+
+    Example:
+        omae-douyo https://awesome.hatenablog.com/archive/2023
+
+    Retrieve the titles of articles from a specified URL.
+    After summarization, prints the summary.
+
+    Support:
+        - はてなブログ（Hatena blog）
+    """
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description=dedent(help_message),
+    )
+    parser.add_argument("url", help="URL of archive page")
+    return parser.parse_args()
+
+
+def main():
+    args = parse_args()
+
+    titles = fetch_titles_as_bullet_list(args.url)
+    summary = summarize_titles(titles)
+    print(summary)

recent-state-summarizer-0.0.1/recent_state_summarizer/fetch.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+from collections.abc import Generator, Iterable
+from pathlib import Path
+from urllib.request import urlopen
+
+from bs4 import BeautifulSoup
+
+PARSE_HATENABLOG_KWARGS = {"name": "a", "attrs": {"class": "entry-title-link"}}
+
+
+def _main(url: str, save_path: str | Path) -> None:
+    contents = fetch_titles_as_bullet_list(url)
+    _save(save_path, contents)
+
+
+def fetch_titles_as_bullet_list(url: str) -> str:
+    return _as_bullet_list(_fetch_titles(url))
+
+
+def _fetch_titles(url: str) -> Generator[str, None, None]:
+    raw_html = _fetch(url)
+    yield from _parse_titles(raw_html)
+
+
+def _fetch(url: str) -> str:
+    with urlopen(url) as res:
+        return res.read()
+
+
+def _parse_titles(raw_html: str) -> Generator[str, None, None]:
+    soup = BeautifulSoup(raw_html, "html.parser")
+    body = soup.body
+    title_tags = body.find_all(**PARSE_HATENABLOG_KWARGS)
+    for title_tag in title_tags:
+        yield title_tag.text
+
+
+def _as_bullet_list(titles: Iterable[str]) -> str:
+    return "\n".join(f"- {title}" for title in titles)
+
+
+def _save(path: str | Path, contents: str) -> None:
+    with open(path, "w", encoding="utf8", newline="") as f:
+        f.write(contents)
+
+
+if __name__ == "__main__":
+    import argparse
+    import textwrap
+
+    help_message = """
+    Retrieve the titles of articles from a specified URL page
+    and save them as a list.
+
+    Support:
+        - はてなブログ（Hatena blog）
+
+    Example:
+        python -m recent_state_summarizer.fetch \\
+          https://awesome.hatenablog.com/archive/2023 awesome_titles.txt
+    """
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description=textwrap.dedent(help_message),
+    )
+    parser.add_argument("url", help="URL of archive page")
+    parser.add_argument("save_path", help="Local file path")
+    args = parser.parse_args()
+
+    _main(args.url, args.save_path)

recent-state-summarizer-0.0.1/recent_state_summarizer/summarize.py

@@ -0,0 +1,74 @@
+from pathlib import Path
+
+import openai
+
+MODEL = "gpt-3.5-turbo"
+
+
+def _main(titles_path: str | Path) -> str:
+    titles = _read_titles(titles_path)
+    return summarize_titles(titles)
+
+
+def summarize_titles(titles: str) -> str:
+    prompts = _build_prompts(titles)
+    response = _complete_chat(prompts)
+    return _parse_response(response)
+
+
+def _build_prompts(titles: str):
+    prompts = [
+        {"role": "user", "content": _build_summarize_prompt_text(titles)}
+    ]
+    return prompts
+
+
+def _build_summarize_prompt_text(titles_as_list: str) -> str:
+    return f"""\
+以下は同一人物が最近書いたブログ記事のタイトルの一覧です。
+それを読み、この人物が最近何をやっているかを詳しく教えてください。
+応答は文ごとに改行して区切ってください。
+
+{titles_as_list}
+"""
+
+
+def _complete_chat(prompts):
+    return openai.ChatCompletion.create(
+        model=MODEL, messages=prompts, temperature=0.8
+    )
+
+
+def _parse_response(response) -> str:
+    return response["choices"][0]["message"]["content"]
+
+
+def _read_titles(titles_path: str | Path) -> str:
+    with open(titles_path, encoding="utf8", newline="") as f:
+        return f.read()
+
+
+if __name__ == "__main__":
+    import argparse
+    import textwrap
+
+    help_message = f"""
+    Summarize a list of blog article titles using the OpenAI API ({MODEL}).
+    This command prints the summary.
+
+    ⚠️ Set `OPENAI_API_KEY` environment variable.
+
+    Example:
+        python -m recent_state_summarizer.summarize awesome_titles.txt
+    """
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description=textwrap.dedent(help_message),
+    )
+    parser.add_argument(
+        "titles_path",
+        help="Local file path where the list of titles is saved",
+    )
+    args = parser.parse_args()
+
+    print(_main(args.titles_path))

recent-state-summarizer-0.0.1/recent_state_summarizer.egg-info/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: recent-state-summarizer
+Version: 0.0.1
+Summary: Summarize a list of entry titles using LLM
+Author-email: nikkie <takuyafjp+develop@gmail.com>
+License: MIT
+Classifier: Development Status :: 1 - Planning
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: testing
+Provides-Extra: lint
+Provides-Extra: dev
+License-File: LICENSE
+
+# recent-state-summarizer
+
+Summarize blog article titles with the OpenAI API
+
+a.k.a. _RSS_ 😃
+
+## Setup
+
+```
+$ pip install recent-state-summarizer
+```
+
+⚠️ Set `OPENAI_API_KEY` environment variable.  
+ref: https://platform.openai.com/account/api-keys
+
+## Usage
+
+```
+$ omae-douyo https://nikkie-ftnext.hatenablog.com/archive/2023/4
+
+この人物は最近、プログラミングに関することを中心にして活動しています。
+
+（略）
+
+最近は、株式会社はてなに入社したようです。
+```
+
+Currently support:
+
+- はてなブログ（Hatena blog）
+
+To see help, type `omae-douyo -h`.
+
+## Development
+
+### Sub commands
+
+Fetch only:
+
+```
+python -m recent_state_summarizer.fetch -h
+```
+
+Summarize only:  
+It's convenient to omit fetching in tuning the prompt.
+
+```
+python -m recent_state_summarizer.summarize -h
+```
+
+### Environment
+
+```
+$ git clone https://github.com/ftnext/recent-state-summarizer.git
+$ cd recent-state-summarizer
+
+$ python -m venv venv
+$ source venv/bin/activate
+(venv) $ pip install -r requirements.lock
+(venv) $ pip install -e '.'
+```

recent-state-summarizer-0.0.1/recent_state_summarizer.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+recent_state_summarizer/__init__.py
+recent_state_summarizer/__main__.py
+recent_state_summarizer/fetch.py
+recent_state_summarizer/summarize.py
+recent_state_summarizer.egg-info/PKG-INFO
+recent_state_summarizer.egg-info/SOURCES.txt
+recent_state_summarizer.egg-info/dependency_links.txt
+recent_state_summarizer.egg-info/entry_points.txt
+recent_state_summarizer.egg-info/requires.txt
+recent_state_summarizer.egg-info/top_level.txt

recent-state-summarizer-0.0.1/recent_state_summarizer.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

recent-state-summarizer-0.0.1/recent_state_summarizer.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+omae-douyo = recent_state_summarizer.__main__:main

recent-state-summarizer-0.0.1/recent_state_summarizer.egg-info/requires.txt

@@ -0,0 +1,15 @@
+beautifulsoup4
+openai
+
+[dev]
+wheel
+build
+twine
+
+[lint]
+flake8
+black
+isort
+
+[testing]
+pytest

recent-state-summarizer-0.0.1/recent_state_summarizer.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+build
+dist
+recent_state_summarizer

recent-state-summarizer-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

recent-state-summarizer-0.0.1/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()