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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aishell-2023.4.16.post1.tar.gz
  • Upload date:
  • Size: 5.1 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.post1.tar.gz
Algorithm Hash digest
SHA256 13fbd6c3efa1309e43637f5f569a061f0fe12bbe48cdb81079c6cbf496ec1427
MD5 d5b65e1a2e7b9ed6bb850884e086bd31
BLAKE2b-256 b4e1b0bc55f23995b4798fe101eff6f82e8f6d08ea60af207452bb774d3b24a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aishell-2023.4.16.post1-py3-none-any.whl
  • Upload date:
  • Size: 7.1 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.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d3f88306d0cb4dde340668c583ca3470869e80bfef7e36f1cb722cb0ccbebe0
MD5 6d92d1ffdbf581106a8fbd80031ae56c
BLAKE2b-256 e483c4f5e42946a7ca03845695163b6e72c43f1dc8c75ea2a9c65e30efa5b829

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