https://github.com/negi524/python-starter
Pythonのプロジェクトテンプレート
https://github.com/negi524/python-starter
black makefile mypy poetry pytest python pyyaml requests
Last synced: 9 months ago
JSON representation
Pythonのプロジェクトテンプレート
- Host: GitHub
- URL: https://github.com/negi524/python-starter
- Owner: negi524
- License: mit
- Created: 2023-02-23T01:02:07.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-22T12:49:05.000Z (about 1 year ago)
- Last Synced: 2024-12-22T13:38:45.748Z (about 1 year ago)
- Topics: black, makefile, mypy, poetry, pytest, python, pyyaml, requests
- Language: Python
- Homepage:
- Size: 60.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-starter
Pythonのプロジェクトテンプレート
## プロジェクトインストール
```bash
poetry install
```
## credentialファイル作成
```bash
cp src/.env.sample src/.env
```
## プログラム実行
```bash
poetry run python src/main.py
```
or
```bash
make main
```
## フォーマット
```bash
make format
```
## テスト実行
```bash
make test
```
## 型チェック
```bash
make type-check
```
## 全てまとめてチェック
```bash
make format test type-check
```
## リポジトリのバージョンアップ
```bash
poetry version <バージョン>
```
## パッケージのバージョンアップ
```bash
poetry search <パッケージ名>
```
`pyproject.toml`を確認し、必要であれば制約を修正する。
その後
```bash
poetry update
```
[poetry documentation](https://python-poetry.org/docs/cli/#update)