Metadata-Version: 2.3
Name: eyesy_api_stubs
Version: 0.2.0
Summary: EYESY unofficial Python3 API stub
Author-email: zztkm <zztkm@tsurutatakumi.info>
License: MIT License
        
        Copyright (c) 2024 zztkm
        
        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.
License-File: LICENSE
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# eyesy-api-stub

[EYESY](https://umbrella-company.jp/products/eyesy/) の Python API のスタブです。

EYESY のコーディング支援を目的として作成されました。

コーディング時の補完機能やドキュメントの参照に利用してください（コーディングには VS Code & [Python 拡張機能](https://marketplace.visualstudio.com/items?itemName=ms-python.python)の利用を推奨します）。

注意点: このパッケージ自体は機能を持っておらず、あくまで EYESY API の型定義とドキュメントを提供します。

このパッケージは EYESY のマニュアルを参考に作成しました。

<https://umbrella-company.jp/corporate/wp-content/uploads/2023/01/critter_and_guitari_eyesy_manual.pdf>

## 使い方

このパッケージが提供する型ヒントは1部、 Pygame に依存しているので Pygame と一緒にインストールしてください。

```bash
pip install pygame eyesy-api-stubs
```

コーディング時には、以下のように型ヒントとして利用してください。

```python
import pygame
from pygame import Surface
from eyesy_api_stubs import Etc

def setup(screen: Surface, etc: Etc):
    pass

def draw(screen: Surface, etc: Etc):
    size = 640
    position = (510, 500)
    color = (255, 0, 0)
    pygame.draw.circle(screen, color, position, size, 0)
```
