diff --git a/PIPRELEASEDOC.md b/PIPRELEASEDOC.md index 68c87142..eb70387a 100644 --- a/PIPRELEASEDOC.md +++ b/PIPRELEASEDOC.md @@ -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) \ No newline at end of file +[![Chat on discord](https://img.shields.io/badge/join%20-discord-brightgreen.svg)](https://discord.com/invite/swanchain) \ No newline at end of file diff --git a/README.md b/README.md index c41e7f61..acee5c21 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. @@ -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 @@ -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. diff --git a/setup.py b/setup.py index 632c5f1b..c6d8257e 100644 --- a/setup.py +++ b/setup.py @@ -7,8 +7,8 @@ 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, @@ -16,8 +16,8 @@ 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",