AtCoderStudyBooster 0.2__py3-none-any.whl → 0.3.1__py3-none-any.whl

atcoderstudybooster-0.3.1.dist-info/METADATA

@@ -0,0 +1,205 @@
+Metadata-Version: 2.3
+Name: AtCoderStudyBooster
+Version: 0.3.1
+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: fire
+Requires-Dist: markdownify>=0.13.1
+Requires-Dist: pywebview>=5.4
+Requires-Dist: questionary>=2.0.1
+Requires-Dist: requests
+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
+
+## 概要
+
+AtCoderStudyBoosterはAtCoderの学習を加速させるためのCLIツールです。問題をローカルにダウンロードし、テスト、提出、解答の作成をサポートするツールです。Pythonが入っていることが必須です。Pythonが入っている環境なら、`pip install AtCoderStudyBooster`でインストールできます。
+
+このツールは以下のプロジェクトに強く影響を受けています。
+[online-judge-tools](https://github.com/online-judge-tools)
+[atcoder-cli](https://github.com/Tatamo/atcoder-cli)
+
+## 利用ケース
+
+### B問題の練習したい場合
+
+ABCコンテストの223から226のB問題だけを集中的に練習したい場合、次のコマンドを実行します。
+
+```sh
+❯ atcdr download B 223..226
+```
+
+コマンドを実行すると,次のようなフォルダーを作成して、各々のフォルダーに問題をダウンロードします。
+
+```css
+B
+├── 223
+│   ├── StringShifting.html
+│   └── StringShifting.md
+├── 224
+│   ├── Mongeness.html
+│   └── Mongeness.md
+├── 225
+│   ├── StarorNot.html
+│   └── StarorNot.md
+└── 226
+    ├── CountingArrays.html
+    └── CountingArrays.md
+```
+
+### 特定のコンテストの問題に取り組みたい場合
+
+```sh
+❯ atcdr download 223..225 A..C
+```
+のように実行すると以下のようなフォルダーを生成します.
+
+```css
+.
+├── 223
+│   ├── A
+│   │   ├── ExactPrice.html
+│   │   └── ExactPrice.md
+│   ├── B
+│   │   ├── StringShifting.html
+│   │   └── StringShifting.md
+│   └── C
+│       ├── Doukasen.html
+│       └── Doukasen.md
+├── 224
+│   ├── A
+│   │   ├── Tires.html
+│   │   └── Tires.md
+│   ├── B
+│   │   ├── Mongeness.html
+│   │   └── Mongeness.md
+│   └── C
+│       ├── Triangle.html
+│       └── Triangle.md
+└── 225
+    ├── A
+    │   ├── DistinctStrings.html
+    │   └── DistinctStrings.md
+    ├── B
+    │   ├── StarorNot.html
+    │   └── StarorNot.md
+    └── C
+        ├── CalendarValidator.html
+        └── CalendarValidator.md
+```
+
+### 問題を解く
+
+MarkdownファイルあるいはHTMLファイルをVS CodeのHTML Preview, Markdown Previewで開くと問題を確認できます。VS Codeで開くと左側にテキストエディターを表示して、右側で問題をみながら問題に取り組めます。
+
+![demo画像](./.images/demo1.png)
+
+### サンプルをローカルでテストする
+
+問題をダウンロードしたフォルダーに移動します。
+
+```sh
+❯ cd 224/B
+```
+
+移動したフォルダーで解答ファイルを作成後をtestコマンドを実行すると, サンプルケースをテストします。
+
+```sh
+~/.../224/B
+❯ atcdr t
+```
+
+![demo画像](./.images/demo2.png)
+
+WAの場合は以下のような表示になります。
+
+![demo画像](./.images/demo3.png)
+
+
+### 提出する
+
+```sh
+~/.../224/B
+❯ atcdr s
+```
+を実行すると, 提出することができます。提出にはAtCoderのサイトへのログインが必要です。
+
+### 解答をGPTで生成する
+
+```sh
+~/.../224/B
+❯ atcdr g
+```
+で解答をGPTで生成します。Chat GPTのAPIキーが必要です。さらに、生成されたファイルはサンプルケースが自動でテストされ、**テストをパスしなかった場合、テスト結果がGPTにフィードバックされ解答が再生成**されます。
+
+GPTとプログラムとのやり取りのログはJSONファイルで保存されます。
+
+## 解答生成機能generateコマンドに関する注意点
+
+[AtCoder生成AI対策ルール](https://info.atcoder.jp/entry/llm-rules-ja)によるとAtCoder Beginner Contest（以下、ABCとする）および AtCoder Regular Contest (Div. 2) においてに問題文を生成AIに直接与えることは禁止されています。ただし、このルールは過去問を練習している際には適用されません。　該当のコンテスト中にこの機能を使用しないでください。
+
+## その他の機能
+
+### markdownコマンド
+
+完全なCLI環境方向けのコマンドです。
+```sh
+~/.../224/B
+❯ atcdr md
+```
+を実行すると, 問題をプリントします。
+
+![demo画像](./.images/demo4.png)
+
+### 複数のファイルを一度にテスト
+
+```sh
+~/.../224/B
+❯ atcdr t *.py
+```
+でフォルダー内にあるすべてのPythonファイルを一度にテストします。
+```sh
+~/.../224/B
+❯ atcdr t mon.py mon.c mon.cpp
+```
+
+フォルダー内に複数ファイルある場合は、インタラクティブに選択できます。
+```sh
+~/.../224/B
+❯ atcdr t
+```
+
+```sh
+~/.../224/B
+❯ atcdr t
+ 複数のファイルが見つかりました.ファイルを選択してください:
+ 十字キーで移動, [enter]で実行
+ ❯❯❯ mon.py
+     mon.c
+     mon.cpp
+```
+
+### プログラミング言語を指定してコードを生成
+
+`--lang`オプションを使うと、生成したいプログラミング言語を指定できます。
+```sh
+~/.../224/B
+❯ atcdr generate --lang rust
+```
+### テストをせずにコードのみ生成
+
+デフォルトで`atcdr generate`コマンドは生成されたコードをテストしますが、テストせずにコードのみ生成できます。
+
+```sh
+~/.../224/B
+❯ atcdr generate --lang rust --without_test
+```

atcoderstudybooster-0.3.1.dist-info/RECORD

@@ -0,0 +1,21 @@
+atcdr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+atcdr/download.py,sha256=roscCz_6bq4Ab6XNc1KpYywMc37XTfmH7ciEhEPYu5M,11056
+atcdr/generate.py,sha256=ckjI7CuPO5_1DDrMch8EFtQK5F0102ZDJFAzpjlxqqg,8024
+atcdr/login.py,sha256=kNs2vUSuYqSn5oOJGVbQOluJXKi3zr5ZQBXfai3VU08,4575
+atcdr/logout.py,sha256=uBFt3idW4Ik2TypBFuQjXJpYWWDNWZM42--B5Xlcbtc,622
+atcdr/main.py,sha256=tcNUcmOFh5hSKmFMgsD6g9k467x6rOI5rSMb8aPfL78,953
+atcdr/markdown.py,sha256=v3Sh5vl20V6dTkspwzf5SxLKJLw6J2Xj1HX3F185X2I,1227
+atcdr/open.py,sha256=l5QbrefXuZxn8LoqjfAE5p5EwRBJeg5VqopbjMXdG3Y,1121
+atcdr/submit.py,sha256=IxVz2QyotDjQqvfqFgyNWuDBDeI-CmVKYqaIMIInDIY,9694
+atcdr/test.py,sha256=Q7HHggbAix6iqClzm01YCs7Db9v01D5NNzmSztY8dbc,13521
+atcdr/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+atcdr/util/execute.py,sha256=r4rYmbNQH5kIzdqAeo9SGvqJZyFX4yBIdmg9cTKeiYE,2221
+atcdr/util/filetype.py,sha256=pceB08trkwNkdzKJx4fFfOWpz9jYMBRDwXLW4un0sRM,2254
+atcdr/util/gpt.py,sha256=vH10Waa7KXlz6-5pEUBuIbxTbDH3Hys7k9Tt7prvFX4,3772
+atcdr/util/parse.py,sha256=SJ4khlH5iWaSwyORmQLi84npMwh5u2omCeg0q7ScEAE,6974
+atcdr/util/problem.py,sha256=wEoMC5KVQu5l-i4V-ZCR30Z30Zov0VCNtLVIbL-0iI0,2594
+atcdr/util/session.py,sha256=LwlSN86sfnkE9a-opL4qvKYHsCgiMy7eFCdcXdo79eg,4889
+atcoderstudybooster-0.3.1.dist-info/METADATA,sha256=FElAss6sLM-k7pAmZJteKHgrl8uPsZCV95jiyJAHaac,6243
+atcoderstudybooster-0.3.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+atcoderstudybooster-0.3.1.dist-info/entry_points.txt,sha256=_bhz0R7vp2VubKl_eIokDO8Wz9TdqvYA7Q59uWfy6Sk,42
+atcoderstudybooster-0.3.1.dist-info/RECORD,,

{atcoderstudybooster-0.2.dist-info → atcoderstudybooster-0.3.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.26.3
 Root-Is-Purelib: true
 Tag: py3-none-any

atcdr/util/cost.py

@@ -1,120 +0,0 @@
-from enum import Enum
-from typing import Optional
-
-import tiktoken
-import yfinance as yf  # type: ignore
-
-
-class Model(Enum):
-	GPT4O = 'gpt-4o'
-	GPT4O_MINI = 'gpt-4o-mini'
-
-
-class CostType(Enum):
-	INPUT = 'input'
-	OUTPUT = 'output'
-
-
-class Currency:
-	def __init__(
-		self, usd: Optional[float] = None, jpy: Optional[float] = None
-	) -> None:
-		self._exchange_rate = self.get_exchange_rate()
-		self._usd = usd if usd is not None else 0.0
-		self._jpy = jpy if jpy is not None else self.convert_usd_to_jpy(self._usd)
-
-	@staticmethod
-	def get_exchange_rate() -> float:
-		ticker = yf.Ticker('USDJPY=X')
-		todays_data = ticker.history(period='1d')
-		return todays_data['Close'].iloc[0]
-
-	def convert_usd_to_jpy(self, usd: float) -> float:
-		return usd * self._exchange_rate
-
-	def convert_jpy_to_usd(self, jpy: float) -> float:
-		return jpy / self._exchange_rate
-
-	@property
-	def usd(self) -> float:
-		return self._usd
-
-	@usd.setter
-	def usd(self, value: float) -> None:
-		self._usd = value
-		self._jpy = self.convert_usd_to_jpy(value)
-
-	@property
-	def jpy(self) -> float:
-		return self._jpy
-
-	@jpy.setter
-	def jpy(self, value: float) -> None:
-		self._jpy = value
-		self._usd = self.convert_jpy_to_usd(value)
-
-	def __add__(self, other: 'Currency') -> 'Currency':
-		return Currency(usd=self.usd + other.usd)
-
-	def __sub__(self, other: 'Currency') -> 'Currency':
-		return Currency(usd=self.usd - other.usd)
-
-	def __mul__(self, factor: float) -> 'Currency':
-		return Currency(usd=self.usd * factor)
-
-	def __truediv__(self, factor: float) -> 'Currency':
-		return Currency(usd=self.usd / factor)
-
-	def __eq__(self, other: object) -> bool:
-		if not isinstance(other, Currency):
-			return NotImplemented
-		epsilon = 1e-9  # 許容範囲
-		return abs(self.usd - other.usd) < epsilon
-
-	def __lt__(self, other: 'Currency') -> bool:
-		return self.usd < other.usd
-
-	def __repr__(self) -> str:
-		return f'Currency(usd={self.usd:.2f}, jpy={self.jpy:.2f})'
-
-	def __str__(self) -> str:
-		return f'USD: {self.usd:.2f}, JPY: {self.jpy:.2f}'
-
-
-class Rate:
-	_COST_RATES = {
-		Model.GPT4O: {CostType.INPUT: 5 / 1000**2, CostType.OUTPUT: 15 / 1000**2},
-		Model.GPT4O_MINI: {
-			CostType.INPUT: 0.15 / 1000**2,
-			CostType.OUTPUT: 0.60 / 1000**2,
-		},
-	}
-
-	@staticmethod
-	def calc_cost(model: Model, cost_type: CostType, token_count: int) -> Currency:
-		cost_in_usd = Rate._COST_RATES[model][cost_type] * token_count
-		return Currency(usd=cost_in_usd)
-
-
-class ApiCostCalculator:
-	def __init__(self, text: str, cost_type: CostType, model: Model) -> None:
-		self.text = text
-		self.cost_type = cost_type
-		self.model = model
-
-		# トークンモデルを取得
-		self.token_model = tiktoken.encoding_for_model(model.value)
-
-	@property
-	def token_count(self) -> int:
-		return len(self.token_model.encode(self.text))
-
-	@property
-	def cost(self) -> Currency:
-		return Rate.calc_cost(self.model, self.cost_type, self.token_count)
-
-	def __str__(self) -> str:
-		return f'Token count: {self.token_count}\nCost ({self.cost_type.value}): ${self.cost.usd:.2f} / ¥{self.cost.jpy:.2f}'
-
-	def __repr__(self) -> str:
-		return f'ApiCostCalculator(text={self.text}, cost_type={self.cost_type}, model={self.model})'

atcoderstudybooster-0.2.dist-info/METADATA

@@ -1,96 +0,0 @@
-Metadata-Version: 2.3
-Name: AtCoderStudyBooster
-Version: 0.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: fire
-Requires-Dist: markdownify>=0.13.1
-Requires-Dist: questionary>=2.0.1
-Requires-Dist: requests
-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
-Requires-Dist: yfinance
-Description-Content-Type: text/markdown
-
-# AtCoderStudyBooster
-
-## 概要
-
-AtCoderStudyBoosterはAtCoderの学習を加速させるためのツールです。問題をローカルにダウンロードし、テスト、解答の作成をサポートするツールです。Pythonが入っていることが必須です。Pythonが入っている環境なら、`pip install AtCoderStudyBooster`でインストールできます。
-
-このツールは以下のプロジェクトに強く影響を受けています。
-[online-judge-tools](https://github.com/online-judge-tools)
-[atcoder-cli](https://github.com/Tatamo/atcoder-cli)
-これらとの違いですが、本ツールはAtCoderでのコンテストでの利用は想定しておらず、初心者の学習のサポートのみを意識しています。そのため、現時点で提出機能は備えていません。また, Chat GPT APIによる解答の作成サポート機能を備えています。
-
-## 利用ケース
-
-### B問題の練習したい場合
-
-ABCコンテストの223から226のB問題だけを集中的に練習したい場合、次のコマンドを実行します。
-
-```sh
-atcdr download B 223..226
-```
-
-コマンドを実行すると,次のようなフォルダーを作成して、各々のフォルダーに問題をダウンロードします。
-
-```css
-B
-├── 223
-│   ├── StringShifting.html
-│   └── StringShifting.md
-├── 224
-│   ├── Mongeness.html
-│   └── Mongeness.md
-├── 225
-│   ├── StarorNot.html
-│   └── StarorNot.md
-└── 226
-    ├── CountingArrays.html
-    └── CountingArrays.md
-```
-
-MarkdownファイルあるいはHTMLファイルをVS CodeのHTML Preview, Markdown Previewで開くと問題を確認できます。VS Codeで開くと左側にテキストエディターを表示して、右側で問題をみながら問題に取り組めます。
-
-![demo画像](./.images/demo1.png)
-
-### サンプルをローカルでテストする
-
-問題をダウンロードしたフォルダーに移動します。
-
-```sh
-cd B/224
-```
-
-移動したフォルダーで解答ファイルを作成後を実行すると, 自動的にテストします。
-
-```sh
-▷ ~/.../B/224
-atcdr t
-```
-
-```sh
-solution.pyをテストします。
---------------------
-
-Sample 1 of Test:
-✓ Accepted !! Time: 24 ms
-
-Sample 2 of Test:
-✓ Accepted !! Time: 15 ms
-```
-
-と実行すると作成したソースコードをテストして、HTMLに書かれているテストケースを読み込んで実行し, Passするかを判定します。
-
-## 解答生成機能generateコマンドに関する注意点
-
-本ツールにはChatGPT APIを利用したコード生成機能があります。[AtCoder生成AI対策ルール](https://info.atcoder.jp/entry/llm-abc-rules-ja?_gl=1*1axgs02*_ga*ODc0NDAyNjA4LjE3MTk1ODEyNDA.*_ga_RC512FD18N*MTcyMzMxNDA1Ni43NC4xLjE3MjMzMTY1NjUuMC4wLjA.)によるとAtCoder Beginner Contestにおいてに問題文を生成AIに直接与えることは禁止されています。ただし、このルールは過去問を練習している際には適用されません。
-
-現時点で本ツールにはログイン機能がないため、コンテスト中の問題に対して`download`コマンドは利用して問題をダウンロードすることはできません。`generate`コマンドは`download`コマンドに依存しており、ダウンロードした問題のHTMLファイルをパースしてGPTに解釈しやすいmarkdownを与えることで実現しています。したがって、このコマンドがAtCoder Beginner Contest中に[AtCoder生成AI対策ルール](https://info.atcoder.jp/entry/llm-abc-rules-ja?_gl=1*1axgs02*_ga*ODc0NDAyNjA4LjE3MTk1ODEyNDA.*_ga_RC512FD18N*MTcyMzMxNDA1Ni43NC4xLjE3MjMzMTY1NjUuMC4wLjA.)に抵触することはありません。

atcoderstudybooster-0.2.dist-info/RECORD

@@ -1,17 +0,0 @@
-atcdr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atcdr/download.py,sha256=aqJEmrLop_Mj8GNJjoWRcSzWU0z9iNc9vtZOjhWXx3U,8945
-atcdr/generate.py,sha256=0yWX-5PS-FR6LTaP3muHq6a7rFB2a1Oek48mF45exoA,6972
-atcdr/main.py,sha256=y2IkXwcAyKZ_1y5PgU93GpXzo5lKak9oxo0XV_9d5Fo,727
-atcdr/markdown.py,sha256=jEktnYgrDYcgIuhxRpJImAzNpFmfSPkRikAesfMxAVk,1125
-atcdr/open.py,sha256=2UlmNWdieoMrPu1xSUWf-8sBB9Y19r0t6V9zDRBSPes,924
-atcdr/test.py,sha256=hAhttwVJiDJX8IAWcnpKj04yTTs4cmr8GQ-NsldBAGc,8468
-atcdr/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atcdr/util/cost.py,sha256=0c9H8zLley7xZDLuYU4zJmB8m71qcO1WEIQOoEavD_4,3168
-atcdr/util/execute.py,sha256=tcYflnVo_38LdaOGDUAuqfSfcA54bTrCaTRShH7kwUw,1750
-atcdr/util/filetype.py,sha256=NyTkBbL44VbPwGXps381odbC_JEx_eYxRYPaYwRHfZ0,1647
-atcdr/util/gpt.py,sha256=Lto6SJHZGer8cC_Nq8lJVnaET2R7apFQteo6ZEFpjdM,3304
-atcdr/util/problem.py,sha256=WprmpOZm6xpyvksIS3ou1uHqFnBO1FUZWadsLziG1bY,2484
-atcoderstudybooster-0.2.dist-info/METADATA,sha256=Yyj9AArb6NwZNk6YwjS8W_NVwwdZBlFd2a__T6OsfM4,4467
-atcoderstudybooster-0.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-atcoderstudybooster-0.2.dist-info/entry_points.txt,sha256=_bhz0R7vp2VubKl_eIokDO8Wz9TdqvYA7Q59uWfy6Sk,42
-atcoderstudybooster-0.2.dist-info/RECORD,,