HuggingChatAPI


NameHuggingChatAPI JSON
Version 1.2.0 PyPI version JSON
download
home_pagehttps://github.com/ILYXAAA/HuggingChatAPI
SummaryThe project is an unofficial API for the site huggingface.co/chat.
upload_time2024-03-24 09:42:17
maintainerNone
docs_urlNone
authorILYXAAA
requires_python>=3.6
licenseNone
keywords files huggingchatapi api ai bot
VCS
bugtrack_url
requirements googletrans pygments requests urllib3 warnings traceback
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <a href="" rel="noopener">
 <img width=200px height=200px src="https://github.com/ILYXAAA/HuggingChatAPI/assets/107761814/6fa4af01-5719-4903-a2c3-f8b552ccf550" alt="Project logo"></a>
</p>

<h3 align="center">HuggingChatAPI</h3>

<div align="center">

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
![GitHub last commit](https://img.shields.io/github/last-commit/ILYXAAA/HuggingChatAPI)
![GitHub Issues](https://img.shields.io/github/issues/ILYXAAA/HuggingChatAPI)

</div>

---

> The project is an unofficial API for the site https://huggingface.co/chat  which allows you to quickly, without a UI interface, get answers to your questions using AI hosted by huggingface.

## Table of Contents

- [**About**](#about)
- [**Getting Started**](#getting_started)
- [**Usage**](#usage)
- [**Built Using**](#built_using)
- [**Authors**](#authors)

&emsp;
## About <a name = "about"></a>

The project is an unofficial API for the site https://huggingface.co/chat  was created using reverse engineering and site traffic analysis using BurpSuite. The developed library can be used in your projects if you need to add text-AI to your project very quickly and easily

&emsp;
## Getting Started <a name = "getting_started"></a>

### You can install the library as a package via pip

  ```bash
  pip install HuggingChatAPI
  ```
### Or use the library by installing it using git

1. Clone the repository:

    ```bash
    git clone https://github.com/ILYXAAA/HuggingChatAPI.git
    ```

2. Install the necessary libraries:

    ```bash
    pip install -r requirements.txt
    ```

&emsp;
## Usage <a name="usage"></a>

### To use the library, just write a couple lines of code.
```python
from HuggingChatAPI import SimpleHugChat

#Initializing the SimpleHugChat class
ChatBot = SimpleHugChat()

#Use the send_prompt function to send our message to the AI model
prompt = "Hello, how are you?"
model_answer = ChatBot.send_prompt(prompt)

print(model_answer)
```

### If you run this script, you will get an example like this:

```bash
> python client.py
I am just a computer program, so I dont have feelings.

If you need any assistance or have any queries related to programming,
data science, machine learning, mathematics, or any other topic, feel free to ask.
```

### For more information, visit: https://github.com/ILYXAAA/HuggingChatAPI

&emsp;
## Built Using <a name = "built_using"></a>

- [HuggingFace Chat](https://huggingface.co/chat/) - A website hosting all the specified models
- [BurpSuite](https://portswigger.net/burp) - A utility for analyzing network traffic
- [Python](https://www.python.org/) - The main language of the project

## Author <a name = "authors"></a>
[@ILYXAAA](https://github.com/ILYXAAA)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ILYXAAA/HuggingChatAPI",
    "name": "HuggingChatAPI",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "files HuggingChatAPI API AI Bot",
    "author": "ILYXAAA",
    "author_email": "ilyagolybnichev@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b0/f5/326bca190f03bd93b49c5d56e56cca481f87a4351b36e5924e256899c21d/HuggingChatAPI-1.2.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\r\n  <a href=\"\" rel=\"noopener\">\r\n <img width=200px height=200px src=\"https://github.com/ILYXAAA/HuggingChatAPI/assets/107761814/6fa4af01-5719-4903-a2c3-f8b552ccf550\" alt=\"Project logo\"></a>\r\n</p>\r\n\r\n<h3 align=\"center\">HuggingChatAPI</h3>\r\n\r\n<div align=\"center\">\r\n\r\n[![Status](https://img.shields.io/badge/status-active-success.svg)]()\r\n![GitHub last commit](https://img.shields.io/github/last-commit/ILYXAAA/HuggingChatAPI)\r\n![GitHub Issues](https://img.shields.io/github/issues/ILYXAAA/HuggingChatAPI)\r\n\r\n</div>\r\n\r\n---\r\n\r\n> The project is an unofficial API for the site https://huggingface.co/chat  which allows you to quickly, without a UI interface, get answers to your questions using AI hosted by huggingface.\r\n\r\n## Table of Contents\r\n\r\n- [**About**](#about)\r\n- [**Getting Started**](#getting_started)\r\n- [**Usage**](#usage)\r\n- [**Built Using**](#built_using)\r\n- [**Authors**](#authors)\r\n\r\n&emsp;\r\n## About <a name = \"about\"></a>\r\n\r\nThe project is an unofficial API for the site https://huggingface.co/chat  was created using reverse engineering and site traffic analysis using BurpSuite. The developed library can be used in your projects if you need to add text-AI to your project very quickly and easily\r\n\r\n&emsp;\r\n## Getting Started <a name = \"getting_started\"></a>\r\n\r\n### You can install the library as a package via pip\r\n\r\n  ```bash\r\n  pip install HuggingChatAPI\r\n  ```\r\n### Or use the library by installing it using git\r\n\r\n1. Clone the repository:\r\n\r\n    ```bash\r\n    git clone https://github.com/ILYXAAA/HuggingChatAPI.git\r\n    ```\r\n\r\n2. Install the necessary libraries:\r\n\r\n    ```bash\r\n    pip install -r requirements.txt\r\n    ```\r\n\r\n&emsp;\r\n## Usage <a name=\"usage\"></a>\r\n\r\n### To use the library, just write a couple lines of code.\r\n```python\r\nfrom HuggingChatAPI import SimpleHugChat\r\n\r\n#Initializing the SimpleHugChat class\r\nChatBot = SimpleHugChat()\r\n\r\n#Use the send_prompt function to send our message to the AI model\r\nprompt = \"Hello, how are you?\"\r\nmodel_answer = ChatBot.send_prompt(prompt)\r\n\r\nprint(model_answer)\r\n```\r\n\r\n### If you run this script, you will get an example like this:\r\n\r\n```bash\r\n> python client.py\r\nI am just a computer program, so I dont have feelings.\r\n\r\nIf you need any assistance or have any queries related to programming,\r\ndata science, machine learning, mathematics, or any other topic, feel free to ask.\r\n```\r\n\r\n### For more information, visit: https://github.com/ILYXAAA/HuggingChatAPI\r\n\r\n&emsp;\r\n## Built Using <a name = \"built_using\"></a>\r\n\r\n- [HuggingFace Chat](https://huggingface.co/chat/) - A website hosting all the specified models\r\n- [BurpSuite](https://portswigger.net/burp) - A utility for analyzing network traffic\r\n- [Python](https://www.python.org/) - The main language of the project\r\n\r\n## Author <a name = \"authors\"></a>\r\n[@ILYXAAA](https://github.com/ILYXAAA)\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "The project is an unofficial API for the site huggingface.co/chat.",
    "version": "1.2.0",
    "project_urls": {
        "GitHub": "https://github.com/ILYXAAA/HuggingChatAPI",
        "Homepage": "https://github.com/ILYXAAA/HuggingChatAPI"
    },
    "split_keywords": [
        "files",
        "huggingchatapi",
        "api",
        "ai",
        "bot"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "36cb36f5f73c703f27252b733e4ad9a167e550e96a7c994880f15e0ac4faa3f8",
                "md5": "2746296de5791b32e99e79eaf6a7608b",
                "sha256": "ee12a2de677178bbbed222cf51eb149a2227b9b8f78ee2f53175af3b1dac4f8b"
            },
            "downloads": -1,
            "filename": "HuggingChatAPI-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2746296de5791b32e99e79eaf6a7608b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 7977,
            "upload_time": "2024-03-24T09:42:16",
            "upload_time_iso_8601": "2024-03-24T09:42:16.165733Z",
            "url": "https://files.pythonhosted.org/packages/36/cb/36f5f73c703f27252b733e4ad9a167e550e96a7c994880f15e0ac4faa3f8/HuggingChatAPI-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b0f5326bca190f03bd93b49c5d56e56cca481f87a4351b36e5924e256899c21d",
                "md5": "d9b6884284c17ba64b47a5750a8d9bff",
                "sha256": "251baac0d4718fe9dcf1189b7d05ce81961b17b3bd65cbd9c69a01520e610eec"
            },
            "downloads": -1,
            "filename": "HuggingChatAPI-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d9b6884284c17ba64b47a5750a8d9bff",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 6790,
            "upload_time": "2024-03-24T09:42:17",
            "upload_time_iso_8601": "2024-03-24T09:42:17.952096Z",
            "url": "https://files.pythonhosted.org/packages/b0/f5/326bca190f03bd93b49c5d56e56cca481f87a4351b36e5924e256899c21d/HuggingChatAPI-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-24 09:42:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ILYXAAA",
    "github_project": "HuggingChatAPI",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "googletrans",
            "specs": [
                [
                    "==",
                    "4.0.0-rc1"
                ]
            ]
        },
        {
            "name": "pygments",
            "specs": []
        },
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "urllib3",
            "specs": []
        },
        {
            "name": "warnings",
            "specs": []
        },
        {
            "name": "traceback",
            "specs": []
        }
    ],
    "lcname": "huggingchatapi"
}
        
Elapsed time: 0.21831s