Metadata-Version: 2.1
Name: mo9mo9db
Version: 0.0.17
Summary: discord.guild[mo9mo9study]でDBと連携するために使用するモジュール
Home-page: https://github.com/mo9mo9study/discord.db
Author: su-pleiades
Author-email: su.impreza.itengineer@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: PyMySQL
Requires-Dist: python-dotenv
Requires-Dist: SQLAlchemy (==1.3.23)
Requires-Dist: SQLAlchemy-Utils (==0.36.8)

# 当リポジトリの自作パッケージを使うための準備
```py
pip install mo9mo9db
# https://pypi.org/project/mo9mo9db/

# このパッケージを使用する側のディレクトリに.envのファイルを作成する
# .envファイル内に以下のDB情報とパラメータ情報を入力することが必須
vi .env
> .env ------------------------
###==============================
#MYSQL credential
###==============================
DB_USER=''
DB_PASSWORD=''
DB_HOST=''
DB_PORT=''
DB_DATABASE=''
DB_ECHO=''
------------------------------
```

# about
```
ddl/
    master/create_table.sql : DDL文。これをDBに流し込めば本番環境と同じ状態になるよう保つ。
    patch/ : TBD。migrationの仕組みが導入されるまで、DBスキーマ変更用DDLはここに置く。レビュー完了後masterのDDLにも反映する。
ERD/
    draw.ioで書かれたERD
```

# commit時のローカル運用
- ディレクトリ[.githooks/]にてcommitをトリガーに動く処理を記載しています
  - pythonの[autopep8]と[flake8]をcommit対象のファイルに対して実行します
- これを活用することでpepに準拠するように自動修正やエラー箇所を出力してくれます
- ファイル[.githooks/pre-commit]はファイル[.pre-commit-config.yaml]を元に作成されています
```py
# pre-commitを活用するための準備
## git configのコマンドを用いて、.git/hooksのパスを変更します
git config core.hooksPath .githooks
```

# Future
-

# pypiに新しいバージョンをuploadする簡易手順
```
# setup.cfgのバージョンを更新すること
python setup.py bdist_wheel
twine upload --repository pypi dist/*
```


