Skip to content

Commit

Permalink
🎉 initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
C-Naoki committed Aug 6, 2024
0 parents commit 436a833
Show file tree
Hide file tree
Showing 36 changed files with 7,174 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/clean_gitkeep.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Clean unnecessary .gitkeep files

on:
push:
branches:
- main
- master

jobs:
clean:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Remove unnecessary .gitkeep files
run: |
find . -name '.gitkeep' -print0 | while IFS= read -r -d '' file; do
dir=$(dirname "$file")
if [ "$(ls -A "$dir" | wc -l)" -gt "1" ]; then
echo "Removing $file"
rm "$file"
fi
done
- name: Commit changes
run: |
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add -A
if [ -n "$(git status --porcelain)" ]; then
git commit -m ":fire: Remove unnecessary .gitkeep files"
git push
else
echo "No changes to commit"
fi
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
50 changes: 50 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: python lint

on:
pull_request:
branches:
- main
paths:
- "src/**.py"
- "tests/**.py"
- "poetry.lock"
- ".github/workflows/lint.yml"

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10"]

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}

- name: Install Poetry
run: |
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
echo "$HOME/.poetry/bin" >> $GITHUB_PATH
- uses: actions/cache@v2
id: venv_cache
with:
path: .venv
key: venv-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}

- name: Install Dependencies
if: steps.venv_cache.outputs.cache-hit != 'true'
run: poetry install

- name: Python Lint
run: poetry run task lint

- name: Python Test
run: poetry run task test
169 changes: 169 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# ruff
.ruff_cache/

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

# Desktop services store
*.DS_Store

# results
out/*
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["ms-python.python", "njpwerner.autodocstring"]
}
13 changes: 13 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff", // Ruff: it is a fast linter for Python, written in Rust.
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit", // Fix codes when saving
"source.organizeImports.ruff": "explicit", // Organize imports order when saving
},
"editor.formatOnSave": true,
"editor.tabSize": 4,
},
"python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
"autoDocstring.docstringFormat": "numpy"
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Naoki Chihara

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.
37 changes: 37 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
PYTHON_VERSION = 3.9.15

.PHONY: install
install: check_pyenv check_poetry pyenv_setup poetry_setup
@VENV_PATH=$$(poetry env info --path); \
SITE_PACKAGES_DIR="$${VENV_PATH}/lib/python3.10/site-packages"; \
PROJECT_ROOT=$$(echo $${VENV_PATH} | rev | cut -d'/' -f2- | rev); \
VENV_NAME=$$(basename `dirname $${VENV_PATH}`); \
echo $${PROJECT_ROOT} > $${SITE_PACKAGES_DIR}/$${VENV_NAME}.pth

.PHONY: check_pyenv
check_pyenv:
@if ! command -v pyenv &> /dev/null; then \
echo "Error: "pyenv" is not installed. please visit https://github.com/pyenv/pyenv#installation in details."; \
exit 1; \
fi

.PHONY: check_poetry
check_poetry:
@if ! command -v poetry &> /dev/null; then \
echo "Error: "pyenv" is not installed. please visit https://python-poetry.org/docs/#installation in details."; \
exit 1; \
fi

.PHONY: pyenv_setup
pyenv_setup:
pyenv install -s $(PYTHON_VERSION)
pyenv global $(PYTHON_VERSION)

.PHONY: poetry_setup
poetry_setup:
poetry env use $(PYTHON_VERSION)
poetry install

.PHONY: freeze
freeze:
poetry run pip freeze > requirements.txt
Loading

0 comments on commit 436a833

Please sign in to comment.