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 ~/.ygka_openai_config.json file as follows:
{
    ...
    "language_model": "official_chatgpt",
    "openai_api_key": "<your OpenAI API key>"
}

Here, you can add your OpenAI API key. This will enable AiShell to use the official chatgpt api and the 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.16.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

aishell-2023.4.16-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aishell-2023.4.16.tar.gz
  • Upload date:
  • Size: 5.0 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.16.tar.gz
Algorithm Hash digest
SHA256 60bbb3632802e6ac07c08505bb1ad20fc9b577b5db8de96b62221bad97f071aa
MD5 dcbe4748535b01345945cb2dfc0d2727
BLAKE2b-256 3aa8ddd2ee0c9e66662a665975012e48bfdcb57136aad77d05beaa5c749cb25a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aishell-2023.4.16-py3-none-any.whl
  • Upload date:
  • Size: 7.0 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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 cf1141b506ddc45b6e135145fdf931f3e904b9d906623be28c055572c3615c32
MD5 1d9b6a586f8ce5ff2245dc445e6fd62f
BLAKE2b-256 a9aa422153bcaead022f7d4a84dc0ab0903a9f8d1fee70cc07316ffb61eef068

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