Skip to main content

No project description provided

Project description

AiShell 🤖

codecov Release Package to PyPI PyPI version

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

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.3.4.post3.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

aishell-2023.3.4.post3-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file aishell-2023.3.4.post3.tar.gz.

File metadata

  • Download URL: aishell-2023.3.4.post3.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.9.16 Linux/5.15.0-1033-azure

File hashes

Hashes for aishell-2023.3.4.post3.tar.gz
Algorithm Hash digest
SHA256 505df96f77c00f628bb691ea04c8371d113e4e7a6b9e0cefcf52da8128a63921
MD5 a7335f1070091b656596aff1e2312518
BLAKE2b-256 bbf9f0116b2de40264cefc9063d5c549dfd778cd4971ff7a651d8b097afdfe31

See more details on using hashes here.

File details

Details for the file aishell-2023.3.4.post3-py3-none-any.whl.

File metadata

  • Download URL: aishell-2023.3.4.post3-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.9.16 Linux/5.15.0-1033-azure

File hashes

Hashes for aishell-2023.3.4.post3-py3-none-any.whl
Algorithm Hash digest
SHA256 48bd3463c66b900bab1917c953900e2d2f5e7caa4720b417a255a92520a83f49
MD5 3d7181b84d892496330795276bcfd2f1
BLAKE2b-256 13f0301b57c2a6d48bf6e39eac84ec53fa0e019d142b92e34204632290d3fb4e

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