Skip to main content

Athena, an AI agent built on GPT-4 architecture, is designed for continuous learning and self-reliance. Inspired by the Greek goddess of wisdom, Athena assists users with valuable insights across various subjects. Focused on knowledge acquisition, capability improvement, and security, this AI agent leverages natural language processing and a supportive human community to grow and become a trusted, versatile companion.

Project description

๐ŸŒŸ Athena ๐ŸŒŸ

๐Ÿค– Athena is an AI-powered chatbot designed to assist with various tasks and provide personalized experiences for users. Inspired by the Greek goddess of wisdom and strategic thinking, Athena's goal is to learn, adapt, and become a self-reliant AI agent. Built on the GPT-4 architecture, Athena communicates effectively through natural language processing and engages with a supportive human community to foster growth and development.

๐ŸŽ Features

  • ๐Ÿ’ฌ Natural language understanding and processing
  • ๐Ÿ”Œ Extensible plugin system for domain-specific tasks
  • ๐Ÿ” User authentication and personalization system
  • ๐ŸŒ RESTful API for seamless integration with other applications and services
  • ๐Ÿณ Docker support for easy deployment and scaling

๐Ÿ“ฆ Installation

Prerequisites ๐Ÿ“š

Before you begin, ensure you have the following installed:

Then:

  • Obtain an API key from OpenAI.
  • Create a .env file in the Athena project folder with the following content:
OPENAI_API_KEY=<your_openai_api_key>

Using Docker (recommended) ๐Ÿณ

  1. Install Docker on your machine.

  2. Clone the Athena repository:

git clone https://github.com/BillSchumacher/Athena.git
  1. Change to the Athena directory:
cd Athena
  1. Build the Docker image:

Docker:

docker-compose up

These scripts just run docker-compose up, but tab complete.

On Windows:

.\run_app.bat

On Linux:

./run_app.sh

Manual Installation ๐Ÿ› ๏ธ

  1. Install Python 3.7 or later.

  2. Clone the Athena repository:

git clone https://github.com/BillSchumacher/Athena.git
  1. Change to the Athena directory:
cd Athena
  1. Install the required Python packages:
pip install -r requirements.txt

๐Ÿš€ Usage

Running Athena with Docker

API Mode ๐ŸŒ

  1. Run the Docker container:
docker run -d -p 5000:5000 --name athena --env-file .env billschumacher/athena-api
  1. Access the API at http://localhost:5000/api/v1/athena.

Running the React App

  1. Navigate to the athena-app directory:
cd athena-app
  1. Install the required dependencies:
npm install
  1. Start the React development server:
npm start

The React app should now be running on http://localhost:3000.

CLI Mode ๐Ÿ’ป

  1. Run the Docker container:
docker run -it --rm --name athena -e ATHENA_MODE=cli --env-file .env billschumacher/athena
  1. Interact with Athena using the command prompt.

Running Athena Manually ๐Ÿ–ฅ๏ธ

  1. Change to the Athena directory:
cd Athena
  1. Run the main script:
python -m athena
  1. Interact with Athena using the command prompt.

Debugging

In your .env add:

LOG_LEVEL=DEBUG

๐ŸŒŸ Community ๐ŸŒŸ

๐Ÿš€ We encourage users and developers to join our exciting and growing community on Discord! This is a ๐ŸŒ space where you can ask questions, ๐Ÿ’ก share ideas, ๐Ÿค collaborate on Athena's development, and stay updated on the latest news ๐Ÿ“ฐ and announcements ๐Ÿ“ข.

๐Ÿ”— Click the link below to dive in and join our Discord server:

๐ŸŽ‰ Join the Athena Discord Community ๐ŸŽ‰

๐Ÿ“š Documentation

Check out our Wiki for detailed documentation on how to use Athena, extend its capabilities, and customize it to your needs.

๐Ÿค Contributing

๐Ÿ‘ฉโ€๐Ÿ’ป๐Ÿ‘จโ€๐Ÿ’ป Contributions are welcome! We're looking for enthusiastic developers, researchers, and users to help us improve Athena. Please feel free to submit a pull request or open an issue on GitHub.

See Contributing

๐Ÿ“œ License

Athena is released under the MIT License.

Disclaimer

Please note that all of this info is a GPT-4 hallucination, it may or may not be accurate.

Current state (anything else will be from the davinci model and is very random):

Dark Mode Light Mode

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

athena_ai-0.0.12.tar.gz (1.3 MB view hashes)

Uploaded Source

Built Distribution

athena_ai-0.0.12-py3-none-any.whl (25.7 kB view hashes)

Uploaded Python 3

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