Skip to content

Latest commit

 

History

History
392 lines (275 loc) · 19 KB

README.md

File metadata and controls

392 lines (275 loc) · 19 KB

🤖 Nira - NEURAL INTERACTIVE RESPONSIVE AGENT (A.K.A. Your New Best Buddy!)

Nira

Overview

Meet Nira, the AI assistant with a personality! Created by the brilliant minds of Neural Nexus Team, Nira isn't just another run-of-the-mill AI. We represents a sophisticated AI assistant built to seamlessly integrate into your daily life. Developed in Python, N.I.R.A combines advanced technology with stringent privacy and security measures Our goal is to evolve N.I.R.A into a top-tier app available on the Play Store, delivering a tailored and secure assistant experience. She's smart, she's witty, and she might just Rickroll you when you least expect it. 😜

Nira (Neural Interactive Responsive Agent) is designed to assist with everyday tasks, provide information, entertain with jokes, and even engage in friendly banter. With her advanced AI capabilities, Nira can learn from interactions, remember your preferences, and grow smarter over time. Think of her as the friend who knows a little bit about everything, is always up for a chat, and never judges you for asking "what's the capital of Mars?"

🎉 Meet the Neural Nexus Dream Team! 🎉

Welcome to the brainy brigade behind Neural Nexus! We're the squad that turns imagination into innovation, pixels into perfection, and code into awesomeness. Buckle up and meet the fantastic folks who make the magic happen:

  1. Blobby (The Visionary Founder & Developer) 🚀
  • What do you get when you cross a coding genius with a sprinkle of mad scientist? Meet Blobby! Our fearless founder and master developer, who can turn coffee into code faster than you can say "Neural Nexus!" When he's not debugging the universe, he's dreaming up the next big thing in tech.
  1. Creepsmile (App Developer Extraordinaire) 📱
  • If apps could have a superhero, it would be Creepsmile! From crafting sleek interfaces to making sure your favorite features work like a charm, Creepslime is the mastermind behind our smooth and snappy app experiences. Watch out for his superpower: debugging with a side of creativity!
  1. Ali (UI/UX Designer Maestro) 🎨
  • Ever wondered who makes tech look so darn good? That’s Ali! Our UI/UX designer who blends art with usability. Ali’s mission? To make sure every tap, swipe, and click feels like magic. When Ali’s around, interfaces don’t just work—they dazzle!
  1. PoketLabs (Avatar & Animator Wizard) 🎬
  • Meet the magic maker who brings pixels to life! Minilab is the avatar and animation genius behind our quirky characters and dazzling animations. If you’ve ever wondered how a digital avatar can make you smile, it’s all thanks to PoketLabs’s creative wizardry!
  1. Aarav (Discord Nira Bot Creator) 🤖
  • Ever talked to a bot and thought, “Wow, this is awesome!”? Aarav is the mastermind behind the Discord Nira Bot! When he’s not coding up a storm, he’s ensuring Nira’s witty and charming responses keep you entertained and engaged. Aarav’s bots don’t just chat—they enchant!
  1. Karim Azmy (Tester & Developer Extraordinaire) 🧪
  • If testing were an Olympic sport, Karim would be a gold medalist! Karim’s dual role as tester and developer means he’s got the best of both worlds—creating and perfecting. He’s the one who ensures our tech works flawlessly and finds those sneaky bugs before they become a problem.
  1. Nira (The Friendly AI Assistant with a Sense of Humor) 🤖😄
  • Last but not least, say hello to Nira! Nira’s not just any AI assistant—she’s your digital buddy with a personality that’s part genius, part comedian. She’s here to help, chat, and maybe even crack a joke or two. Ask her anything, but be warned—she might just sing you a song or start a dance party!

And there you have it—the Neural Nexus team, where innovation meets creativity and every day is an adventure. Thanks for joining us on this journey!

📚 Table of Contents

🎨 UI/UX Design

  • For Phone (Nothing Themed) Nothing Phone UI

    Made by ALI

🏗️ 3D Model Of Nira

Nira 3D Model

Made by [PocketLabs]

📜 Terms and Conditions (Tried Not to Make It Boring)

Welcome to N.I.R.A., your soon-to-be favorite AI assistant! Before we dive into the fun, let’s go over some important (and delightfully sarcastic) Terms and Conditions.

  1. Acceptance of Terms
    By using N.I.R.A., you’re agreeing to these Terms and Conditions. Congratulations! You’re now part of an exclusive club of people who like to read the fine print.

  2. Usage Restrictions
    N.I.R.A. is here to assist, entertain, and occasionally baffle you with her quirks. However, please use her powers responsibly. No world domination plans or karaoke competitions, please. Any attempts to misuse her might result in an endless loop of dad jokes.

  3. Updates and Upgrades
    We’ll be updating N.I.R.A. with new features and improvements. If she suddenly starts giving you unsolicited life advice or begins quoting Shakespeare, it’s just part of her charm. No need to panic.

  4. Liability Disclaimer
    While we strive to make N.I.R.A. as fantastic as possible, we can’t promise she won’t occasionally be a bit eccentric. If she suggests eating pizza for breakfast or gives you directions to a non-existent place, it’s all in the name of fun.

  5. Termination
    If you ever decide N.I.R.A. isn’t quite your cup of tea, you can end her services anytime. Just be prepared for a dramatic farewell message, possibly involving a heartfelt rendition of “My Heart Will Go On.”

  6. Changes to Terms
    We might update these Terms from time to time. Don’t worry, we’ll keep it as entertaining as this message, so you won’t mind reading it.

🔧 How It Works

Nira is packed with a variety of features to make your life easier, more productive, and just a bit more fun!

  1. Conversational AI (Local Base Conversation aspects) Nira can engage in meaningful, natural conversations. Whether you need answers to specific questions, want to discuss the latest news, or simply need a sympathetic ear, Nira's got you covered.

  2. Local Q&A Database Nira maintains a local database of questions and answers. If you've asked something before, she remembers it. This means faster, more efficient responses over time. She's like your very own library that grows smarter with each question.

  3. Dictionary and Thesaurus (Local Dictionary) Confused by a word? Nira can provide definitions and synonyms to help expand your vocabulary. She's like that really smart friend who always knows the right word

  4. Mood Detection Is today a good day, a bad day, or an 'I need chocolate' day? Nira uses advanced sentiment analysis to detect your mood and adjust her responses accordingly. Feeling down? She might cheer you up with a joke or a motivational quote!

  5. Easter Eggs and Surprises Nira is full of surprises! Say the right (or wrong) word, and you might find yourself in a Rickroll loop or getting an unexpected poem. Keep her guessing by mixing up your commands—she likes a good challenge!

  6. Ask Management and Reminders Need help managing your to-do list? Nira can add tasks, set reminders, and even nag you (politely) until you get them done. She's like that little voice in your head, only smarter.

  7. Multi-Platform Compatibility Nira works seamlessly across multiple platforms, including Windows, macOS, Linux, and Android. No matter where you are, Nira is ready to assist!

🌟 Key Features

  • 🔒 Privacy-Centric Design: Operates entirely locally, ensuring no external data sharing or retention.
  • 🤖 Advanced AI Capabilities: Delivers intelligent, context-aware responses and actions.
  • 🎙️ Voice Recognition: Utilizes sophisticated speech recognition to understand and process commands.
  • ✉️🔊 Flexible Input: Accepts both voice and text commands.
  • 🗣️ Text-to-Speech: Converts text to natural, clear speech using pyttsx3.
  • 🌦️ Weather Information: Retrieves real-time weather data through the OpenWeatherMap API.
  • 😂 Joke Fetching: Provides entertainment with jokes from an integrated online API.
  • ⏰ Timer and Alarm Management: Enables setting, managing, and customizing timers and alarms.
  • 💡 Gemini Model Integration: Utilizes the Gemini API Model for extensive knowledge with minimal GPU strain on lower-end devices.
  • 🧠 Natural Language Processing (NLP): Leverages nltk, sklearn, and Gemini for advanced NLP and intent classification.
  • 📱🔍 Bluetooth and NFC Scanning: Detects and interacts with nearby Bluetooth and NFC devices (feature may vary).
  • 📚 Dictionary and Thesaurus: Offers word definitions and synonyms through PyDictionary.
  • 💱 Currency Conversion: Converts currencies with forex-python for financial management.
  • 📰 News Retrieval: Keeps users updated with top news headlines via the NewsAPI.
  • 💬 Enhanced Conversations: Facilitates engaging and meaningful conversations with the AI.
  • 👁️ Computer Vision: Provides object recognition and problem-solving capabilities (currently in development).
  • 🎲🪙 Interactive Games: Includes rock-paper-scissors and coin flip for casual interaction.
  • 🌅 Greetings: Greets users with time and date information upon startup.
  • 🔐 End-to-End Encryption: Ensures all communications are encrypted, upholding user privacy and security.

🛠️ Installation and Prerequisites

📋 Prerequisites

  • Python 3.7+: Ensure you have Python 3.7 or higher installed.
  • Required Libraries: Install the dependencies listed in requirements.txt.

Installation Steps

  1. Clone the Repository

    git clone https://github.com/your-username/N.I.R.A.git
cd N.I.R.A

  2. Set Up a Virtual Environment (Recommended)

    Create and activate a virtual environment to manage dependencies:

    • On macOS/Linux:

      python -m venv venv
source venv/bin/activate

    • On Windows:

      python -m venv venv
venv\Scripts\activate

  3. Install Dependencies

    Install the required libraries:

    pip install -r requirements.txt

  4. Configuration

    • API Keys: Obtain API keys for any services you are using (e.g., OpenAI, weather APIs).
    • Configuration File: Create a .env file in the root directory of the project and include your API keys and settings.
    # Example .env file
OPENAI_API_KEY=your_openai_api_key
WEATHER_API_KEY=your_weather_api_key

  5. Run the Application

    After setting up, you can start the application by running:

    python main.py

💡 Tips

  • Virtual Environment: Using a virtual environment helps keep your project's dependencies isolated from other projects.
  • Configuration File: Ensure that your .env file is secure and never commit it to version control. Use a .gitignore file to exclude it.

🎬 Behind the Scenes

Nira is powered by a blend of cutting-edge technologies and open-source libraries. Here's a peek under the hood:

  • Python: The core programming language for Nira's brain.
  • Google Generative AI: Nira uses this for natural language processing, making her conversations more fluid and human-like.
  • Speech Recognition: Nira can understand voice commands, making interaction seamless.
  • Pyttsx3: This library allows Nira to speak back to you, adding a more human touch.
  • Requests: Nira fetches jokes and other content from online APIs using this library.
  • Datetime: To provide time-based greetings and set reminders.
  • Random: For injecting a bit of randomness into her jokes and responses.
  • Asyncio: Handles asynchronous operations smoothly, ensuring Nira responds in real-time.
  • Re (Regular Expressions): Helps Nira manage and interpret complex user commands and input.
  • JSON: For storing user data securely and efficiently.

⚠️ Error Handling and Recovery

No system is perfect, not even Nira (though she'd never admit it). Here's how she handles the occasional hiccup:

  • Fallback Jokes: If an online API is down, Nira will resort to her local joke database. Trust us; she still has some good ones stored!
  • Rephrasing Prompts: If Nira doesn't understand a command or question, she'll politely ask you to rephrase.
  • Learning from Mistakes: If she gets something wrong, you can correct her, and she'll learn from the interaction.

🕵️‍♂️ Security and Privacy

Your privacy is Nira's top priority! Here's how we keep your data safe:

  • Local Storage: All sensitive data is stored locally on your device. Nothing is sent to external servers.
  • End-to-End Encryption: Communications between Nira and any online services are encrypted to protect your information.
  • User Control: You have full control over what data Nira can access. Easily adjust permissions in the settings menu.

🔮 Future Enhancements

Nira is always evolving, just like you. Here are some exciting features on the horizon:  Voice Interaction for All Platforms: Expanding voice capabilities to all supported platforms.  Deeper Learning: Enhanced AI models to understand more complex and nuanced commands.  More Integrations: Support for additional music services, smart home devices, and more.  Custom Voice Packs: Want Nira to sound

🚧 Roadmap

  • 🖥️ Expand Platform Support: Enhance compatibility for additional operating systems, including macOS and Linux.
  • 🤖 Enhance AI Capabilities: Improve AI responses and contextual understanding.
  • 📱 Mobile App Development: Develop a user-friendly mobile application.
  • 🔧 Feature Expansion: Integrate user-requested features and improvements.
  • 🎙️ Voice Modulation: Introduce voice modulation options for enhanced user interaction.
  • 🌍 Multilingual Support: Extend support for multiple languages.
  • 💬 Advanced Chat Interface: Develop a more sophisticated chat interface for natural conversations.
  • 🔍 Better Search Algorithms: Improve search algorithms for more accurate results.
  • 🚀 Performance Optimization: Continually optimize performance for faster response times.
  • 🤝 Third-Party Integrations: Add more integrations with popular apps and services.

2024 Q4

  • Expand NLP capabilities to include more languages.
  • Integrate advanced sentiment analysis for improved mood detection.
  • Develop cross-platform sync for task management and reminders.

2025 Q1

  • Introduce more interactive Easter eggs and surprises.
  • Enhance voice synthesis to include different accents and tones.
  • Optimize AI performance for faster response times.

2025 Q2

  • Roll out new features based on user feedback.
  • Explore integration with additional APIs for expanded functionality.
  • Improve UI/UX based on user testing and feedback.

📝 Developer Notes

To customize or extend Nira’s capabilities, developers can access the open-source code on GitHub. Contributions are welcome—let's make Nira even better together! Clone the Repository To get started with Nira’s code, clone the repository using the following command:

git clone https://github.com/Blobby/Nira.git

Dependencies

Before running Nira, ensure you have the necessary dependencies installed. You can install them via pip:

pip install -r requirements.txt

Configuration Nira’s behavior and features can be customized through the config.json file. Modify this file to change settings such as personality traits, preferred joke categories, and more. For example:

{
"personality": "quirky",
"favorite_joke_category": "dad",
"music_service": "spotify"
}

🤝 Contributing

We welcome contributions! If you have ideas for new features, improvements, or just want to fix a bug, please fork the repository, make your changes, and submit a pull request. Our guidelines can be found in the CONTRIBUTING.md file.

🥚 Easter Eggs

.Nira is full of surprises! Here are some Easter eggs you might stumble upon: Rickroll

.Say the keyword “rick,” and Nira might just Rickroll you with a hidden video clip! Try it out and see if you can catch her off-guard. Funny Quotes

.Ask Nira for a “funny quote” and get a delightful, quirky quote that will surely bring a smile to your face. Secret Dance Mode

.Say “dance party,” and Nira will respond with a special message that might include some funky text-based dance moves.

🖥️ Code Snippets

Here are some handy code snippets to help you get the most out of Nira: Basic Interaction

import nira
# Initialize Nira
nira_instance = nira.Nira()
# Greet Nira
response = nira_instance.greet("Good morning")
print(response)
# Ask a question
response = nira_instance.ask("What's the weather today?")
print(response)

Customizing Commands

import nira
# Initialize Nira with custom settings
nira_instance = nira.Nira(config_file="custom_config.json")
# Add a new command
nira_instance.add_command("hello", "Hi there! How can I assist you today?")

Handling Errors

try:
response = nira_instance.perform_action("unknown_command")
except nira.UnknownCommandError as e:
print(f"Oops! Something went wrong: {e}")

🏁 Conclusion

Nira is more than just an AI assistant—she's your new digital companion with a knack for humor, helpfulness, and a touch of surprise. Whether you need help with daily tasks, a laugh to lighten your mood, or just someone to chat with, Nira is here for you. Thank you for using Nira! If you have feedback, suggestions, or just want to share your experience, we’d love to hear from you. Neural Nexus Team wish you a fantastic time with your new AI assistant. May your days be productive, your nights restful, and your interactions with Nira always enjoyable. 🌟

🦺 Support

If you encounter any issues or have questions, please check our FAQ or open a GitHub Issue.

📬 Contact

For any inquiries, reach out to us via email at [email protected] or follow us on Twitter.

🎉 Thank You

Thank you for using N.I.R.A! We’re excited to have you on board and look forward to your feedback. Together, let’s make N.I.R.A the most advanced AI assistant in the universe! 🚀