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.3.13.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aishell-2023.3.13.tar.gz
Algorithm Hash digest
SHA256 3a04acfb908f41a94d2584d041d242868807e028721d284024c82de0cc683cb0
MD5 e48c72fa6303e69ce3a90285be3b309a
BLAKE2b-256 d2cee997cd23a2e6c13708730cc02554b7a4a02d6b3f72b9f4649ec74e6c2296

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aishell-2023.3.13-py3-none-any.whl
Algorithm Hash digest
SHA256 26233089b45b2969fa5b6bfbb1b10e30bbe4dfb1e29dd21c5afd878be47079e2
MD5 c70fffa9fba96d833abcdeffaf26b0de
BLAKE2b-256 5f26baaac8cf37070401fd05d69ffa94310ede055baf7372d5d0b5f17acb0530

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