Release 2025-05-24 19:31:40 +0900

.github/actions/install-packages/action.yml

@@ -0,0 +1,15 @@
+name: install packages
+description: set up uv & install packages
+
+runs:
+  using: composite
+  steps:
+    - uses: astral-sh/setup-uv@v6
+      with:
+        version: "0.7.6"
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: "pyproject.toml"
+    - name: Install packages
+      shell: bash
+      run: uv sync --locked --all-extras --dev

.github/workflows/check.yml

@@ -0,0 +1,48 @@
+name: check
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  detect-changes:
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    permissions:
+      pull-requests: read
+    outputs:
+      core: ${{ steps.filter.outputs.core }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            core:
+              - 'packages/core/**'
+
+  check-core:
+    needs: detect-changes
+    if: ${{ needs.detect-changes.outputs.core == 'true' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/core
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-packages
+      - name: Lint
+        run: uv run ruff check .
+      - name: Format
+        run: uv run ruff format --check .
+      - name: Run mypy
+        run: uv run mypy .
+      - name: Run tests
+        run: uv run pytest -v --cov -W ignore::DeprecationWarning

.github/workflows/publish.yml

@@ -0,0 +1,85 @@
+name: publish
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/**'
+
+jobs:
+  detect-changes:
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    permissions:
+      pull-requests: read
+    outputs:
+      core: ${{ steps.filter.outputs.core }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            core:
+              - 'packages/core/**'
+
+  push-git-tag:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./
+    timeout-minutes: 3
+    outputs:
+      tag-name: ${{ 'v' }}${{ env.GIT_TAG_VERSION }}
+      tag-version: ${{ env.GIT_TAG_VERSION }}
+      tag-exists: ${{ steps.create-tag.outputs.tag_exists }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-packages
+      - name: get version from `pyproject.toml`
+        run: |
+          package_version=($(uv version))
+          echo "GIT_TAG_VERSION=$package_version[2]" >> $GITHUB_ENV
+      - uses: rickstaa/action-create-tag@v1
+        id: create-tag
+        with:
+          tag: ${{ 'v' }}${{ env.GIT_TAG_VERSION }}
+
+  publish-release-note:
+    needs: push-git-tag
+    if: ${{ needs.push-git-tag.outputs.tag-exists == 'false' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./
+    timeout-minutes: 5
+    permissions:
+      contents: write
+      pull-requests: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: release-drafter/release-drafter@v6
+        with:
+          name: ${{ needs.push-git-tag.outputs.tag-name }}
+          tag: ${{ needs.push-git-tag.outputs.tag-name }}
+          version: ${{ needs.push-git-tag.outputs.tag-version }}
+          publish: 'true'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-core:
+    needs: [detect-changes, publish-release-note]
+    if: ${{ needs.detect-changes.outputs.core == 'true' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/core
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-packages
+      - name: Build package
+        run: uv build --no-cache
+      - name: Publish package to PyPI
+        run: uv publish --no-cache

.gitignore

@@ -1,2 +1,20 @@
+# python
+.venv
+.python-version
+dist
+*.egg-info
+__pycache__
+
+# mypy
+.mypy_cache
+
+# ruff
+.ruff_cache
+
+# pytest
+.pytest_cache
+.coverage
+
 # misc
+*_cache
 cspell.json

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.7.6
+    hooks:
+      - id: uv-lock
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.10
+    hooks:
+      - id: ruff-check
+        args: [ --fix ]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        files: ^packages/core/

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing Guidelines
+
+We appreciate your interest to contribute to this project! Please read the following to see how you could contribute.
+
+## 📝 Create an Issue
+
+The first thing to do is to create a new issue. Feel free to create new issues from [here](https://github.com/jcam1/python-sdk/issues/new/choose) to propose/request new features or report any bugs you found.
+
+## ⬇️ Clone This Repo
+
+Next, clone this repository. Our default branch is set to `develop`.
+
+```sh
+git clone https://github.com/jcam1/python-sdk.git
+```
+
+## ⚡ Checkout to a New Branch
+
+You then need to `checkout` to a new branch (name whatever you would like) from the cloned `develop` branch.
+
+```sh
+git checkout -b ${your_branch_name}
+```
+
+## 🛠 Write Code
+
+Now, write code to implement the proposed features and/or to fix bugs. Please refer to `README`s of respective SDKs for more details.
+
+## 🌟 Open a Pull Request
+
+Finally, open a new PR from your branch to `develop` branch, and describe what you'll have done following [our PR template](./.github/pull_request_template.md).

README.md

@@ -1,4 +1,43 @@
 # JPYC Python SDK
 
-> [!IMPORTANT]
-> TODO: README in English
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/jcam1/python-sdk/issues/new/choose)
+
+Monorepo for JPYC Python SDKs.
+
+## 💫 Available SDKs
+
+Please refer to `README`s of respective SDKs for more details.
+
+|   name | `README`                                   |
+| -----: | :----------------------------------------- |
+| `core` | [packages/core](./packages/core/README.md) |
+
+## ⬇️ Installation
+
+### 1. Clone Repository
+
+```sh
+# clone this repo
+$ git clone https://github.com/jcam1/python-sdk.git
+# cd into the repo
+$ cd python-sdk
+```
+
+### 2. Install `uv`
+
+This repo uses `uv` for package management purposes. If not installed, please read & follow [uv's official instructions](https://docs.astral.sh/uv/getting-started/installation/) to install any necessary software for development. For example, the following command installs `uv` on MacOS.
+
+```sh
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### 3. Install packages
+
+```sh
+uv sync
+```
+
+## 💪🏻 Contributing
+
+Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md).

docs/README.md

@@ -0,0 +1,25 @@
+# Docs
+
+> [!IMPORTANT]
+> This `README` is mainly for the advanced users (e.g., contributors of this repo).
+
+This directory contains the auto-generated documentation for the SDK.
+
+## 📄 Build
+
+Run the following commands that generate a collection of documents under [`./docs`](./) directory.
+
+```sh
+# cd into the root directory
+$ cd python-sdk
+# generate documentation from the google-styled docstrings
+$ uv run pdoc ./packages/core/src -o ./docs/core -d google
+```
+
+## 🔍 UI
+
+Type the following into your browser to see the contents.
+
+```sh
+{absolute_path_of_any_parent_directories}/python-sdk/docs/core/index.html
+```

docs/core/index.html

@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./src.html"/>
+</head>
+</html>

packages/core/.gitignore

@@ -0,0 +1,17 @@
+# python
+dist
+*.egg-info
+__pycache__
+
+# mypy
+.mypy_cache
+
+# ruff
+.ruff_cache
+
+# pytest
+.pytest_cache
+.coverage
+
+# misc
+DS_STORE

packages/core/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 JPYC株式会社
+
+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.