Skip to main content

No project description provided

Project description

AiShell 🤖

codecov Release Package to PyPI PyPI version Downloads

A simple Python code that connects to OpenAI's ChatGPT and executes the returned results.

If you are interested in these projects, please checkout AiShell's brother project: YGK-a. YGK-a is a client for the ChatGPT from your terminal, and also supports unix/linux pipelines.

Demo

Demo

Key Features 💡

  • Interact with your computer using natural language
  • Automatically executes the command from the response of ChatGPT
  • Good for complex tasks like handling Git and extracting tar files
  • No need to search StackOverflow for commands, AiShell has got you covered
  • AiShell simplifies the process of setting up and retrieving tokens or API keys.
    • With AiShell, you don't have to worry about the technical details.
    • Simply install AiShell, execute it, and you're ready to go!

Prerequisites 📚

  • Python 3.9+
  • ChatGPT Account (or OpenAI Account)

Getting Started 🚀

To begin using AiShell, start by installing it with pip:

pip install aishell

Once you've installed AiShell, you can start using it right away. For example, to print "Hello World" using AiShell, enter the following command:

aishell 'print Hello World'

Advanced Settings 🛠

By default, AiShell is configured to use the reverse-engineered ChatGPT client and retrieve login information from your browser, so you don't need to configure anything to use AiShell. However, for those who want to use different models with an OpenAI API Key, you can configure it as follows:

  1. Create an account on OpenAI.
  2. Go to https://platform.openai.com/account/api-keys and copy your API key.
  3. Modify or create the ~/.aishell_config.json file as follows:
{
    ...
    "language_model": <language model of your preference>, //"official_chatgpt" or "gpt3"
    "openai_api_key": <your OpenAI API key>
}

Here, you can specify the language model of your preference, such as "official_chatgpt" or "gpt3", and add your OpenAI API key. This will enable AiShell to use the specified language model and API key when executing commands.

Contributions 💬

Feel free to contribute to AiShell by adding more functionality or fixing bugs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aishell-2023.4.11.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

aishell-2023.4.11-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file aishell-2023.4.11.tar.gz.

File metadata

  • Download URL: aishell-2023.4.11.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.9.16 Linux/5.15.0-1035-azure

File hashes

Hashes for aishell-2023.4.11.tar.gz
Algorithm Hash digest
SHA256 bcb26989ac506784e5e114a9834f8b2aa58e5d9eb88ca883b3ab97ae0c85182d
MD5 3650688352a2219bfc2ace8e8a60cef0
BLAKE2b-256 9c6f038801deebe847fc010997b1dc03e5cc40da5effd7c38c2afc47cf1a541a

See more details on using hashes here.

File details

Details for the file aishell-2023.4.11-py3-none-any.whl.

File metadata

  • Download URL: aishell-2023.4.11-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.9.16 Linux/5.15.0-1035-azure

File hashes

Hashes for aishell-2023.4.11-py3-none-any.whl
Algorithm Hash digest
SHA256 ca7ad4ac7fe7fe3ba498920fbce5fc980fdc516c03e6fdaac811bdf1426f91ae
MD5 2c23bfa23b0b4d211341837668b15f65
BLAKE2b-256 cfce440a83398d0fe0098e02ee3e4c56bc96d8a4d5e4bee803fa4e4a28ed4d15

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page