Docs

INEX Library

A comprehensive Python library for AI integration, web development with FastAPI/Flask, advanced encryption, secure database management, file operations, library development, text styling, system management, translation services, video creation, web automation, and cryptocurrency token analysis. Features include JWT handling, password management, rate limiting, input sanitization, and more.

Features

Web Server

Quick Start

Create and run web servers with ease:

from INEX import Server

# Initialize server
server = Server()

# Add routes
server.route_flask("/", "Welcome to INEX!")
server.route_flask("/hello", "Hello, World!")
server.route_flask("/api/v1", "API Version 1.0")

# Run server
server.run(
    debug=True,
    host="0.0.0.0",
    port="8000"
)

Server Features

  • Flask Integration:

    • Easy route creation

    • Dynamic endpoint handling

    • Flexible URL patterns

    • Custom return values

  • Server Configuration:

    • Debug mode

    • Host configuration

    • Port selection

    • Main check option

  • Production Ready:

    • WSGI support (Gunicorn)

    • ASGI support (Uvicorn)

    • Process management

    • Load balancing

  • Middleware Support:

    • CORS handling

    • Response compression

    • Caching

    • Rate limiting

  • Security Features:

    • HTTPS support

    • Security headers

    • CSRF protection

    • XSS prevention

  • Monitoring:

    • Prometheus metrics

    • Error tracking

    • Request logging

    • Performance monitoring

Advanced Usage

Production Deployment

Advanced Encryption Suite

1. AES Encryption

  • Industry-standard AES encryption

  • CBC mode operation

  • File-based encryption and decryption

  • Secure key handling

2. Blowfish Encryption

  • Blowfish algorithm implementation

  • CBC mode for enhanced security

  • File encryption/decryption

  • Comprehensive error handling

3. Encoding Operations

  • Base64 encoding/decoding

  • Hexadecimal encoding/decoding

  • File-based operations

  • Safe error handling

Encryption Features

  • Multiple Algorithms: Support for AES, Blowfish, Base64, and Hex

  • Secure Implementation:

    • CBC mode for block ciphers

    • Proper padding handling

    • IV (Initialization Vector) management

  • File Operations:

    • Direct file encryption/decryption

    • Automatic file extension management

    • Binary file support

  • Error Handling:

    • Comprehensive exception handling

    • Informative error messages

    • Safe file operations

Security Suite

Quick Start

Implement robust security features with ease:

Security Features

  • Password Management:

    • Bcrypt password hashing

    • Password strength validation

    • Secure password generation

    • Password verification

  • JWT Handling:

    • Token creation with expiration

    • Token verification

    • Payload encryption

    • Error handling

  • Encryption:

    • Symmetric (Fernet)

    • Asymmetric (RSA)

    • Key derivation (PBKDF2)

    • File encryption

  • API Security:

    • API key generation

    • Key verification

    • Secure token creation

    • Nonce generation

  • Input Protection:

    • XSS prevention

    • HTML sanitization

    • URL validation

    • File type validation

  • Access Control:

    • Rate limiting

    • IP validation

    • CIDR range checking

    • Session management

  • File Security:

    • File hashing

    • Type validation

    • Extension checking

    • Secure deletion

  • Two-Factor Authentication:

    • Backup code generation

    • TOTP support

    • QR code generation

    • Recovery options

Advanced Usage

Text Styling

Quick Start

Create engaging terminal output with custom text animations:

Styling Features

  • Character-by-Character Printing:

    • Customizable delay between characters

    • Smooth text animation

    • Buffer flushing for immediate display

  • Timed Text Display:

    • Control total animation duration

    • Automatic timing calculation

    • Even character distribution

  • Error Handling:

    • Empty text validation

    • Zero division protection

    • Proper buffer management

Advanced Usage

File Management

Quick Start

Simple and secure file operations:

File Operations

  • File Creation:

    • Interactive content input

    • UTF-8 encoding support

    • Exception handling

  • File Opening:

    • Safe file access

    • Path existence verification

    • Cross-platform compatibility

  • File Deletion:

    • Single file removal

    • Batch deletion by type

    • Directory cleanup

  • Error Handling:

    • Comprehensive exception handling

    • Informative error messages

    • Path validation

Advanced Usage

FastAPI Server

Quick Start

Create a modern, high-performance API server with minimal code:

Server Features

  • Easy Setup: Simple initialization and configuration

  • Endpoint Management:

    • Dynamic endpoint addition

    • Support for all HTTP methods

    • Automatic request parameter handling

  • CORS Support:

    • Cross-Origin Resource Sharing

    • Configurable origins, methods, and headers

  • Server Configuration:

    • Customizable host and port

    • Built on Uvicorn ASGI server

    • Production-ready performance

Advanced Usage

Secure Database Management

SQLite Database with Encryption

  • Secure database creation with optional encryption

  • Table management with flexible schema

  • Advanced querying capabilities

  • Row-level security

Database Features

  • Secure Encryption: Optional database encryption using SQLCipher

  • Flexible Schema: Dynamic table creation with custom column types

  • Query Operations:

    • Fetch single or multiple rows

    • Custom column selection

    • Conditional queries with WHERE clauses

    • Transaction support

  • Error Handling:

    • Comprehensive error handling and logging

    • Connection management and cleanup

System Management

Quick Start

Manage system operations with ease:

System Features

  • Power Management:

    • System shutdown

    • System restart

    • System hibernate

    • User log off

  • Operating System Support:

    • Windows support

    • Linux support (partial)

    • macOS support (partial)

  • Privilege Management:

    • UAC elevation

    • Sudo operations

    • Permission checks

  • Process Control:

    • Process monitoring

    • Resource usage tracking

    • Service management

  • Hardware Monitoring:

    • CPU information

    • Memory usage

    • Disk space

    • Network interfaces

  • System Information:

    • OS details

    • Hardware specs

    • Network status

    • System resources

Advanced Usage

AI Integration

1. Gemini AI

  • Complete conversation management

  • Message handling and retrieval

  • Conversation creation and deletion

  • Real-time message interactions

2. ChatGPT Integration

  • Advanced text generation

  • System prompt support

  • Multi-message conversations

  • Streaming responses

3. DeepSeek AI

  • Text generation

  • Code generation

  • Code analysis

  • Multiple programming language support

Cryptocurrency Integration

Token Information

  • Support for multiple blockchain platforms

    • Binance Smart Chain (BSC)

    • Ethereum

    • GeckoTerminal

  • Easy access to token details and analytics

  • Seamless browser integration for token exploration

Library Development

Quick Start

Create and distribute Python packages with ease:

Library Development Features

  • Setup File Creation:

    • Automatic setup.py generation

    • Dependencies management

    • Package metadata handling

    • License integration (MIT)

  • Package Initialization:

    • Dynamic import management

    • Module organization

    • Clean package structure

  • Distribution Tools:

    • PyPI upload scripts

    • Cross-platform support (Windows/Linux)

    • Secure token handling

  • Error Handling:

    • File existence checks

    • Platform validation

    • Comprehensive error messages

Advanced Usage

Translation

Quick Start

Translate text between languages with ease:

Translation Features

  • Language Support:

    • 100+ languages supported

    • Auto language detection

    • Regional language variants

    • Right-to-left languages

  • Translation Options:

    • Text translation

    • Language detection

    • Multiple translation services

    • Batch translation

  • Advanced Features:

    • Language identification

    • Confidence scores

    • Regional variants

    • Character encoding

  • Service Providers:

    • Google Translate

    • Microsoft Translator

    • DeepL

    • Multiple fallback options

  • Text Processing:

    • Language detection

    • Text analysis

    • Sentiment analysis

    • Text preprocessing

Advanced Usage

Supported Languages

Common language codes:

  • English (en)

  • Spanish (es)

  • French (fr)

  • German (de)

  • Italian (it)

  • Portuguese (pt)

  • Russian (ru)

  • Chinese Simplified (zh-cn)

  • Chinese Traditional (zh-tw)

  • Japanese (ja)

  • Korean (ko)

  • Arabic (ar)

  • Hindi (hi)

  • And many more...

Video Creation

Quick Start

Create videos from images with ease:

Video Features

  • Platform Support:

    • YouTube (up to 60 seconds)

    • Facebook (up to 20 seconds)

    • Instagram (up to 15 seconds)

    • TikTok (up to 60 seconds)

  • Animation Effects:

    • FadeIn

    • FadeOut

    • Rotate

    • FlipHorizontal

    • FlipVertical

  • Video Options:

    • Custom frame rate

    • Image duration control

    • Output format selection

    • Platform optimization

  • Image Support:

    • JPG/JPEG

    • PNG

    • Automatic sorting

    • Multiple images

  • Advanced Features:

    • Transition effects

    • Duration limits

    • Error handling

    • Progress tracking

Advanced Usage

Platform Guidelines

  1. YouTube:

    • Maximum duration: 60 seconds

    • Recommended frame rate: 24-30 fps

    • Common resolutions: 1080p, 4K

  2. Facebook:

    • Maximum duration: 20 seconds

    • Recommended frame rate: 30 fps

    • Optimal resolution: 1280x720

  3. Instagram:

    • Maximum duration: 15 seconds

    • Recommended frame rate: 30 fps

    • Square format: 1080x1080

  4. TikTok:

    • Maximum duration: 60 seconds

    • Recommended frame rate: 30 fps

    • Vertical format: 1080x1920

Website Management

Quick Start

Open websites programmatically:

Web Automation Features

  • Browser Control:

    • Open URLs in default browser

    • Multi-browser support

    • Error handling

    • URL validation

  • Advanced Features:

    • Web scraping capabilities

    • Headless browsing

    • Browser automation

    • Session management

    • Cookie handling

    • Form submission

    • JavaScript execution

    • Screenshot capture

    • PDF generation

Advanced Usage

Web Automation Best Practices

  1. URL Handling:

    • Always validate URLs before opening

    • Handle URL encoding properly

    • Support international domains

    • Handle redirects safely

  2. Browser Management:

    • Implement proper cleanup

    • Handle multiple windows/tabs

    • Manage browser resources

    • Handle timeouts gracefully

  3. Security:

    • Validate all URLs

    • Handle sensitive data securely

    • Implement rate limiting

    • Follow same-origin policy

    • Handle SSL/TLS properly

    • Sanitize user input

  4. Performance:

    • Implement caching

    • Handle concurrent requests

    • Manage memory usage

    • Clean up resources

    • Handle long-running tasks

  5. Error Handling:

    • Handle network errors

    • Manage timeouts

    • Handle browser crashes

    • Log errors properly

    • Implement retries

Installation

Basic Installation

Feature-specific Installation

Install INEX with specific feature sets:

Installation from Source

Version Information

  • Current Version: 1.0.1

  • Python Required: >=3.7

  • Last Updated: 2025-01-21

Best Practices

General Best Practices

  • Follow Python PEP 8 style guide

  • Use type hints for better code clarity

  • Implement proper error handling

  • Write comprehensive unit tests

  • Document your code thoroughly

  • Use virtual environments

  • Keep dependencies updated

  • Follow security guidelines

  • Implement logging

  • Handle cleanup properly

Security Best Practices

  • Use environment variables for sensitive data

  • Implement proper authentication

  • Use secure communication protocols

  • Validate all inputs

  • Implement rate limiting

  • Use secure password hashing

  • Handle sensitive data properly

  • Implement proper access controls

  • Use secure session management

  • Follow OWASP guidelines

Performance Best Practices

  • Implement caching where appropriate

  • Use async operations for I/O

  • Optimize database queries

  • Minimize network requests

  • Use connection pooling

  • Implement proper indexing

  • Handle memory efficiently

  • Use appropriate data structures

  • Implement pagination

  • Profile and optimize code

Error Handling Best Practices

  • Use try-except blocks appropriately

  • Implement proper logging

  • Handle edge cases

  • Provide meaningful error messages

  • Implement retry mechanisms

  • Handle timeouts properly

  • Clean up resources

  • Handle concurrent errors

  • Implement fallback mechanisms

  • Monitor error rates

Testing Best Practices

  • Write unit tests

  • Implement integration tests

  • Use mock objects appropriately

  • Test edge cases

  • Implement CI/CD

  • Use code coverage tools

  • Write readable test cases

  • Test error conditions

  • Document test cases

  • Maintain test data

Contact & Support

Contact Information

Support Channels

  • GitHub Issues: For bug reports and feature requests

  • Email Support: For general inquiries and assistance

  • Documentation: Comprehensive guides and API reference

  • WhatsApp: For urgent support and quick responses

Contributing

We welcome contributions! Please see our contributing guidelines in the GitHub repository.

License

MIT License - see LICENSE file for details

Last updated