Metadata-Version: 2.1
Name: PyGrassClient
Version: 2.0.1
Summary: Get Grass Python Package
Home-page: https://github.com/Confusion-ymc/PyGrassClient
Author: confusion
Author-email: 1107238486@qq.com
License: Apache-2.0
Project-URL: Documentation, https://github.com/Confusion-ymc/PyGrassClient
Project-URL: Source, https://github.com/Confusion-ymc/PyGrassClient
Platform: all
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: websocket-client==1.7.0
Requires-Dist: loguru==0.7.2
Requires-Dist: python-socks==2.4.4

# Get Grass Python Package
[![PyPi Version](https://img.shields.io/pypi/v/PyGrassClient?color=green)](https://pypi.python.org/pypi/PyGrassClient/)
[![Build Sphinx docs)](https://github.com/Confusion-ymc/PyGrassClient/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Confusion-ymc/PyGrassClient/actions/workflows/python-publish.yml)

**This is a python package for get grass score.**

## 1. 安装
```
pip3 install PyGrassClient
```
## 2. 使用
### **1. 单账号运行**
 ```
 #!/usr/bin/env python
 
 from PyGrassClient import PyGrassClient
 # 只需要userid 或者 账号密码
 asyncio.run(PyGrassClient(user_id="${userid}", user_name="${user_name}", password="${password}",proxy_url='${proxy_url}').connect_ws())
 ```
### **2. 多账号运行**
 ```
 #!/usr/bin/env python
 
 from PyGrassClient import run_by_file
 
 run_by_file('accounts.txt')
 ```

### **3. Docker运行**
 
1. `git clone https://github.com/Confusion-ymc/PyGrassClient.git`
2. 添加`account.txt`文件
3. `docker compose up --build -d`

### 4. account.txt 文件格式
- 不配置代理
  - **每一行是一个账号配置** 
  - **没有代理则直接是`user_id`为一行，----- 格式为`5242367b-d366-1234-987a-9ebd303fa8f5`**
  - **如果不知道`user_id`, 就用账号和密码----格式为`test@qq.com---Aa@password`**
- 配置代理
  - **如果使用代理则在后面加上`==代理连接`----格式为`5242367b-d366-1258-987a-9ebd303fa8f5==socks5://proxy.com:1080`**


- 例如：
 ```text
5242367b-d366-1234-987a-9ebd303fa8f5==http://proxy.com:8080
5242367b-d366-1234-987a-9ebd303fa8f5
test@qq.com---Aa@password 
5242367b-d366-1258-987a-9ebd303fa8f5==socks5://proxy.com:1080
 ```
