Metadata-Version: 2.1
Name: OpenFrpLib
Version: 1.1.0
Summary: UNKNOWN
Home-page: https://github.com/LxHTT/OpenFrpLib
Author: LxHTT
Author-email: lxhtt@vip.qq.com
License: MIT
Project-URL: Documentation, https://github.com/LxHTT/OpenFrpLib/blob/master/README.md
Project-URL: Source Code, https://github.com/LxHTT/OpenFrpLib
Project-URL: Bug Tracker, https://github.com/LxHTT/OpenFrpLib/issues
Description: ## OpenFrpLib
        <p align="right">based on OpenFrp OPENAPI<br>presented by LxHTT</p>
        
        这是一个封装了OpenFrp OPENAPI的Python库。
        
        ### 安装
        ___
        ```command
        pip install OpenFrpLib
        ```
        
        ### 开始使用  
        ___
        #### 导入  
        ```python
        import OpenFrpLib
        ```
        #### 设置是否绕过系统代理  
        ```python
        from OpenFrpLib import BYPASS_SYSTEM_PROXY
        
        BYPASS_SYSTEM_PROXY(True) # True为开启绕过, False不绕过
        ```
        #### 登录  
        ```python
        from OpenFrpLib import login
        
        # 用一个列表存取，方便记录SessionID和Authorization
        LoginInfo = login(user="用户名或邮箱", password="密码")
        ```
        #### 获取用户信息  
        ```python
        from OpenFrpLib import getUserInfo
        
        getUserInfo(Authorization="Authorization内容", session="Session ID")
        ```
        #### 获取用户隧道列表  
        ```python
        from OpenFrpLib import getUserProxies
        
        getUserProxies(Authorization="Authorization内容", session="Session ID")
        ```
        #### 新建隧道  
        ```python
        from OpenFrpLib import newProxy
        # 含有Optional为可选
        newProxy(Authorization: str,
                 session: str,
                 node_id: int,
                 type: str,
                 remote_port: int,
                 local_addr: Optional[str] = "127.0.0.1",
                 local_port: Optional[int] = 25565,
                 domain_bind: Optional[str] = "",
                 host_rewrite: Optional[str] = "",
                 request_from: Optional[str] = "",
                 custom: Optional[str] = "",
                 dataGzip: Optional[bool] = False,
                 dataEncrypt: Optional[bool] = False,
                 url_route: Optional[str] = "",
                 name: Optional[str] = f"OfApp_{randint(30000, 99999)}",
                 request_pass: Optional[str] = ""
                )
        ```
        #### 删除隧道  
        ```python
        from OpenFrpLib import removeProxy
        # 含有Optional为可选
        removeProxy(Authorization="Authorization内容", session="Session ID", proxy_id="隧道ID")
        ```
        #### 获取节点列表  
        ```python
        from OpenFrpLib import getNodeList
        # 含有Optional为可选
        getNodeList(Authorization="Authorization内容", session="Session ID")
        ```
        #### 编辑隧道  
        ```python
        from OpenFrpLib import editProxy
        # 含有Optional为可选
        editProxy(Authorization: str,
                  session: str,
                  node_id: int,
                  type: str,
                  remote_port: int,
                  proxy_id: int,
                  local_addr: Optional[str] = "127.0.0.1",
                  local_port: Optional[int] = 25565,
                  domain_bind: Optional[str] = "",
                  custom: Optional[str] = "",
                  dataGzip: Optional[bool] = False,
                  dataEncrypt: Optional[bool] = False,
                  name: Optional[str] = f"OfApp_{randint(30000, 99999)}"
                 )
        ```
        #### 签到  
        ```python
        from OpenFrpLib import userSign
        
        userSign(Authorization="Authorization内容", session="Session ID")
        ```
        ##### 警告  
        请勿设计任何有关自动签到的相关功能，因为这是违反服务条款的行为，自动签到为滥用行为行为之一。
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
