AtCoderStudyBooster 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

atcoderstudybooster-0.4.2.dist-info/METADATA

@@ -0,0 +1,249 @@
+Metadata-Version: 2.3
+Name: AtCoderStudyBooster
+Version: 0.4.2
+Summary: A tool to download and manage AtCoder problems.
+Project-URL: Homepage, https://github.com/yuta6/AtCoderStudyBooster
+Author-email: yuta6 <46110512+yuta6@users.noreply.github.com>
+License: MIT
+Requires-Python: >=3.8
+Requires-Dist: beautifulsoup4
+Requires-Dist: click-aliases>=1.0.5
+Requires-Dist: markdownify==0.13.1
+Requires-Dist: openai>=1.99.6
+Requires-Dist: pywebview>=5.4
+Requires-Dist: questionary>=2.0.1
+Requires-Dist: requests
+Requires-Dist: rich-click>=1.8.8
+Requires-Dist: rich>=13.7.1
+Requires-Dist: tiktoken
+Requires-Dist: types-beautifulsoup4>=4.12.0.20240511
+Requires-Dist: types-requests>=2.32.0.20240712
+Description-Content-Type: text/markdown
+
+# AtCoderStudyBooster
+
+[日本語版 README はこちら](README.ja.md)
+
+## Overview
+
+🚧 This project is still in experimental stage. We are continuously adding features to help with daily AtCoder practice.
+
+![demo image](./.images/demo0.gif)
+
+AtCoderStudyBooster is a CLI tool designed to accelerate your AtCoder learning journey. It supports downloading problems locally, testing, submitting, and generating solutions. Python installation is required. If you have Python installed, you can install this tool with:
+
+```sh
+pip install AtCoderStudyBooster
+```
+
+(Python 3.8 or higher is required)
+
+Even after CAPTCHA authentication was introduced, you can still login and submit semi-automatically from CLI. However, you need to manually solve the CAPTCHA through GUI. This tool does not bypass CAPTCHA authentication.
+
+This project is strongly influenced by:
+- [online-judge-tools](https://github.com/online-judge-tools)
+- [atcoder-cli](https://github.com/Tatamo/atcoder-cli)
+
+## Use Cases
+
+Let's start by using the `download` command to download problems locally.
+
+### 1. Download a Specific Contest
+
+Examples for downloading problems from a single contest.
+
+#### Download all problems from ABC350
+```sh
+❯ atcdr download abc350
+```
+
+#### Download problems A-D from ABC350
+```sh
+❯ atcdr download abc350 {A..D}
+```
+
+#### Download Typical 90 Problems
+```sh
+❯ atcdr download typical90
+```
+
+### 2. Batch Download Multiple Contests
+
+Examples for downloading multiple contests at once. Utilizes bash brace expansion.
+
+#### All problems from ABC001 to ABC010
+```sh
+❯ atcdr download abc{001..010}
+```
+
+#### Specific problems from multiple contests
+```sh
+❯ atcdr download abc{301..310} {A..C}
+```
+
+### 3. Download Specific Difficulty Problems
+
+Examples for collecting problems of the same difficulty across different contests.
+
+#### Download all A problems from ABC301-310
+```sh
+❯ atcdr download A abc{301..310}
+```
+
+This creates the following directory structure:
+```
+A/
+├── abc301/
+│   ├── Problem.html
+│   └── Problem.md
+├── abc302/
+│   ├── Problem.html
+│   └── Problem.md
+└── ...
+```
+
+#### Download all B problems from ABC300-302
+```sh
+❯ atcdr download B abc{300..302}
+```
+
+Creates:
+```
+B/
+├── abc300/
+│   ├── Problem.html
+│   └── Problem.md
+├── abc301/
+│   ├── Problem.html
+│   └── Problem.md
+└── abc302/
+    ├── Problem.html
+    └── Problem.md
+```
+This directory structure allows you to efficiently practice problems of the same difficulty level in one place.
+
+### Solving Problems
+
+You can view problems by opening Markdown or HTML files with VS Code's HTML Preview or Markdown Preview. In VS Code, you can display the text editor on the left and work on problems while viewing them on the right.
+
+### Testing Samples Locally
+
+Navigate to the folder where you downloaded the problem.
+
+```sh
+❯ cd abc224/B
+```
+
+After creating your solution file in the folder, run the test command to test against sample cases.
+
+```sh
+~/.../abc224/B
+❯ atcdr t
+```
+
+For Wrong Answer (WA) cases, the display looks like this:
+
+### Submitting Solutions
+
+```sh
+~/.../abc224/B
+❯ atcdr s
+```
+
+Running this command will submit your solution. Login to AtCoder website is required for submission.
+
+### Generating Solutions with GPT
+
+```sh
+~/.../abc224/B
+❯ atcdr g
+```
+
+This command generates a solution using OpenAI's GPT model. An OpenAI API key is required. On first run, you'll be prompted to input your API key.
+
+### Login to AtCoder
+
+```sh
+❯ atcdr login
+```
+
+Logs into AtCoder. A browser window will open for CAPTCHA verification. After solving the CAPTCHA, login completes automatically.
+
+### Create Markdown File
+
+```sh
+~/.../abc224/B
+❯ atcdr m
+```
+
+Creates a Markdown file from the HTML file in the current directory. This command is automatically executed during `atcdr download`.
+
+### Open Problem in Browser
+
+```sh
+~/.../abc224/B
+❯ atcdr o
+```
+
+Opens the problem page in your browser. Convenient for checking detailed problem statements or constraints.
+
+## Commands
+
+| Command | Alias | Description |
+|---------|-------|-------------|
+| `atcdr download` | `atcdr d` | Download problems |
+| `atcdr test` | `atcdr t` | Test with sample cases |
+| `atcdr submit` | `atcdr s` | Submit solution |
+| `atcdr generate` | `atcdr g` | Generate solution with GPT |
+| `atcdr login` | - | Login to AtCoder |
+| `atcdr logout` | - | Logout from AtCoder |
+| `atcdr markdown` | `atcdr m` | Create Markdown file |
+| `atcdr open` | `atcdr o` | Open problem in browser |
+
+## GPT Code Generation
+
+`atcdr generate` command uses GPT to generate solutions. It requires an OpenAI API key.
+
+### Generate Solution with Test
+
+By default, generated code is tested against sample cases:
+
+```sh
+~/.../abc224/B
+❯ atcdr generate
+```
+
+### Specify Language
+
+Specify the programming language for generation. Default is Python.
+
+```sh
+~/.../abc224/B
+❯ atcdr generate --lang cpp
+```
+
+Supported languages:
+- `python` (default)
+- `cpp`
+- `java`
+- `rust`
+
+### Specify GPT Model
+
+```sh
+~/.../abc224/B
+❯ atcdr generate --gpt gpt-4o
+```
+
+Available models:
+- `gpt-4o-mini` (default) - Fast and cost-effective
+- `gpt-4o` - More accurate but slower
+
+### Generate Code Only Without Testing
+
+To generate code without testing:
+
+```sh
+~/.../abc224/B
+❯ atcdr generate --lang rust --without_test
+```

atcoderstudybooster-0.4.2.dist-info/RECORD

@@ -0,0 +1,22 @@
+atcdr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+atcdr/ai.py,sha256=mjGfst2PaxgKskGkBVyrsNsSDlkgsQeyhPK9I8hOq-w,15894
+atcdr/cli.py,sha256=KPpnxqlvUwiXZdGmaO07bv3sRFJezjyXs0HPqF9r5I4,2562
+atcdr/download.py,sha256=sMILF_FKLTe3OBk_ZnA8pzvnlGz68jrHaU-lxDAy6pA,7678
+atcdr/login.py,sha256=3lyuo19EKOj3eaiOcOUnrkkgEEqWO0D1EnjLPKNxkPU,4655
+atcdr/logout.py,sha256=XwyR5oSipg-iQzfdfkx4Cs0Q88ZWJ548FmdhlIhpUL8,777
+atcdr/markdown.py,sha256=x0OORs1eun14c0XZWUap6HljTHhJ6UM6OfkJlDXeeSo,1587
+atcdr/open.py,sha256=bxfoUGO0yo3BK1C9iswuN65GW_wp6OEa58IX7JgWAFU,1319
+atcdr/submit.py,sha256=vVGZ-04K7NtjL5jv79Wx8IWosVK44XwEDCK19QAkKAo,9604
+atcdr/test.py,sha256=tbjkBETQG48AuH1F_hBlla3lpfcQiVvFO1YjZ2QDB9A,13518
+atcdr/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+atcdr/util/fileops.py,sha256=kvQDO85Ii5n__Wo8KmoE6Ecgbxx9MfmF7BDYz1sL5Sk,3200
+atcdr/util/filetype.py,sha256=pceB08trkwNkdzKJx4fFfOWpz9jYMBRDwXLW4un0sRM,2254
+atcdr/util/i18n.py,sha256=WRptkwqRSYSpA7L2CeWwv4ufv_uK65KjnorAcOTOot8,17949
+atcdr/util/openai.py,sha256=BygabBuUmuD7wCyEujS4-79XpmLaBi8L_mGUq-JsTGs,1232
+atcdr/util/parse.py,sha256=fPcDqnb-COGJA49sc8HLNQBjCATII0edOtpe_sVIx0g,7121
+atcdr/util/problem.py,sha256=ZLD-WvhC5SC6TGbyqmiOpTVZVSn-KuhOazWvAvHdyqI,1222
+atcdr/util/session.py,sha256=xct266SY7QuC3bc1IKlkVginttvXE_qK5tepUx6hfWE,4820
+atcoderstudybooster-0.4.2.dist-info/METADATA,sha256=RKaWJkW3AiRZeIDRTQuhGshxruW7CvTo_lUbZmzi6gE,6107
+atcoderstudybooster-0.4.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+atcoderstudybooster-0.4.2.dist-info/entry_points.txt,sha256=-stL-IwnheQGlYAdm82RuZu8CGgSakU0aVIVlA7DmFA,40
+atcoderstudybooster-0.4.2.dist-info/RECORD,,

atcdr/generate.py

@@ -1,202 +0,0 @@
-import json
-import os
-import re
-
-import rich_click as click
-from rich.console import Console
-from rich.panel import Panel
-from rich.syntax import Syntax
-
-from atcdr.test import ResultStatus, TestRunner, create_renderable_test_info
-from atcdr.util.fileops import add_file_selector
-from atcdr.util.filetype import (
-    FILE_EXTENSIONS,
-    Filename,
-    Lang,
-    lang2str,
-    str2lang,
-)
-from atcdr.util.gpt import ChatGPT, Model, set_api_key
-from atcdr.util.parse import ProblemHTML
-
-
-def get_code_from_gpt_output(output: str) -> str:
-    pattern = re.compile(r'```(?:\w+)?\s*(.*?)\s*```', re.DOTALL)
-    match = pattern.search(output)
-    return match.group(1) if match else ''
-
-
-def render_result_for_GPT(
-    test: TestRunner,
-) -> tuple[str, bool]:
-    results = list(test)
-
-    match test.info.summary:
-        case ResultStatus.AC:
-            return 'Accepted', True
-        case ResultStatus.CE:
-            return f'Compile Error \n {test.info.compiler_message}', False
-        case _:
-            message_for_gpt = ''.join(
-                f'\n{result.label} => {result.result.passed.value}\nInput :\n{result.testcase.input}\nOutput :\n{result.result.output}\nExpected :\n{result.testcase.output}\n'
-                if result.result.passed == ResultStatus.WA
-                else f'\n{result.label} => {result.result.passed.value}\nInput :\n{result.testcase.input}\nOutput :\n{result.result.output}\n'
-                for result in results
-            )
-            return message_for_gpt, False
-
-
-def generate_code(file: Filename, lang: Lang, model: Model) -> None:
-    console = Console()
-    with open(file, 'r') as f:
-        html_content = f.read()
-    md = ProblemHTML(html_content).make_problem_markdown('en')
-
-    if set_api_key() is None:
-        return
-    gpt = ChatGPT(
-        system_prompt=f"""You are an excellent programmer. You solve problems in competitive programming.When a user provides you with a problem from a programming contest called AtCoder, including the Problem,Constraints, Input, Output, Input Example, and Output Example, please carefully consider these and solve the problem.Make sure that your output code block contains no more than two blocks. Pay close attention to the Input, Input Example, Output, and Output Example.Create the solution in {lang2str(lang)}.""",
-        model=model,
-    )
-    with console.status(f'コード生成中 (by {gpt.model.value})'):
-        reply = gpt.tell(md)
-
-    code = get_code_from_gpt_output(reply)
-    console.print('[green][+][/green] コードの生成に成功しました. ')
-    console.rule(f'{gpt.model.value}による{lang2str(lang)}コード')
-    console.print(Syntax(code=code, lexer=lang2str(lang)))
-
-    saved_filename = (
-        os.path.splitext(file)[0] + f'_by_{gpt.model.value}' + FILE_EXTENSIONS[lang]
-    )
-    with open(saved_filename, 'w') as f:
-        console.print(
-            f'[green][+][/green] {gpt.model.value} の出力したコードを保存しました：{f.name}'
-        )
-        f.write(code)
-
-
-def generate_template(file: Filename, lang: Lang) -> None:
-    console = Console()
-    with open(file, 'r') as f:
-        html_content = f.read()
-    md = ProblemHTML(html_content).make_problem_markdown('en')
-
-    if set_api_key() is None:
-        return
-    gpt = ChatGPT(
-        system_prompt='You are a highly skilled programmer. Your role is to create a template code for competitive programming.',
-        temperature=0.0,
-    )
-
-    propmpt = f"""
-The user will provide a problem from a programming contest called AtCoder. This problem will include the Problem Statement, Constraints, Input, Output, Input Example, and Output Example. You should focus on the Constraints and Input sections to create the template in {lang2str(lang)}.
-
-- First, create the part of the code that handles input. Then, you should read ###Input Block and ###Constraints Block.
-- After receiving the input, define variables in the program by reading ###Constraints Block and explain how to use the variables in the comment of your code block with example.
-- Last, define variables needed for output. Then you should read ###Output Block and ###Constraints Block.
-
-You must not solve the problem. Please faithfully reproduce the variable names defined in the problem.
-    """
-    with console.status(f'{lang2str(lang)}のテンプレートを生成しています...'):
-        reply = gpt.tell(md + propmpt)
-    code = get_code_from_gpt_output(reply)
-
-    savaed_filename = os.path.splitext(file)[0] + FILE_EXTENSIONS[lang]
-    with open(savaed_filename, 'x') as f:
-        console.print(
-            f'[green][+][/green] テンプレートファイルを作成 :{savaed_filename}'
-        )
-        f.write(code)
-
-
-def solve_problem(file: Filename, lang: Lang, model: Model) -> None:
-    console = Console()
-    with open(file, 'r') as f:
-        html = ProblemHTML(f.read())
-
-    md = html.make_problem_markdown('en')
-    labeled_cases = html.load_labeled_testcase()
-
-    if set_api_key() is None:
-        return
-    gpt = ChatGPT(
-        system_prompt=f"""You are a brilliant programmer. Your task is to solve an AtCoder problem. AtCoder is a platform that hosts programming competitions where participants write programs to solve algorithmic challenges.Please solve the problem in {lang2str(lang)}.""",
-        model=model,
-    )
-
-    file_without_ext = os.path.splitext(file)[0]
-
-    for i in range(1, 4):
-        with console.status(f'{i}回目のコード生成中 (by {gpt.model.value})'):
-            if i == 1:
-                test_report = ''
-                reply = gpt.tell(md)
-            else:
-                prompt = f"""The following is the test report for the code you provided:
-                {test_report}
-Please provide an updated version of the code in {lang2str(lang)}."""
-                console.print(
-                    f'[green][+][/] 次のプロンプトを{gpt.model.value}に与え,再生成します'
-                )
-                console.print(Panel(prompt))
-                reply = gpt.tell(prompt)
-
-        code = get_code_from_gpt_output(reply)
-
-        saved_filename = (
-            f'{i}_'
-            + file_without_ext
-            + f'_by_{gpt.model.value}'
-            + FILE_EXTENSIONS[lang]
-        )
-        with open(saved_filename, 'w') as f:
-            console.print(f'[green][+][/] コードの生成に成功しました！：{f.name}')
-            f.write(code)
-
-        with console.status(
-            f'{gpt.model.value}が生成したコードをテスト中', spinner='circleHalves'
-        ):
-            test = TestRunner(saved_filename, labeled_cases)
-            test_report, is_ac = render_result_for_GPT(test)
-
-        console.print(create_renderable_test_info(test.info))
-
-        if is_ac:
-            console.print('[green][+][/] コードのテストに成功!')
-            break
-        else:
-            console.print('[red][-][/] コードのテストに失敗!')
-
-    with open(
-        'log_'
-        + file_without_ext
-        + f'_by_{gpt.model.value}'
-        + FILE_EXTENSIONS[Lang.JSON],
-        'w',
-    ) as f:
-        console.print(
-            f'[green][+][/] {gpt.model.value}の出力のログを保存しました：{f.name}'
-        )
-        f.write(json.dumps(gpt.messages, indent=2))
-    return
-
-
-@click.command(short_help='コードを生成')
-@add_file_selector('files', filetypes=[Lang.HTML])
-@click.option('--lang', default='Python', help='出力するプログラミング言語')
-@click.option('--model', default=Model.GPT41_MINI.value, help='使用するGPTモデル')
-@click.option('--without-test', is_flag=True, help='テストケースを省略して生成')
-@click.option('--template', is_flag=True, help='テンプレートを生成')
-def generate(files, lang, model, without_test, template):
-    """HTMLファイルからコード生成またはテンプレート出力を行います。"""
-    la = str2lang(lang)
-    model_enum = Model(model)
-
-    for path in files:
-        if template:
-            generate_template(path, la)
-        elif without_test:
-            generate_code(path, la, model_enum)
-        else:
-            solve_problem(path, la, model_enum)

atcdr/util/gpt.py

@@ -1,118 +0,0 @@
-import os
-from enum import Enum
-from typing import Dict, List, Optional
-
-import requests
-
-
-class Model(Enum):
-    GPT4O = 'gpt-4o'
-    GPT41 = 'gpt-4.1'
-    GPT41_MINI = 'gpt-4.1-mini'
-    GPT41_NANO = 'gpt-4.1-nano'
-    GPT4O_MINI = 'gpt-4o-mini'
-    O1_PREVIEW = 'o1-preview'
-    O1 = 'o1'
-    O3 = 'o3'
-    O1_MINI = 'o1-mini'
-    O3_MINI = 'o3-mini'
-    O4_MINI = 'o4-mini'
-
-
-def set_api_key() -> Optional[str]:
-    api_key = os.getenv('OPENAI_API_KEY')
-    if api_key and validate_api_key(api_key):
-        return api_key
-    elif api_key:
-        print('環境変数に設定されているAPIキーの検証に失敗しました ')
-    else:
-        pass
-
-    api_key = input(
-        'https://platform.openai.com/api-keys からchatGPTのAPIキーを入手しましょう。\nAPIキー入力してください: '
-    )
-    if validate_api_key(api_key):
-        print('APIキーのテストに成功しました。')
-        print('以下, ~/.zshrcにAPIキーを保存しますか? [y/n]')
-        if input() == 'y':
-            zshrc_path = os.path.expanduser('~/.zshrc')
-            with open(zshrc_path, 'a') as f:
-                f.write(f'export OPENAI_API_KEY={api_key}\n')
-            print(
-                f'APIキーを {zshrc_path} に保存しました。次回シェル起動時に読み込まれます。'
-            )
-        os.environ['OPENAI_API_KEY'] = api_key
-        return api_key
-    else:
-        print('コード生成にはAPIキーが必要です。')
-        return None
-
-
-def validate_api_key(api_key: str) -> bool:
-    headers = {
-        'Content-Type': 'application/json',
-        'Authorization': f'Bearer {api_key}',
-    }
-
-    response = requests.get('https://api.openai.com/v1/models', headers=headers)
-
-    if response.status_code == 200:
-        return True
-    else:
-        print('APIキーの検証に失敗しました。')
-        return False
-
-
-class ChatGPT:
-    API_URL = 'https://api.openai.com/v1/chat/completions'
-
-    # APIの使い方 https://platform.openai.com/docs/api-reference/making-requests
-    def __init__(
-        self,
-        api_key: Optional[str] = None,
-        model: Model = Model.GPT41_MINI,
-        max_tokens: int = 3000,
-        temperature: float = 0.7,
-        messages: Optional[List[Dict[str, str]]] = None,
-        system_prompt: str = 'You are a helpful assistant.',
-    ) -> None:
-        self.api_key = api_key or os.getenv('OPENAI_API_KEY')
-        self.model = model
-        self.max_tokens = max_tokens
-        self.temperature = temperature
-        self.messages = (
-            messages
-            if messages is not None
-            else [{'role': 'system', 'content': system_prompt}]
-        )
-
-        self.__headers = {
-            'Content-Type': 'application/json',
-            'Authorization': f'Bearer {self.api_key}',
-        }
-
-    def tell(self, message: str) -> str:
-        self.messages.append({'role': 'user', 'content': message})
-
-        settings = {
-            'model': self.model.value,
-            'messages': self.messages,
-            'max_tokens': self.max_tokens,
-            'temperature': self.temperature,
-        }
-
-        response = requests.post(self.API_URL, headers=self.__headers, json=settings)
-        responsej = response.json()
-        try:
-            reply = responsej['choices'][0]['message']['content']
-        except KeyError:
-            print('Error:レスポンスの形式が正しくありません. \n' + str(responsej))
-            return 'Error: Unable to retrieve response.'
-
-        self.messages.append({'role': 'assistant', 'content': reply})
-
-        # usage = responsej['usage']
-        # input_tokens = usage.get('prompt_tokens', 0)
-        # output_tokens = usage.get('completion_tokens', 0)
-
-        return reply