├── src ├── __init__.py └── hugchat │ ├── __init__.py │ ├── exceptions.py │ ├── cli.py │ ├── login.py │ └── hugchat.py ├── .gitignore ├── setup.py ├── README_cn.md ├── README.md └── LICENSE /src/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/hugchat/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | .venv 3 | cookies.json 4 | test.py 5 | dist/* 6 | *.egg-info -------------------------------------------------------------------------------- /src/hugchat/exceptions.py: -------------------------------------------------------------------------------- 1 | class ModelOverloadedError(Exception): 2 | """ 3 | HF Model Overloaded Error 4 | 5 | Raised when hf return response `{"error":"Model is overloaded","error_type":"overloaded"}` 6 | """ 7 | pass 8 | 9 | 10 | class ChatBotInitError(Exception): 11 | """ 12 | ChatBot Init Error 13 | 14 | Raised when chatbot init failed 15 | """ 16 | pass 17 | 18 | 19 | class CreateConversationError(Exception): 20 | """ 21 | Create Conversation Error 22 | 23 | Raised when create conversation failed 24 | """ 25 | pass 26 | 27 | 28 | class InvalidConversationIDError(Exception): 29 | """ 30 | Invalid Conversation ID Error 31 | 32 | Raised when using a invalid conversation id 33 | """ 34 | pass 35 | 36 | 37 | class DeleteConversationError(Exception): 38 | """ 39 | Delete Conversation Error 40 | 41 | Raised when delete conversation failed 42 | """ 43 | pass 44 | 45 | 46 | class ChatError(Exception): 47 | """ 48 | Chat Error 49 | 50 | Raised when chat failed 51 | """ 52 | pass 53 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import find_namespace_packages 2 | from setuptools import setup 3 | 4 | setup( 5 | name="hugchat", 6 | version="0.0.7.1", 7 | description="A huggingchat python api.", 8 | long_description=open("README.md", "rt", encoding="utf-8").read(), 9 | long_description_content_type="text/markdown", 10 | url="https://github.com/Soulter/hugging-chat-api", 11 | project_urls={ 12 | "Bug Report": "https://github.com/Soulter/hugging-chat-api/issues" 13 | }, 14 | author="Soulter", 15 | author_email="905617992@qq.com", 16 | license="GNU Affero General Public License v3.0", 17 | packages=find_namespace_packages("src"), 18 | package_dir={"": "src"}, 19 | py_modules=["hugchat"], 20 | package_data={"": ["*.json"]}, 21 | install_requires=[ 22 | "requests", 23 | "requests_toolbelt", 24 | ], 25 | classifiers=[ 26 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 27 | "Intended Audience :: Developers", 28 | "Intended Audience :: End Users/Desktop", 29 | "Natural Language :: English", 30 | "Topic :: Software Development :: Libraries :: Python Modules", 31 | "Programming Language :: Python :: 3 :: Only", 32 | "Programming Language :: Python :: 3.6", 33 | "Programming Language :: Python :: 3.7", 34 | "Programming Language :: Python :: 3.8", 35 | "Programming Language :: Python :: 3.9", 36 | "Programming Language :: Python :: 3.10", 37 | "Programming Language :: Python :: 3.11", 38 | ], 39 | ) -------------------------------------------------------------------------------- /README_cn.md: -------------------------------------------------------------------------------- 1 | # hugging-chat-api 2 | 3 | [English](README.md) | 简体中文 4 | 5 | HuggingChat Python API 6 | 7 | [![PyPi](https://img.shields.io/pypi/v/hugchat.svg)](https://pypi.python.org/pypi/hugchat) 8 | [![Support_Platform](https://img.shields.io/pypi/pyversions/hugchat)](https://pypi.python.org/pypi/hugchat) 9 | [![Downloads](https://static.pepy.tech/badge/hugchat)](https://pypi.python.org/pypi/hugchat) 10 | 11 | 给个星先😋 12 | 13 | ## 鉴权 (必需) 14 | 15 | ### 获取Cookies 16 | 17 | ```python 18 | from hugchat.login import Login 19 | 20 | # 登录 21 | sign = Login(email, passwd) 22 | cookies = sign.login() 23 | sign.saveCookies() 24 | 25 | # 从 usercookies/.json 中加载已保存的cookies 26 | sign = login(email, None) 27 | cookies = sign.loadCookies() # 这个方法会查询保存cookies的文件是否存在，存在就返回cookies，不存在就报错 28 | 29 | ``` 30 | 31 | ## 使用方式 32 | 33 | ### Python调用 34 | 35 | ```bash 36 | pip install hugchat 37 | ``` 38 | 39 | ```py 40 | from hugchat import hugchat 41 | from hugchat.login import Login 42 | 43 | # 登入huggingface授权huggingchat 44 | sign = Login(email, passwd) 45 | cookies = sign.login() 46 | 47 | # 保存cookies至 usercookies/.json 48 | sign.saveCookies() 49 | 50 | # 创建一个 ChatBot 51 | chatbot = hugchat.ChatBot(cookies=cookies.get_dict()) # or cookie_path="usercookies/.json" 52 | print(chatbot.chat("HI")) 53 | 54 | # 创建一个新会话 55 | id = chatbot.new_conversation() 56 | chatbot.change_conversation(id) 57 | 58 | # 获取对话列表 59 | conversation_list = chatbot.get_conversation_list() 60 | ``` 61 | 62 | `chat()` 函数接收以下参数: 63 | 64 | - `text`: Required[str]. 65 | - `temperature`: Optional[float]. Default is 0.9 66 | - `top_p`: Optional[float]. Default is 0.95 67 | - `repetition_penalty`: Optional[float]. Default is 1.2 68 | - `top_k`: Optional[int]. Default is 50 69 | - `truncate`: Optional[int]. Default is 1024 70 | - `watermark`: Optional[bool]. Default is False 71 | - `max_new_tokens`: Optional[int]. Default is 1024 72 | - `stop`: Optional[list]. Default is ["``"] 73 | - `return_full_text`: Optional[bool]. Default is False 74 | - `stream`: Optional[bool]. Default is True 75 | - `use_cache`: Optional[bool]. Default is False 76 | - `is_retry`: Optional[bool]. Default is False 77 | - `retry_count`: Optional[int]. Number of retries for requesting huggingchat. Default is 5 78 | 79 | ### 命令行交互 80 | 81 | > `0.0.5.2` 或更高版本 82 | 83 | 使用以下命令启动命令行交互模式 84 | 85 | ```bash 86 | python -m hugchat.cli 87 | ``` 88 | 89 | CLI模式中的命令： 90 | 91 | - `/new` : 创建一个新的会话 92 | - `/ids` : 查看会话列表 93 | - `/switch ` : 切换到指定会话 94 | - `/exit` : 退出CLI模式 95 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # hugging-chat-api 2 | 3 | English | [简体中文](README_cn.md) 4 | 5 | HuggingChat Python API 6 | 7 | [![PyPi](https://img.shields.io/pypi/v/hugchat.svg)](https://pypi.python.org/pypi/hugchat) 8 | [![Support_Platform](https://img.shields.io/pypi/pyversions/hugchat)](https://pypi.python.org/pypi/hugchat) 9 | [![Downloads](https://static.pepy.tech/badge/hugchat)](https://pypi.python.org/pypi/hugchat) 10 | 11 | Leave a star :) 12 | 13 | > When you use this project, it means that you have agreed to the following two requirements of the HuggingChat: 14 | > 15 | > 1. AI is an area of active research with known problems such as biased generation and misinformation. Do not use this application for high-stakes decisions or advice. 16 | > 2. Your conversations will be shared with model authors. 17 | 18 | **Server resources are precious, it is not recommended to request this API in a high frequency.** 19 | 20 | (`Hugging Face's CTO🤗` just liked the suggestion) 21 | 22 |
23 | 24 | ## Authentication (Required Now) 25 | 26 | ### Get Cookies 27 | 28 | ```python 29 | from hugchat.login import Login 30 | 31 | # login 32 | sign = Login(email, passwd) 33 | cookies = sign.login() 34 | sign.saveCookies() 35 | 36 | # load cookies from usercookies/.json 37 | sign = login(email, None) 38 | cookies = sign.loadCookies() # This will detect if the JSON file exists, return cookies if it does and raise an Exception if it's not. 39 | ``` 40 | 41 | ## Usage 42 | 43 | ### Basic mode 44 | 45 | ```bash 46 | pip install hugchat 47 | ``` 48 | 49 | ```py 50 | from hugchat import hugchat 51 | from hugchat.login import Login 52 | 53 | # Log in to huggingface and grant authorization to huggingchat 54 | sign = Login(email, passwd) 55 | cookies = sign.login() 56 | 57 | # Save cookies to usercookies/.json 58 | sign.saveCookies() 59 | 60 | # Create a ChatBot 61 | chatbot = hugchat.ChatBot(cookies=cookies.get_dict()) # or cookie_path="usercookies/.json" 62 | print(chatbot.chat("HI")) 63 | 64 | # Create a new conversation 65 | id = chatbot.new_conversation() 66 | chatbot.change_conversation(id) 67 | 68 | # Get conversation list 69 | conversation_list = chatbot.get_conversation_list() 70 | ``` 71 | 72 | The `chat()` function receives these parameters: 73 | 74 | - `text`: Required[str]. 75 | - `temperature`: Optional[float]. Default is 0.9 76 | - `top_p`: Optional[float]. Default is 0.95 77 | - `repetition_penalty`: Optional[float]. Default is 1.2 78 | - `top_k`: Optional[int]. Default is 50 79 | - `truncate`: Optional[int]. Default is 1024 80 | - `watermark`: Optional[bool]. Default is False 81 | - `max_new_tokens`: Optional[int]. Default is 1024 82 | - `stop`: Optional[list]. Default is ["``"] 83 | - `return_full_text`: Optional[bool]. Default is False 84 | - `stream`: Optional[bool]. Default is True 85 | - `use_cache`: Optional[bool]. Default is False 86 | - `is_retry`: Optional[bool]. Default is False 87 | - `retry_count`: Optional[int]. Number of retries for requesting huggingchat. Default is 5 88 | 89 | ### CLI mode 90 | 91 | > `version 0.0.5.2` or newer 92 | 93 | Simply run the following command in your terminal to start the CLI mode 94 | 95 | ```bash 96 | python -m hugchat.cli 97 | ``` 98 | 99 | Commands in cli mode: 100 | 101 | - `/new` : Create and switch to a new conversation. 102 | - `/ids` : Shows a list of all ID numbers and ID strings in current session. 103 | - `/switch ` : Switches to the ID number passed. 104 | - `/exit` : Closes CLI environment. 105 | 106 | ## Disclaimers 107 | 108 | This is not an official [Hugging Face](https://huggingface.co/) product. This is a **personal project** and is not affiliated with [Hugging Face](https://huggingface.co/) in any way. Don't sue us. 109 | -------------------------------------------------------------------------------- /src/hugchat/cli.py: -------------------------------------------------------------------------------- 1 | """Entry for the hugchat command line interface. 2 | 3 | simply type 4 | ```bash 5 | python -m hugchat.cli 6 | ``` 7 | to start cli. 8 | """ 9 | 10 | from .hugchat import ChatBot 11 | from .login import Login 12 | import getpass 13 | import argparse 14 | 15 | EMAIL = "" 16 | PASSWD = "" 17 | CHECK_BEFORE_PASSWORD = True 18 | 19 | def cli(): 20 | global EMAIL 21 | global PASSWD 22 | global CHECK_BEFORE_PASSWORD 23 | print("-------HuggingChat-------") 24 | print("Official Site: https://huggingface.co/chat") 25 | print("1. AI is an area of active research with known problems such as biased generation and misinformation. Do not use this application for high-stakes decisions or advice.\n2. Your conversations will be shared with model authors.\nContinuing to use means that you accept the above points") 26 | parser = argparse.ArgumentParser() 27 | parser.add_argument( 28 | "-u", 29 | type=str, 30 | help="Your huggingface account's email" 31 | ) 32 | parser.add_argument( 33 | "-p", 34 | action="store_true", 35 | help="Require Password to login" 36 | ) 37 | args = parser.parse_args() 38 | email = args.u 39 | inputpass = args.p 40 | cookies = None 41 | if CHECK_BEFORE_PASSWORD: 42 | if not email: 43 | email = EMAIL 44 | try: 45 | cookies = Login(email, None).loadCookies() 46 | except Exception as e: 47 | pass 48 | if not cookies or inputpass: 49 | if not email: 50 | if EMAIL: 51 | if not PASSWD or inputpass: 52 | PASSWD = getpass.getpass("Password: ") 53 | email = EMAIL 54 | passwd = PASSWD 55 | else: 56 | raise Exception("No email specified. Please use '-u' or set it in cli.py") 57 | else: 58 | if inputpass or not PASSWD: 59 | passwd = getpass.getpass("Password: ") 60 | else: 61 | passwd = PASSWD 62 | 63 | print(f"Sign in as :{email}") 64 | sign = Login(email, passwd) 65 | try: 66 | cookies = sign.loadCookies() 67 | except Exception as e: 68 | print(e) 69 | print("Logging in...") 70 | cookies = sign.login() 71 | sign.saveCookies() 72 | 73 | chatbot = ChatBot(cookies=cookies) 74 | running = True 75 | while running: 76 | question = input("> ") 77 | if question == "/new": 78 | cid = chatbot.new_conversation() 79 | print("The new conversation ID is: " + cid) 80 | chatbot.change_conversation(cid) 81 | print("Conversation changed successfully.") 82 | continue 83 | 84 | elif question.startswith("/switch"): 85 | try: 86 | conversations = chatbot.get_conversation_list() 87 | conversation_id = str(question.split(" ")[1] if len(question.split(" ")) > 1 else "") 88 | if conversation_id not in conversations: 89 | print("# Please enter a valid ID number.") 90 | print(f"# Sessions include: {conversations}") 91 | else: 92 | chatbot.change_conversation(conversation_id) 93 | print(f"# Conversation switched successfully to {conversation_id}") 94 | except ValueError: 95 | print("# Please enter a valid ID number\n") 96 | 97 | 98 | 99 | elif question == "/ids": 100 | id_list = list(chatbot.get_conversation_list()) 101 | [print(f"{id_list.index(i)+1} : {i}{' ' if chatbot.current_conversation == i else ''}") for i in id_list] 102 | 103 | elif question in ["/exit", "/quit","/close"]: 104 | running = False 105 | 106 | elif question.startswith("/"): 107 | print("# Invalid command") 108 | 109 | elif question == "": 110 | pass 111 | 112 | else: 113 | res = chatbot.chat(question) 114 | print("< " + res) 115 | 116 | 117 | if __name__ == '__main__': 118 | cli() 119 | -------------------------------------------------------------------------------- /src/hugchat/login.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import os 3 | import json 4 | import logging 5 | import re 6 | 7 | 8 | class Login: 9 | def __init__(self, email: str, passwd: str) -> None: 10 | self.COOKIE_DIR = os.path.dirname(os.path.abspath(__file__)) + "/usercookies" 11 | self.COOKIE_PATH = self.COOKIE_DIR + f"/{email}.json" 12 | if not os.path.exists(self.COOKIE_DIR): 13 | logging.debug("Cookie directory not found, creating...") 14 | os.makedirs(self.COOKIE_DIR) 15 | logging.debug(f"Cookie store path: {self.COOKIE_DIR}") 16 | 17 | self.email: str = email 18 | self.passwd: str = passwd 19 | self.headers = { 20 | "Referer": "https://huggingface.co/", 21 | "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36 Edg/112.0.1722.64", 22 | } 23 | self.cookies = requests.sessions.RequestsCookieJar() 24 | 25 | def requestsGet(self, url:str, params=None, allow_redirects=True) -> requests.Response: 26 | res = requests.get( 27 | url, 28 | params=params, 29 | headers=self.headers, 30 | cookies=self.cookies, 31 | allow_redirects=allow_redirects, 32 | ) 33 | self.refreshCookies(res.cookies) 34 | return res 35 | 36 | def requestsPost(self, url:str, headers=None, params=None, data=None, stream=False, allow_redirects=True) -> requests.Response: 37 | res = requests.post( 38 | url, 39 | stream=stream, 40 | params=params, 41 | data=data, 42 | headers=self.headers if headers == None else headers, 43 | cookies=self.cookies, 44 | allow_redirects=allow_redirects 45 | ) 46 | self.refreshCookies(res.cookies) 47 | return res 48 | 49 | def refreshCookies(self, cookies:requests.sessions.RequestsCookieJar): 50 | dic = cookies.get_dict() 51 | for i in dic: 52 | self.cookies.set(i, dic[i]) 53 | 54 | def SigninWithEmail(self): 55 | """ 56 | Login through your email and password. 57 | PS: I found that it doesn't have any type of encrytion till now, 58 | which could expose your password to the internet. 59 | """ 60 | url = "https://huggingface.co/login" 61 | data = { 62 | "username": self.email, 63 | "password": self.passwd, 64 | } 65 | res = self.requestsPost(url=url, data=data, allow_redirects=False) 66 | if res.status_code == 400: 67 | raise Exception("wrong username or password") 68 | 69 | def getAuthURL(self): 70 | url = "https://huggingface.co/chat/login" 71 | headers = { 72 | "Referer": "https://huggingface.co/chat/login", 73 | "User-Agent": self.headers["User-Agent"], 74 | "Content-Type": "application/x-www-form-urlencoded" 75 | } 76 | res = self.requestsPost(url, headers=headers, allow_redirects=False) 77 | if res.status_code == 200: 78 | # location = res.headers.get("Location", None) 79 | location = res.json()["location"] 80 | if location: 81 | return location 82 | else: 83 | raise Exception("No authorize url found, please check your email or password.") 84 | elif res.status_code == 303: 85 | location = res.headers.get("Location") 86 | if location: 87 | return location 88 | else: 89 | raise Exception("No authorize url found, please check your email or password.") 90 | else: 91 | raise Exception("Something went wrong!") 92 | 93 | def grantAuth(self, url: str) -> int: 94 | """ 95 | Grant auth to huggingchat after login process is done. 96 | """ 97 | res = self.requestsGet(url) 98 | if res.status_code != 200: 99 | raise Exception("Grant auth fatal!") 100 | csrf = re.findall('/oauth/authorize.*?name="csrf" value="(.*?)"', res.text) 101 | if len(csrf) == 0: 102 | raise Exception("No csrf found!") 103 | data = { 104 | "csrf":csrf[0] 105 | } 106 | 107 | res = self.requestsPost(url, data=data, allow_redirects=False) 108 | if res.status_code != 303: 109 | raise Exception(f"get hf-chat cookies fatal! - {res.status_code}") 110 | else: 111 | location = res.headers.get("Location") 112 | res = self.requestsGet(location, allow_redirects=False) 113 | if res.status_code != 302: 114 | raise Exception(f"get hf-chat cookie fatal! - {res.status_code}") 115 | else: 116 | return 1 117 | 118 | def login(self) -> requests.sessions.RequestsCookieJar: 119 | self.SigninWithEmail() 120 | location = self.getAuthURL() 121 | if self.grantAuth(location): 122 | return self.cookies 123 | else: 124 | raise Exception(f"Grant auth fatal, please check your email or password\ncookies gained: \n{self.cookies}") 125 | 126 | def saveCookies(self) -> str: 127 | with open(self.COOKIE_PATH, "w", encoding="utf-8") as f: 128 | f.write(json.dumps(self.cookies.get_dict(), ensure_ascii=False)) 129 | return self.COOKIE_PATH 130 | 131 | def loadCookies(self) -> requests.sessions.RequestsCookieJar: 132 | if os.path.exists(self.COOKIE_PATH): 133 | with open(self.COOKIE_PATH, "r", encoding="utf-8") as f: 134 | try: 135 | js:dict = json.loads(f.read()) 136 | for i in js.keys(): 137 | self.cookies.set(i, js[i]) 138 | logging.debug(f"{i} loaded") 139 | return self.cookies 140 | except: 141 | raise Exception("Load cookies from json file fatal. Error while parsing json file") 142 | else: 143 | raise Exception(f"{self.COOKIE_PATH} doesn't seem to exist") 144 | -------------------------------------------------------------------------------- /src/hugchat/hugchat.py: -------------------------------------------------------------------------------- 1 | from requests import Session 2 | import requests 3 | import json 4 | import os 5 | import uuid 6 | import logging 7 | import re 8 | import getpass 9 | 10 | from .exceptions import * 11 | 12 | class ChatBot: 13 | 14 | cookies: dict 15 | """Cookies for authentication""" 16 | 17 | session: Session 18 | """HuggingChat session""" 19 | 20 | def __init__( 21 | self, 22 | cookies: dict = None, 23 | cookie_path: str = "" 24 | ) -> None: 25 | if cookies is None and cookie_path == "": 26 | raise ChatBotInitError("Authentication is required now, but no cookies provided") 27 | elif cookies is not None and cookie_path != "": 28 | raise ChatBotInitError("Both cookies and cookie_path provided") 29 | 30 | if cookies is None and cookie_path != "": 31 | # read cookies from path 32 | if not os.path.exists(cookie_path): 33 | raise ChatBotInitError(f"Cookie file {cookie_path} not found. Note: The file must be in JSON format and must contain a list of cookies. See more at https://github.com/Soulter/hugging-chat-api") 34 | with open(cookie_path, "r") as f: 35 | cookies = json.load(f) 36 | 37 | # convert cookies to KV format 38 | if isinstance(cookies, list): 39 | cookies = {cookie["name"]: cookie["value"] for cookie in cookies} 40 | 41 | self.cookies = cookies 42 | 43 | self.hf_base_url = "https://huggingface.co" 44 | self.json_header = {"Content-Type": "application/json"} 45 | self.session = self.get_hc_session() 46 | self.conversation_id_list = [] 47 | self.active_model = "OpenAssistant/oasst-sft-6-llama-30b-xor" 48 | self.accepted_welcome_modal = False # Only when accepted, it can create a new conversation. 49 | self.current_conversation = self.new_conversation() 50 | 51 | 52 | def get_hc_session(self) -> Session: 53 | session = Session() 54 | # set cookies 55 | session.cookies.update(self.cookies) 56 | session.get(self.hf_base_url + "/chat") 57 | return session 58 | 59 | def get_headers(self, ref=True) -> dict: 60 | _h = { 61 | "Accept": "*/*", 62 | "Connection": "keep-alive", 63 | "Host": "huggingface.co", 64 | "Origin": "https://huggingface.co", 65 | "sec-gpc": "1", 66 | "Sec-Fetch-Site": "same-origin", 67 | "Sec-Fetch-Mode": "cors", 68 | "Sec-Fetch-Dest": "empty", 69 | "Accept-Encoding": "gzip, deflate, br", 70 | "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36", 71 | } 72 | if ref: 73 | _h["Referer"] = f"https://huggingface.co/chat/conversation/{self.current_conversation}" 74 | return _h 75 | 76 | def get_cookies(self) -> dict: 77 | return self.session.cookies.get_dict() 78 | 79 | 80 | # NOTE: To create a copy when calling this, call it inside of list(). 81 | # If not, when updating or altering the values in the variable will 82 | # also be applied to this class's variable. 83 | # This behaviour is with any function returning self.. It 84 | # acts as a pointer to the data in the object. 85 | # 86 | # Returns a pointer to this objects list that contains id of conversations. 87 | def get_conversation_list(self) -> list: 88 | return list(self.conversation_id_list) 89 | 90 | def accept_ethics_modal(self): 91 | ''' 92 | [Deprecated Method] 93 | ''' 94 | response = self.session.post(self.hf_base_url + "/chat/settings", headers=self.get_headers(ref=False), cookies=self.get_cookies(), allow_redirects=True, data={ 95 | "ethicsModalAccepted": "true", 96 | "shareConversationsWithModelAuthors": "true", 97 | "ethicsModalAcceptedAt": "", 98 | "activeModel": str(self.active_model) 99 | }) 100 | 101 | if response.status_code != 200: 102 | raise Exception(f"Failed to accept ethics modal with status code {response.status_code}. {response.content.decode()}") 103 | 104 | return True 105 | 106 | def new_conversation(self) -> str: 107 | ''' 108 | Create a new conversation. Return the new conversation id. You should change the conversation by calling change_conversation() after calling this method. 109 | ''' 110 | err_count = 0 111 | 112 | # Accept the welcome modal when init. 113 | # 17/5/2023: This is not required anymore. 114 | # if not self.accepted_welcome_modal: 115 | # self.accept_ethics_modal() 116 | 117 | # Create new conversation and get a conversation id. 118 | resp = "" 119 | while True: 120 | try: 121 | resp = self.session.post(self.hf_base_url + "/chat/conversation", json={"model": self.active_model}, headers=self.json_header) 122 | # print(resp.text) 123 | logging.debug(resp.text) 124 | cid = json.loads(resp.text)['conversationId'] 125 | self.conversation_id_list.append(cid) 126 | return cid 127 | 128 | except BaseException as e: 129 | err_count += 1 130 | logging.debug(f" Failed to create new conversation. Retrying... ({err_count})") 131 | if err_count > 5: 132 | raise CreateConversationError(f"Failed to create new conversation. ({err_count})") 133 | continue 134 | 135 | def change_conversation(self, conversation_id: str) -> bool: 136 | ''' 137 | Change the current conversation to another one. Need a valid conversation id. 138 | ''' 139 | if conversation_id not in self.conversation_id_list: 140 | raise InvalidConversationIDError("Invalid conversation id, not in conversation list.") 141 | self.current_conversation = conversation_id 142 | return True 143 | 144 | 145 | def summarize_conversation(self, conversation_id: str = None) -> str: 146 | ''' 147 | Return a summary of the conversation. 148 | ''' 149 | if conversation_id is None: 150 | conversation_id = self.current_conversation 151 | 152 | headers = self.get_headers() 153 | 154 | r = self.session.post(f"{self.hf_base_url}/chat/conversation/{conversation_id}/summarize", headers=headers, cookies=self.get_cookies()) 155 | 156 | if r.status_code != 200: 157 | raise Exception(f"Failed to send chat message with status code: {r.status_code}") 158 | 159 | response = r.json() 160 | if 'title' in response: 161 | return response['title'] 162 | 163 | raise Exception(f"Unknown server response: {response}") 164 | 165 | def share_conversation(self, conversation_id: str = None) -> str: 166 | ''' 167 | Return a share link of the conversation. 168 | ''' 169 | if conversation_id is None: 170 | conversation_id = self.current_conversation 171 | 172 | headers = self.get_headers() 173 | 174 | r = self.session.post(f"{self.hf_base_url}/chat/conversation/{conversation_id}/share", headers=headers, cookies=self.get_cookies()) 175 | 176 | if r.status_code != 200: 177 | raise Exception(f"Failed to send chat message with status code: {r.status_code}") 178 | 179 | response = r.json() 180 | if 'url' in response: 181 | return response['url'] 182 | 183 | raise Exception(f"Unknown server response: {response}") 184 | 185 | def delete_conversation(self, conversation_id: str = None) -> bool: 186 | ''' 187 | Delete a HuggingChat conversation by conversation_id. 188 | ''' 189 | 190 | if conversation_id is None: 191 | raise DeleteConversationError("conversation_id is required.") 192 | 193 | headers = self.get_headers() 194 | 195 | r = self.session.delete(f"{self.hf_base_url}/chat/conversation/{conversation_id}", headers=headers, cookies=self.get_cookies()) 196 | 197 | if r.status_code != 200: 198 | raise DeleteConversationError(f"Failed to delete conversation with status code: {r.status_code}") 199 | 200 | 201 | def chat( 202 | self, 203 | text: str, 204 | temperature: float=0.9, 205 | top_p: float=0.95, 206 | repetition_penalty: float=1.2, 207 | top_k: int=50, 208 | truncate: int=1024, 209 | watermark: bool=False, 210 | max_new_tokens: int=1024, 211 | stop: list=[""], 212 | return_full_text: bool=False, 213 | stream: bool=True, 214 | use_cache: bool=False, 215 | is_retry: bool=False, 216 | retry_count: int=5, 217 | ): 218 | ''' 219 | Send a message to the current conversation. Return the response text. 220 | ''' 221 | if retry_count <= 0: 222 | raise Exception("the parameter retry_count must be greater than 0.") 223 | if self.current_conversation == "": 224 | self.current_conversation = self.new_conversation() 225 | req_json = { 226 | "inputs": text, 227 | "parameters": { 228 | "temperature": temperature, 229 | "top_p": top_p, 230 | "repetition_penalty": repetition_penalty, 231 | "top_k": top_k, 232 | "truncate": truncate, 233 | "watermark": watermark, 234 | "max_new_tokens": max_new_tokens, 235 | "stop": stop, 236 | "return_full_text": return_full_text, 237 | "stream": stream, 238 | }, 239 | "options": { 240 | "use_cache": use_cache, 241 | "is_retry": is_retry, 242 | "id": str(uuid.uuid4()), 243 | }, 244 | } 245 | # print(req_json) 246 | # print(self.session.cookies.get_dict()) 247 | # print(f"https://huggingface.co/chat/conversation/{self.now_conversation}") 248 | headers = self.get_headers(ref=True) 249 | 250 | while retry_count > 0: 251 | resp = self.session.post(self.hf_base_url + f"/chat/conversation/{self.current_conversation}", json=req_json, stream=True, headers=headers, cookies=self.session.cookies.get_dict()) 252 | res_text = "" 253 | 254 | if resp.status_code != 200: 255 | retry_count -= 1 256 | if retry_count <= 0: 257 | raise ChatError(f"Failed to chat. ({resp.status_code})") 258 | 259 | for line in resp.iter_lines(): 260 | if line: 261 | res = line.decode("utf-8") 262 | try: 263 | obj = json.loads(res[1:-1]) 264 | except: 265 | if "{\"error\":\"Model is overloaded\"" in res: 266 | raise ModelOverloadedError("Model is overloaded, please try again later.") 267 | raise ChatError(f"Failed to parse response: {res}") 268 | if "generated_text" in obj: 269 | res_text += obj["generated_text"] 270 | elif "error" in obj: 271 | raise ChatError(obj["error"]) 272 | return res_text 273 | def message_stream(self, prompt: str, conversation_id=None, temperature=0.6, top_p=0.95, repetition_penalty=1.025, top_k=50, truncate=1024, max_new_tokens=300, return_full_text=False, watermark=False) -> str: 274 | if not conversation_id: 275 | conversation_id = self.current_conversation 276 | if self.current_conversation == "": 277 | self.current_conversation = self.new_conversation() 278 | headers = self.get_headers(ref=True) 279 | req_json = { 280 | "inputs": prompt, 281 | "parameters": { 282 | "temperature": temperature, 283 | "top_p": top_p, 284 | "repetition_penalty": repetition_penalty, 285 | "top_k": top_k, 286 | "truncate": truncate, 287 | "watermark": watermark, 288 | "max_new_tokens": max_new_tokens, 289 | "stop": [""], 290 | "return_full_text": return_full_text 291 | }, 292 | "stream": True, 293 | "options": {"is_retry": False, "use_cache": False} 294 | } 295 | 296 | response = self.session.post(self.hf_base_url + f"/chat/conversation/{self.current_conversation}", json=req_json, stream=True, headers=headers, cookies=self.session.cookies.get_dict()) 297 | if response.status_code == 200: 298 | 299 | for line in response.iter_lines(): 300 | 301 | if line: 302 | res = line.decode("utf-8") 303 | if res.startswith("data:"): 304 | res = res[5:] 305 | obj = json.loads(res) 306 | 307 | if "token" in obj and "text" in obj["token"]: 308 | 309 | if obj["token"]["text"] == "" or obj["token"]["text"] == "." and obj["generated_text"] is not None: 310 | continue 311 | else: 312 | yield obj["token"]["text"] 313 | elif "error" in obj: 314 | raise Exception(obj["error"]) 315 | elif response.status_code == 429: 316 | print(f"{response.status_code} error: server is busy") 317 | response.raise_for_status() 318 | else: 319 | print(f"{response.status_code} error") 320 | response.raise_for_status() 321 | 322 | def stream_print(text_iter, end="\n"): 323 | for text in text_iter: 324 | if text is None: 325 | continue 326 | print(text, end="", flush=True) 327 | print(end, end="") 328 | 329 | 330 | if __name__ == "__main__": 331 | bot = ChatBot() 332 | message_content = bot.chat("Hello", max_new_tokens=10) 333 | print(message_content) 334 | summary = bot.summarize_conversation() 335 | print(summary) 336 | sharelink = bot.share_conversation() 337 | print(sharelink) 338 | 339 | stream_print(bot.message_stream("Hello")) 340 | 341 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------