Nexus is an AI assistant designed to provide various helpful functionalities like calendaring, file management, weather updates, and more. It utilizes external APIs and Python libraries to enrich its features.
- AI Conversation: Engage with Nexus through an interactive console.
- Weather Information: Retrieve current weather updates.
- File Operations: Create, read, and delete files and directories.
- Calendar Management: Add, edit, and delete plans.
- Web Search: Search for information using the Google search engine.
- Measurement Unit Conversion: Convert measurement units (e.g., 10 miles to inches)
-
Clone the Repository
git clone https://github.com/HunterH1218/Nexus-1.0.git cd Nexus-1.0
-
Install Dependencies Ensure you have Python 3.11 or later installed. You can check your Python version with:
python3 --version
-
Install Required Packages Use pip to install the necessary Python packages:
pip install -r requirements.txt
Nexus utilizes several external APIs to provide enriched functionality. Here are steps to configure the necessary APIs:
-
GEMINI API Configuration Nexus uses the Gemini API for generating AI responses.
- Get the API Key: Register on the Gemini API platform and obtain your API key.
- Set the API Key: Store the
GEMINI_API_KEY
as an environment variable on your system. This can be done by adding the following line to your.bashrc
,.zshrc
, or equivalent configuration file:export GEMINI_API_KEY='your_actual_api_key_here'
-
Weather API Configuration
For weather updates, Nexus uses the Open-Meteo API.
- Navigate to
nexus/weather/current.py
. - Set your geographical coordinates (latitude and longitude) for the location you want weather updates for.
- Navigate to
Run the AI assistant with the entry point script:
python3 main.py
Now, you can interact with Nexus by typing in the console. You can try things like:
- "Create a file named test.txt"
- "Add a plan for March 15th: meeting from 10:00 AM to 11:00 AM."
- "What's the weather"
You will need to configure your latitude and longitude in nexus/weather/current.py for weather to work. Latitude and longitude currently set to New York coordinates.
- main.py: The main script to interact with the Nexus AI Assistant.
- nexus/functions/: Directory containing various utility functions (e.g., file operations, calendar management).
- nexus/weather/: Contains modules for fetching and processing weather data.
- pyproject.toml: Project dependency and configuration file.
- .replit: Configuration file for the Replit environment.
We welcome contributions! Please fork the repository and submit a pull request for any bug fixes or enhancements.