Skip to content

Commit 6ce197e

Browse files
Update wrong sdk github repository link (#112)
* Add AGENTS guidelines document - Create AGENTS.md for project guidelines - Outline project structure and code style - Include sample usage examples - Provide build and installation instructions - Mention language support for documentation * Update project URLs to correct casing - Change Homepage URL casing - Change Documentation URL casing - Change Repository URL casing - Change Issues URL casing * fix(version): bump version to 0.7.10 - Update version in pyproject.toml * chore: remove Documentation URL from pyproject.toml - Removed Documentation URL entry from project.urls --------- Co-authored-by: Haihui.Wang <wanghh2000@163.com>
1 parent db717e7 commit 6ce197e

2 files changed

Lines changed: 44 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# AGENTS Guidelines
2+
3+
The CSGHub SDK is a powerful Python client specifically designed to interact seamlessly with the CSGHub server. This toolkit is engineered to provide Python developers with an efficient and straightforward method to operate and manage remote CSGHub instances. Whether you're looking to automate tasks, manage data, or integrate CSGHub functionalities into your Python applications, the CSGHub SDK offers a comprehensive set of features to accomplish your goals with ease.
4+
5+
# Structure
6+
7+
This is standard python project and can be upload to PYPI.
8+
9+
- **doc** is documents for how to use python sdk.
10+
- **pycsghub** is all code for function logic.
11+
- **pycsghub/cmd** is command line definition.
12+
- **pycssghub/constants.py** is for save all constants variable.
13+
14+
## Code Style & Conventions
15+
16+
- Cods must following python standard code style.
17+
- Use rest api for invoke remote api server.
18+
- Must add log for function execute.
19+
- All sdk command line must support show help to explain parameters.
20+
21+
## samples
22+
23+
- `examples/download_dataset.py` is for download dataset by sdk.
24+
- `examples/download_file.py` is for download file from csghub by sdk.
25+
- `examples/download_model.py` is for download model from csghub by sdk.
26+
- `examples/load_dataset.py` is for load dataset from local by sdk.
27+
- `examples/upload_ifle.py` is for upload file to remote server.
28+
- `examples/upload_large_folder.py` is for upload large folder by sdk.
29+
- `examples/upload_repo.py` is for upload local file to remote repo.
30+
31+
## Build
32+
33+
- Use `uv pip install .` to install sdk locally.
34+
- Use `python setup.py check` to check the python package.
35+
- Use `python setup.py sdist bdist_wheel` to build python package for new version.
36+
37+
## Specific Instructions
38+
39+
- There are 2 languages help documents in English and Chinese.
40+
- Update document by new feature code changes.

pyproject.toml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "csghub-sdk"
7-
version = "0.7.9"
7+
version = "0.7.10"
88
description = "CSGHub SDK for downloading and uploading models, datasets, and spaces"
99
readme = "README.md"
1010
license = { text = "Apache-2.0" }
@@ -45,10 +45,9 @@ train = [
4545
csghub-cli = "pycsghub.cli:app"
4646

4747
[project.urls]
48-
Homepage = "https://github.com/opencsg/csghub-sdk"
49-
Documentation = "https://github.com/opencsg/csghub-sdk"
50-
Repository = "https://github.com/opencsg/csghub-sdk"
51-
Issues = "https://github.com/opencsg/csghub-sdk/issues"
48+
Homepage = "https://github.com/OpenCSGs/csghub-sdk"
49+
Repository = "https://github.com/OpenCSGs/csghub-sdk"
50+
Issues = "https://github.com/OpenCSGs/csghub-sdk"
5251

5352
[tool.setuptools.packages.find]
5453
include = ["pycsghub*"]

0 commit comments

Comments
 (0)