AtCoderStudyBooster 0.1.1__tar.gz → 0.3.1__tar.gz

atcoderstudybooster-0.3.1/.github/workflows/deploy.yaml

@@ -0,0 +1,33 @@
+name: Deploy to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Rye
+        uses: eifinger/setup-rye@v4
+        with:
+          enable-cache: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Sync dependencies
+        run: rye sync
+
+      - name: Build distributions
+        run: rye build --clean
+
+      - name: Publish to PyPI
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: rye publish --token $PYPI_TOKEN --yes

atcoderstudybooster-0.3.1/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,185 @@
+# 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
+```