Skip to main content

🌟 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

Metadata

Release files for athena-ai 0.0.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for athena-ai 0.0.12
File Size Uploaded Provenance Actions
athena_ai-0.0.12.tar.gz 1.3 MB Without provenance Details for athena_ai-0.0.12.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for athena-ai 0.0.12
File Interpreter ABI Platform Actions
athena_ai-0.0.12-py3-none-any.whl Python 3 none any Details for athena_ai-0.0.12-py3-none-any.whl

Total release size: 1.3 MB

Release files / athena_ai-0.0.12.tar.gz

Download URL athena_ai-0.0.12.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
8fb5c4463e56dc46a372bea10f037cda64728327bfe6075819c0bd646a748b1b
BLAKE2b-256 checksum
How to use checksums
9fa6c1abcfc19ab1347f0470937ed1f8f765e64562f9e209033e3a359138921b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.4

Release files / athena_ai-0.0.12-py3-none-any.whl

Download URL athena_ai-0.0.12-py3-none-any.whl
Size 25.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
09c247ae546bd36d8da8ef063c7ecea37a871db5fcf57075209a5e314381299d
BLAKE2b-256 checksum
How to use checksums
4d3c28e1b9906a35061c6fec68052ae978693f8bb4e11d85de74c9cd63cc29c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.4

Security for athena-ai 0.0.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page