Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/actions/install-packages/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ runs:
version: "0.7.6"
- uses: actions/setup-python@v5
with:
python-version-file: "pyproject.toml"
python-version: '3.13'
- name: Install packages
shell: bash
run: uv sync --locked --all-extras --dev
32 changes: 16 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# Contributing Guidelines
# How to Contribute

We appreciate your interest to contribute to this project! Please read the following to see how you could contribute.
We appreciate your interest to contribute to this project! Please read and follow the steps below to see how you could contribute to this project.

## 📝 Create an Issue
### 1. 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, following the respective templates.
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 bugs.

## ⬇️ Clone This Repo
### 2. Fork & Clone Repo

Next, clone this repository on `develop` branch.
Next, fork this repository to your GitHub account, and clone it to your local environment.

> [!TIP]
> Our default branch is set to `main`.
> [!IMPORTANT]
> Clone `develop` branch for development, while our default branch is `main`.

```sh
git clone -b develop https://github.com/jcam1/python-sdk.git
$ git clone -b develop https://github.com/{YOUR_USER_NAME}/python-sdk.git
```

## Checkout to a New Branch
### 3. Checkout to a New Branch

You then need to `checkout` to a new branch (name whatever you would like) from the cloned `develop` 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}
$ git checkout -b ${YOUR_BRANCH_NAME}
```

## 🛠 Write Code
### 4. 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.
Now, write code to implement the proposed features and/or to fix bugs. Please refer to `README`s of the respective modules for more details.

## 🌟 Open a Pull Request
### 5. 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).
Finally, open a new PR from your branch to `develop` branch on our (original) repo, and describe what you'll have done.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2025 JPYC株式会社
Copyright (c) 2025 - present 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
Expand Down
43 changes: 43 additions & 0 deletions README-jp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# JPYC Python SDK

[![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)

=> 英語版は[こちら](./README.md)。

## 💫 利用可能な SDK

各 SDK に関する詳細は、それぞれの `README` を参照ください。

| SDK名 | `README` |
| --------------: | :----------------------------------------- |
| `jpyc-core-sdk` | [packages/core](./packages/core/README-jp.md) |

## ⬇️ インストール

### 1. リポジトリのクローン

```sh
# リポジトリのクローン
$ git clone https://github.com/jcam1/python-sdk.git
# `python-sdk`ディレクトリへの移動
$ cd python-sdk
```

### 2. `uv` のインストール

このリポジトリでは、パッケージ管理ツールとして `uv` を利用しています。デバイスにインストールされていない場合は、[uv 公式ドキュメント](https://docs.astral.sh/uv/getting-started/installation/)に沿って各種ダウンロード・インストールを進めてください。例として、以下のコマンドは MacOS 上に `uv` をインストールします。

```sh
curl -LsSf https://astral.sh/uv/install.sh | sh
```

### 3. パッケージのインストール

```sh
uv sync
```

## 💪🏻 コントリビューションを検討されている方へ

詳細は [CONTRIBUTING.md](./CONTRIBUTING.md) を参照してください。
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
[![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.
Monorepo of JPYC Python SDKs. => 日本語版は[こちら](./README-jp.md)。

## 💫 Available SDKs

Please refer to `README`s of respective SDKs for more details.
Please refer to `README`s of the respective SDKs for more details.

| name | `README` |
| --------------: | :----------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Run the following commands that generate a collection of documents under [`./doc
# cd into the root directory
$ cd python-sdk
# generate documentation from the google-styled docstrings
$ uv run pdoc ./packages/core/jpyc-core-sdk -o ./docs/core -d google
$ uv run pdoc ./packages/core/jpyc_core_sdk -o ./docs/core -d google
```

## 🔍 UI
Expand Down
Loading