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
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@ We appreciate your interest to contribute to this project! Please read the follo

## 📝 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.
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.

## ⬇️ Clone This Repo

Next, clone this repository. Our default branch is set to `develop`.
Next, clone this repository on `develop` branch.

> [!TIP]
> Our default branch is set to `main`.

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

## ⚡ Checkout to a New Branch
Expand Down
8 changes: 4 additions & 4 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ A Python SDK to interact with [the JPYCv2's core contracts](https://github.com/j

## 🪄 Usage

### 1. Install `jpyc_core_sdk` Package
### 1. Install `jpyc-core-sdk` Package

```sh
# uv
$ uv add jpyc_core_sdk
$ uv add jpyc-core-sdk
# poetry
$ poetry add jpyc_core_sdk
$ poetry add jpyc-core-sdk
# pip
$ pip install jpyc_core_sdk
$ pip install jpyc-core-sdk
```

### 2. Configure SDK Clients
Expand Down
2 changes: 1 addition & 1 deletion packages/core/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "jpyc-core-sdk"
version = "1.0.4"
version = "1.0.5"
requires-python = ">=3.12"
license = "MIT"
description = "A Python SDK for interacting with JPYCv2 contracts"
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "jpyc-python-sdks"
version = "1.0.4"
version = "1.0.5"
requires-python = ">=3.12"
description = "Python SDKs for JPYC protocols"
readme = "README.md"
Expand Down
4 changes: 2 additions & 2 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.