View g4f on Snyk Open Source Advisor

Package Health Score

91 / 100

security
Security review needed
popularity
Influential project
maintenance
Healthy
community
Active

Explore Similar Packages

zero
36

Popularity

Influential project

GitHub Stars: 62.75K
Forks: 13.45K
Contributors: 230

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package g4f, we found that it has been starred 62,748 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Dec 17, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 1
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 15
Open PR: 1
Last Release: 1 day ago
Last Commit: 1 day ago

Further analysis of the maintenance status of g4f based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that g4f demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 230
Funding: Yes

A good and healthy external contribution signal for g4f project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.*

Age: 1 year
Latest Release: 1 day ago
Dependencies: 5 Direct / 19 Total
Versions: 241
Maintainers: 2
Wheels: OS Independent

Readme

248433934-7886223b-c1d1-4260-82aa-da5741f303bb

Written by @xtekky

> [!IMPORTANT] > By using this repository or any code related to it, you agree to the legal notice. The author is not responsible for the usage of this repository nor endorses it, nor is the author responsible for any copies, forks, re-uploads made by other users, or anything else related to GPT4Free. This is the author's only account and repository. To prevent impersonation or irresponsible actions, please comply with the GNU GPL license this Repository uses.

> [!WARNING] > "gpt4free" serves as a PoC (proof of concept), demonstrating the development of an API package with multi-provider requests, with features like timeouts, load balance and flow control.

> > ^{Latest version:}
> ^Stats:

pip install -U g4f[all]

docker pull hlohaus789/g4f

🆕 What's New

For comprehensive details on new features and updates, please refer to our Releases page
Installation Guide for Windows (.exe): 💻 Installation Guide for Windows (.exe)
Join our Telegram Channel: 📨 telegram.me/g4f_channel
Join our Discord Group: 💬🆕️ discord.gg/qXA4Wf4Fsm

🔻 Site Takedown

Is your site on this repository and you want to take it down? Send an email to takedown@g4f.ai with proof it is yours and it will be removed as fast as possible. To prevent reproduction please secure your API. 😉

🚀 GPT4Free on HuggingFace

Explore our GPT4Free project on HuggingFace Spaces by clicking the link below:

Visit GPT4Free on HuggingFace

If you would like to create your own copy of this space, you can duplicate it using the following link:

Duplicate GPT4Free Space

Access Information

To access the space, please use the following login credentials:

Username: any
Password: gpt4free

📚 Table of Contents

🛠️ Getting Started

Docker Container Guide

Getting Started Quickly:

Install Docker: Begin by downloading and installing Docker.
Set Up the Container: Use the following commands to pull the latest image and start the container:

docker pull hlohaus789/g4f
docker run \
  -p 8080:8080 -p 1337:1337 -p 7900:7900 \
  --shm-size="2g" \
  -v ${PWD}/har_and_cookies:/app/har_and_cookies \
  -v ${PWD}/generated_images:/app/generated_images \
  hlohaus789/g4f:latest

To run the slim docker image. Use this command:

docker run \
  -p 1337:1337 \
  -v ${PWD}/har_and_cookies:/app/har_and_cookies \
  -v ${PWD}/generated_images:/app/generated_images \
  hlohaus789/g4f:latest-slim \
  rm -r -f /app/g4f/ \
  &amp;&amp; pip install -U g4f[slim] \
  &amp;&amp; python -m g4f --debug

It also updates the g4f package at startup and installs any new required dependencies.

Access the Client:
- To use the included client, navigate to: http://localhost:8080/chat/ or http://localhost:1337/chat/
- Or set the API base for your client to: http://localhost:1337/v1
(Optional) Provider Login: If required, you can access the container's desktop here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret for provider login purposes.

Installation Guide for Windows (.exe)

To ensure the seamless operation of our application, please follow the instructions below. These steps are designed to guide you through the installation process on Windows operating systems.

Installation Steps

Download the Application: Visit our releases page and download the most recent version of the application, named g4f.exe.zip.
File Placement: After downloading, locate the .zip file in your Downloads folder. Unpack it to a directory of your choice on your system, then execute the g4f.exe file to run the app.
Open GUI: The app starts a web server with the GUI. Open your favorite browser and navigate to http://localhost:8080/chat/ to access the application interface.
Firewall Configuration (Hotfix): Upon installation, it may be necessary to adjust your Windows Firewall settings to allow the application to operate correctly. To do this, access your Windows Firewall settings and allow the application.

By following these steps, you should be able to successfully install and run the application on your Windows system. If you encounter any issues during the installation process, please refer to our Issue Tracker or try to get contact over Discord for assistance.

Learn More About the GUI

For detailed instructions on how to set up, configure, and use the GPT4Free GUI, refer to the GUI Documentation:

GUI Documentation

This guide includes step-by-step details on provider selection, managing conversations, using advanced features like speech recognition, and more.

Use Your Smartphone

Run the Web UI on your smartphone for easy access on the go. Check out the dedicated guide to learn how to set up and use the GUI on your mobile device:

Run on Smartphone Guide

Use python

Prerequisites:

Download and install Python (Version 3.10+ is recommended).
Install Google Chrome for providers with webdriver

Install using PyPI package:

pip install -U g4f[all]

How do I install only parts or do disable parts? Use partial requirements: /docs/requirements

Install from source:

How do I load the project using git and installing the project requirements? Read this tutorial and follow it step by step: /docs/git

Install using Docker:

How do I build and run composer image from source? Use docker-compose: /docs/docker

💡 Usage

Text Generation

from g4f.client import Client

client = Client()
response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello"}],
    # Add any other necessary parameters
)
print(response.choices[0].message.content)

Hello! How can I assist you today?

Image Generation

from g4f.client import Client

client = Client()
response = client.images.generate(
    model="flux",
    prompt="a white siamese cat",
    response_format="url"
    # Add any other necessary parameters
)

image_url = response.data[0].url
print(f"Generated image URL: {image_url}")

Full Documentation for Python API

New:
- Requests API from G4F: /docs/requests
- Client API from G4F: /docs/client
- AsyncClient API from G4F: /docs/async_client
Legacy:
- Legacy API with python modules: /docs/legacy

Web UI

To start the web interface, type the following codes in python:

from g4f.gui import run_gui

run_gui()

or execute the following command:

python -m g4f.cli gui -port 8080 -debug

Interference API

The Interference API enables seamless integration with OpenAI's services through G4F, allowing you to deploy efficient AI solutions.

Documentation: Interference API Docs
Endpoint: http://localhost:1337/v1
Swagger UI: Explore the OpenAPI documentation via Swagger UI at http://localhost:1337/docs

This API is designed for straightforward implementation and enhanced compatibility with other OpenAI integrations.

Configuration

Authentication

Refer to the G4F Authentication Setup Guide for detailed instructions on setting up authentication.

Cookies

Cookies are essential for using Meta AI and Microsoft Designer to create images. Additionally, cookies are required for the Google Gemini and WhiteRabbitNeo Provider. From Bing, ensure you have the "_U" cookie, and from Google, all cookies starting with "__Secure-1PSID" are needed.

You can pass these cookies directly to the create function or set them using the set_cookies method before running G4F:

from g4f.cookies import set_cookies

set_cookies(".bing.com", {
  "_U": "cookie value"
})

set_cookies(".google.com", {
  "__Secure-1PSID": "cookie value"
})

Using .har and Cookie Files

You can place .har and cookie files .json in the default ./har_and_cookies directory. To export a cookie file, use the EditThisCookie Extension available on the Chrome Web Store.

Creating .har Files to Capture Cookies

To capture cookies, you can also create .har files. For more details, refer to the next section.

Changing the Cookies Directory and Loading Cookie Files in Python

You can change the cookies directory and load cookie files in your Python environment. To set the cookies directory relative to your Python file, use the following code:

import os.path
from g4f.cookies import set_cookies_dir, read_cookie_files

import g4f.debug
g4f.debug.logging = True

cookies_dir = os.path.join(os.path.dirname(__file__), "har_and_cookies")
set_cookies_dir(cookies_dir)
read_cookie_files(cookies_dir)

Debug Mode

If you enable debug mode, you will see logs similar to the following:

Read .har file: ./har_and_cookies/you.com.har
Cookies added: 10 from .you.com
Read cookie file: ./har_and_cookies/google.json
Cookies added: 16 from .google.com

.HAR File for OpenaiChat Provider

Generating a .HAR File

To utilize the OpenaiChat provider, a .har file is required from https://chatgpt.com/. Follow the steps below to create a valid .har file:

Navigate to https://chatgpt.com/ using your preferred web browser and log in with your credentials.
Access the Developer Tools in your browser. This can typically be done by right-clicking the page and selecting "Inspect," or by pressing F12 or Ctrl+Shift+I (Cmd+Option+I on a Mac).
With the Developer Tools open, switch to the "Network" tab.
Reload the website to capture the loading process within the Network tab.
Initiate an action in the chat which can be captured in the .har file.
Right-click any of the network activities listed and select "Save all as HAR with content" to export the .har file.

Storing the .HAR File

Place the exported .har file in the ./har_and_cookies directory if you are using Docker. Alternatively, if you are using Python from a terminal, you can store it in a ./har_and_cookies directory within your current working directory.

> Note: Ensure that your .har file is stored securely, as it may contain sensitive information.

Using Proxy

If you want to hide or change your IP address for the providers, you can set a proxy globally via an environment variable:

- On macOS and Linux:

export G4F_PROXY="http://host:port"

- On Windows:

set G4F_PROXY=http://host:port

🔗 Powered by gpt4free

<tr>
  <td>
    <a href="https://github.com/MIDORIBIN/langchain-gpt4free">
      <b>LangChain gpt4free</b>
    </a>
  </td>
  <td>
    <a href="https://github.com/MIDORIBIN/langchain-gpt4free/stargazers">
      <img src="https://img.shields.io/github/stars/MIDORIBIN/langchain-gpt4free?style=flat-square&amp;labelColor=343b41" alt="Stars">
    </a>
  </td>
  <td>
    <a href="https://github.com/MIDORIBIN/langchain-gpt4free/network/members">
      <img src="https://img.shields.io/github/forks/MIDORIBIN/langchain-gpt4free?style=flat-square&amp;labelColor=343b41" alt="Forks">
    </a>
  </td>
  <td>
    <a href="https://github.com/MIDORIBIN/langchain-gpt4free/issues">
      <img src="https://img.shields.io/github/issues/MIDORIBIN/langchain-gpt4free?style=flat-square&amp;labelColor=343b41" alt="Issues">
    </a>
  </td>
  <td>
    <a href="https://github.com/MIDORIBIN/langchain-gpt4free/pulls">
      <img src="https://img.shields.io/github/issues-pr/MIDORIBIN/langchain-gpt4free?style=flat-square&amp;labelColor=343b41" alt="Pull Requests">
    </a>
  </td>
</tr>
<tr>
  <td>
    <a href="https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free">
      <b>ChatGpt Telegram Bot</b>
    </a>
  </td>
  <td>
    <a href="https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free/stargazers">
      <img src="https://img.shields.io/github/stars/HexyeDEV/Telegram-Chatbot-Gpt4Free?style=flat-square&amp;labelColor=343b41" alt="Stars">
    </a>
  </td>
  <td>
    <a href="https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free/network/members">
      <img src="https://img.shields.io/github/forks/HexyeDEV/Telegram-Chatbot-Gpt4Free?style=flat-square&amp;labelColor=343b41" alt="Forks">
    </a>
  </td>
  <td>
    <a href="https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free/issues">
      <img src="https://img.shields.io/github/issues/HexyeDEV/Telegram-Chatbot-Gpt4Free?style=flat-square&amp;labelColor=343b41" alt="Issues">
    </a>
  </td>
  <td>
    <a href="https://github.com/HexyeDEV/Telegram-Chatbot-Gpt4Free/pulls">
      <img src="https://img.shields.io/github/issues-pr/HexyeDEV/Telegram-Chatbot-Gpt4Free?style=flat-square&amp;labelColor=343b41" alt="Pull Requests">
    </a>
  </td>
</tr>
<tr>
  <td>
    <a href="https://github.com/Lin-jun-xiang/chatgpt-line-bot">
      <b>ChatGpt Line Bot</b>
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/chatgpt-line-bot/stargazers">
      <img src="https://img.shields.io/github/stars/Lin-jun-xiang/chatgpt-line-bot?style=flat-square&amp;labelColor=343b41" alt="Stars">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/chatgpt-line-bot/network/members">
      <img src="https://img.shields.io/github/forks/Lin-jun-xiang/chatgpt-line-bot?style=flat-square&amp;labelColor=343b41" alt="Forks">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/chatgpt-line-bot/issues">
      <img src="https://img.shields.io/github/issues/Lin-jun-xiang/chatgpt-line-bot?style=flat-square&amp;labelColor=343b41" alt="Issues">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/chatgpt-line-bot/pulls">
      <img src="https://img.shields.io/github/issues-pr/Lin-jun-xiang/chatgpt-line-bot?style=flat-square&amp;labelColor=343b41" alt="Pull Requests">
    </a>
  </td>
</tr>
<tr>
  <td>
    <a href="https://github.com/Lin-jun-xiang/action-translate-readme">
      <b>Action Translate Readme</b>
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/action-translate-readme/stargazers">
      <img src="https://img.shields.io/github/stars/Lin-jun-xiang/action-translate-readme?style=flat-square&amp;labelColor=343b41" alt="Stars">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/action-translate-readme/network/members">
      <img src="https://img.shields.io/github/forks/Lin-jun-xiang/action-translate-readme?style=flat-square&amp;labelColor=343b41" alt="Forks">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/action-translate-readme/issues">
      <img src="https://img.shields.io/github/issues/Lin-jun-xiang/action-translate-readme?style=flat-square&amp;labelColor=343b41" alt="Issues">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/action-translate-readme/pulls">
      <img src="https://img.shields.io/github/issues-pr/Lin-jun-xiang/action-translate-readme?style=flat-square&amp;labelColor=343b41" alt="Pull Requests">
    </a>
  </td>
</tr>
<tr>
  <td>
    <a href="https://github.com/Lin-jun-xiang/docGPT-streamlit">
      <b>Langchain Document GPT</b>
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/docGPT-streamlit/stargazers">
      <img src="https://img.shields.io/github/stars/Lin-jun-xiang/docGPT-streamlit?style=flat-square&amp;labelColor=343b41" alt="Stars">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/docGPT-streamlit/network/members">
      <img src="https://img.shields.io/github/forks/Lin-jun-xiang/docGPT-streamlit?style=flat-square&amp;labelColor=343b41" alt="Forks">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/docGPT-streamlit/issues">
      <img src="https://img.shields.io/github/issues/Lin-jun-xiang/docGPT-streamlit?style=flat-square&amp;labelColor=343b41" alt="Issues">
    </a>
  </td>
  <td>
    <a href="https://github.com/Lin-jun-xiang/docGPT-streamlit/pulls">
      <img src="https://img.shields.io/github/issues-pr/Lin-jun-xiang/docGPT-streamlit?style=flat-square&amp;labelColor=343b41" alt="Pull Requests">
    </a>
  </td>
</tr>
<tr>
  <td>
    <a href="https://github.com/Simatwa/python-tgpt">
      <b>python-tgpt</b>
    </a>
  </td>
  <td>
    <a href="https://github.com/Simatwa/python-tgpt/stargazers">
      <img src="https://img.shields.io/github/stars/Simatwa/python-tgpt?style=flat-square&amp;labelColor=343b41" alt="Stars">
    </a>
  </td>
  <td>
    <a href="https://github.com/Simatwa/python-tgpt/network/members">
      <img src="https://img.shields.io/github/forks/Simatwa/python-tgpt?style=flat-square&amp;labelColor=343b41" alt="Forks">
    </a>
  </td>
  <td>
    <a href="https://github.com/Simatwa/python-tgpt/issues">
      <img src="https://img.shields.io/github/issues/Simatwa/python-tgpt?style=flat-square&amp;labelColor=343b41" alt="Issues">
    </a>
  </td>
  <td>
    <a href="https://github.com/Simatwa/python-tgpt/pulls">
      <img src="https://img.shields.io/github/issues-pr/Simatwa/python-tgpt?style=flat-square&amp;labelColor=343b41" alt="Pull Requests">
    </a>
  </td>
</tr>
<tr>
  <td>
    <a href="https://github.com/zachey01/gpt4free.js">
      <b>GPT4js</b>
    </a>
  </td>
  <td>
    <a href="https://github.com/zachey01/gpt4free.js/stargazers">
      <img src="https://img.shields.io/github/stars/zachey01/gpt4free.js?style=flat-square&amp;labelColor=343b41" alt="Stars">
    </a>
  </td>
  <td>
    <a href="https://github.com/zachey01/gpt4free.js/network/members">
      <img src="https://img.shields.io/github/forks/zachey01/gpt4free.js?style=flat-square&amp;labelColor=343b41" alt="Forks">
    </a>
  </td>
  <td>
    <a href="https://github.com/zachey01/gpt4free.js/issues">
      <img src="https://img.shields.io/github/issues/zachey01/gpt4free.js?style=flat-square&amp;labelColor=343b41" alt="Issues">
    </a>
  </td>
  <td>
    <a href="https://github.com/zachey01/gpt4free.js/pulls">
      <img src="https://img.shields.io/github/issues-pr/zachey01/gpt4free.js?style=flat-square&amp;labelColor=343b41" alt="Pull Requests">
    </a>
  </td>
</tr>
<tr>
  <td>
    <a href="https://github.com/yjg30737/pyqt-openai">
      <b>VividNode (pyqt-openai)</b>
    </a>
  </td>
  <td>
    <a href="https://github.com/yjg30737/pyqt-openai/stargazers">
      <img src="https://img.shields.io/github/stars/yjg30737/pyqt-openai?style=flat-square&amp;labelColor=343b41" alt="Stars">
    </a>
  </td>
  <td>
    <a href="https://github.com/yjg30737/pyqt-openai/network/members">
      <img src="https://img.shields.io/github/forks/yjg30737/pyqt-openai?style=flat-square&amp;labelColor=343b41" alt="Forks">
    </a>
  </td>
  <td>
    <a href="https://github.com/yjg30737/pyqt-openai/issues">
      <img src="https://img.shields.io/github/issues/yjg30737/pyqt-openai?style=flat-square&amp;labelColor=343b41" alt="Issues">
    </a>
  </td>
  <td>
    <a href="https://github.com/yjg30737/pyqt-openai/pulls">
      <img src="https://img.shields.io/github/issues-pr/yjg30737/pyqt-openai?style=flat-square&amp;labelColor=343b41" alt="Pull Requests">
    </a>
  </td>
</tr>

🎁 Projects	⭐ Stars	📚 Forks	🛎 Issues	📬 Pull requests
gpt4free
gpt4free-ts
Free AI API's & Potential Providers List
ChatGPT-Clone
Ai agent
ChatGpt Discord Bot
chatGPT-discord-bot
Nyx-Bot (Discord)

🤝 Contribute

We welcome contributions from the community. Whether you're adding new providers or features, or simply fixing typos and making small improvements, your input is valued. Creating a pull request is all it takes – our co-pilot will handle the code review process. Once all changes have been addressed, we'll merge the pull request into the main branch and release the updates at a later time.

Guide: How do i create a new Provider?

Read: Create Provider Guide

Guide: How can AI help me with writing code?

Read: AI Assistance Guide

🙌 Contributors

A list of all contributors is available here

ading2210 xqdoo00o nathanrchn dsdanielpark missuo

The Vercel.py file contains code from vercel-llm-api by @ading2210
The har_file.py has input from xqdoo00o/ChatGPT-to-API
The PerplexityLabs.py has input from nathanrchn/perplexityai
The Gemini.py has input from dsdanielpark/Gemini-API
The MetaAI.py file contains code from meta-ai-api by @Strvm
The proofofwork.py has input from missuo/FreeGPT35

Having input implies that the AI's code generation utilized it as one of many sources.

©️ Copyright

This program is licensed under the GNU GPL v3

xtekky/gpt4free: Copyright (C) 2023 xtekky

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see .

⭐ Star History

📄 License

This project is licensed under GNU_GPL_v3.0.

(🔼 Back to top)

g4f dependencies

aiohttp brotli nest-asyncio pycryptodome requests

FAQs

What is g4f?

The official gpt4free repository | various collection of powerful language models. Visit Snyk Advisor to see a full health score report for g4f, including popularity, security, maintenance & community analysis.

Is g4f popular?

The python package g4f receives a total of 102,846 weekly downloads. As such, g4f popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is g4f well maintained?

We found that g4f demonstrated a healthy version release cadence and project activity. It has a community of 230 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is g4f safe to use?

While scanning the latest version of g4f, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 18 December-2024, at 18:04 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP