Skip to content

Commit

Permalink
Merge branch 'release/v0.0.2' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
PlutoNbai authored May 4, 2024
2 parents 05c8c89 + 72f318b commit c2a7d6c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 17 deletions.
2 changes: 1 addition & 1 deletion PIPRELEASEDOC.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[![Made by FilSwan](https://img.shields.io/badge/made%20by-FilSwan-green.svg)](https://www.filswan.com/)
[![Chat on discord](https://img.shields.io/badge/join%20-discord-brightgreen.svg)](https://discord.com/invite/KKGhy8ZqzK)
[![Chat on discord](https://img.shields.io/badge/join%20-discord-brightgreen.svg)](https://discord.com/invite/swanchain)
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# PYTHON SWAN SDK

[![Made by FilSwan](https://img.shields.io/badge/made%20by-FilSwan-green.svg)](https://www.filswan.com/)
[![Chat on discord](https://img.shields.io/badge/join%20-discord-brightgreen.svg)](https://discord.com/invite/KKGhy8ZqzK)
[![Chat on discord](https://img.shields.io/badge/join%20-discord-brightgreen.svg)](https://discord.com/invite/swanchain)

## Table Of Contents

Expand Down Expand Up @@ -29,6 +29,8 @@

The PYTHON SWAN SDK is a comprehensive toolkit designed to facilitate seamless interactions with the SwanChain API. Tailored for developers, this SDK simplifies the creation and management of computational tasks (CP tasks), making it an indispensable tool for developers working in various tech domains.

GitHub Link: https://github.com/swanchain/python-swan-sdk/tree/release/v0.0.2

## Features

- **API Client Integration**: Streamline your development workflow with our intuitive API client.
Expand All @@ -45,21 +47,22 @@ To use Python Swan SDK, use Python 3.8 or later. Earlier versions are not suppor
**Install via PyPI:**

```bash
pip install swan-sdk
pip install swan-sdk==0.0.2
```

**Clone from GitHub:**

```bash
git clone https://github.com/swanchain/orchestrator-sdk.git
git checkout release/v0.0.2
```

## Use Python dotenv

It is recommended to store your important personal information in configuration or as environmental variables. Python dotenv allows loading environment variables from `.env` files for easier access and better security.

python-dotenv package: https://pypi.org/project/python-dotenv/
Detailed instructions: https://github.com/swanchain/python-swan-sdk/tree/dev/docs/configuration.md
python-dotenv package: https://pypi.org/project/python-dotenv/ \
Detailed instructions: https://github.com/swanchain/python-swan-sdk/tree/release/v0.0.2/docs/configuration.md

## Quick Start Guide for Swan SDK

Expand Down Expand Up @@ -246,17 +249,12 @@ print(r)
```

## Examples

For executable examples consult https://github.com/swanchain/python-swan-sdk/tree/dev/examples
For executable examples consult https://github.com/swanchain/python-swan-sdk/tree/release/v0.0.2/examples

## Documentation

For comprehensive documentation, including detailed installation guides, usage examples, and complete API references, please consult https://github.com/swanchain/python-swan-sdk/tree/dev/docs

## Contributions

We welcome and encourage community contributions! Please refer to our **CONTRIBUTING.md** for guidelines on how to contribute effectively.
For comprehensive documentation, including detailed installation guides, usage examples, and complete API references, please consult https://github.com/swanchain/python-swan-sdk/tree/release/v0.0.2/docs

## License

The PYTHON SWAN SDK is released under the **MIT-FilSwan** license, details of which can be found in the LICENSE file.
The PYTHON SWAN SDK is released under the **MIT** license, details of which can be found in the LICENSE file.
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@
long_description = fh.read()

setup(
name="swan-sdk",
version="0.0.1",
name="orchestrator-sdk",
version="0.0.2",
packages=['swan.api', 'swan.common', 'swan.contract', 'swan.object', 'swan.contract.abi'],
# package_data={'swan.contract.abi': ['swan/contract/abi/PaymentContract.json', 'swan/contract/abi/SwanToken.json']},
include_package_data=True,
description="A python developer tool kit for Swan Orchestrator services.",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/swanchain/orchestrator-sdk",
author="SwanCloud",
author_email="swan.development@nbai.io",
author="ZihangChenNBAI",
author_email="zhchen@nbai.io",
license="MIT",
classifiers=[
"License :: OSI Approved :: MIT License",
Expand Down

0 comments on commit c2a7d6c

Please sign in to comment.