elvic-ascii-studio 1.0.0

package/README.md

@@ -0,0 +1,82 @@
+# Elvic ASCII Studio
+
+A powerful terminal-based ASCII art generator with AI integration.
+
+## Installation
+
+### Via npm (Global)
+
+```bash
+npm install -g elvic-ascii-studio
+```
+
+### Via pip (Recommended)
+
+```bash
+pip install elvic-ascii-studio
+```
+
+## Requirements
+
+- **Python 3.8+** (required)
+- **pip** (Python package manager)
+- **Node.js 14+** (if installing via npm)
+
+## Usage
+
+After installation, run:
+
+```bash
+elvic-ascii
+```
+
+## Features
+
+- 🎨 **Text to ASCII Art** - Convert text to ASCII art with 900+ fonts
+- 🖼️ **Image to ASCII** - Convert images to ASCII art (colored or monochrome)
+- 🤖 **AI-Enhanced ASCII** - Generate ASCII art with OpenAI integration
+- ⭐ **Font Favorites** - Save and manage your favorite fonts
+- 📊 **Font Browser** - Browse curated Top 25 fonts by category
+- 💡 **Smart Recommendations** - Get font suggestions based on use case
+- 🎯 **Presets** - Quick access to font collections
+
+## Quick Start
+
+1. Install the package:
+   ```bash
+   npm install -g elvic-ascii-studio
+   ```
+
+2. Run the CLI:
+   ```bash
+   elvic-ascii
+   ```
+
+3. Choose an option from the menu and start creating ASCII art!
+
+## Configuration
+
+For AI features, you'll need an OpenAI API key. Create a `.env` file:
+
+```bash
+OPENAI_API_KEY=your_api_key_here
+```
+
+## Documentation
+
+For full documentation, visit:
+https://github.com/elvic-group/elvic-ascii-studio
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Author
+
+Elvic Kongolo
+
+## Support
+
+- Issues: https://github.com/elvic-group/elvic-ascii-studio/issues
+- Discussions: https://github.com/elvic-group/elvic-ascii-studio/discussions
+

package/bin/elvic-ascii.js

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+
+/**
+ * Elvic ASCII Studio - npm wrapper
+ * This script ensures Python is available and runs the Python CLI
+ */
+
+const { spawn } = require('child_process');
+const { platform } = require('os');
+
+// Check if Python is available
+function checkPython() {
+  return new Promise((resolve, reject) => {
+    const pythonCommands = ['python3', 'python'];
+    let checkedCount = 0;
+
+    pythonCommands.forEach(cmd => {
+      const proc = spawn(cmd, ['--version'], { stdio: 'pipe' });
+      
+      proc.on('error', () => {
+        checkedCount++;
+        if (checkedCount === pythonCommands.length) {
+          reject(new Error('Python not found'));
+        }
+      });
+
+      proc.on('close', (code) => {
+        if (code === 0) {
+          resolve(cmd);
+        } else {
+          checkedCount++;
+          if (checkedCount === pythonCommands.length) {
+            reject(new Error('Python not found'));
+          }
+        }
+      });
+    });
+  });
+}
+
+// Run the Python CLI
+async function runCLI() {
+  try {
+    const pythonCmd = await checkPython();
+    
+    // Run the elvic-ascii command
+    const proc = spawn(pythonCmd, ['-m', 'elvic_ascii.cli'], {
+      stdio: 'inherit',
+      shell: true
+    });
+
+    proc.on('error', (err) => {
+      console.error('Error running Elvic ASCII Studio:', err.message);
+      console.error('\nPlease ensure Python 3.8+ is installed and elvic-ascii-studio is installed via pip:');
+      console.error('  pip install elvic-ascii-studio');
+      process.exit(1);
+    });
+
+    proc.on('close', (code) => {
+      process.exit(code || 0);
+    });
+
+  } catch (err) {
+    console.error('❌ Python 3.8+ is required to run Elvic ASCII Studio');
+    console.error('\nPlease install Python from:');
+    console.error('  - macOS: https://www.python.org/downloads/ or use Homebrew: brew install python3');
+    console.error('  - Linux: sudo apt install python3 (Ubuntu/Debian) or sudo yum install python3 (RHEL/CentOS)');
+    console.error('  - Windows: https://www.python.org/downloads/');
+    process.exit(1);
+  }
+}
+
+runCLI();
+

package/index.js

@@ -0,0 +1,23 @@
+/**
+ * Elvic ASCII Studio - npm package entry point
+ * 
+ * This package provides a global CLI command 'elvic-ascii'
+ * that wraps the Python-based Elvic ASCII Studio.
+ * 
+ * Installation:
+ *   npm install -g elvic-ascii-studio
+ * 
+ * Usage:
+ *   elvic-ascii
+ * 
+ * Requirements:
+ *   - Python 3.8+
+ *   - pip
+ */
+
+module.exports = {
+  name: 'elvic-ascii-studio',
+  version: '1.0.0',
+  description: 'A powerful terminal-based ASCII art generator with AI integration'
+};
+

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "elvic-ascii-studio",
+  "version": "1.0.0",
+  "description": "A powerful terminal-based ASCII art generator with AI integration",
+  "main": "index.js",
+  "bin": {
+    "elvic-ascii": "./bin/elvic-ascii.js"
+  },
+  "scripts": {
+    "postinstall": "node scripts/install-python-deps.js",
+    "test": "node scripts/test-installation.js"
+  },
+  "keywords": [
+    "ascii",
+    "ascii-art",
+    "cli",
+    "terminal",
+    "art",
+    "text-to-ascii",
+    "image-to-ascii",
+    "figlet",
+    "pyfiglet",
+    "openai",
+    "ai",
+    "generator",
+    "converter"
+  ],
+  "author": "Elvic Kongolo <43522377+elvic-group@users.noreply.github.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/elvic-group/elvic-ascii-studio.git"
+  },
+  "bugs": {
+    "url": "https://github.com/elvic-group/elvic-ascii-studio/issues"
+  },
+  "homepage": "https://github.com/elvic-group/elvic-ascii-studio#readme",
+  "engines": {
+    "node": ">=14.0.0",
+    "npm": ">=6.0.0"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "preferGlobal": true,
+  "files": [
+    "bin/",
+    "scripts/",
+    "README.md",
+    "LICENSE"
+  ]
+}
+

package/scripts/install-python-deps.js

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+
+/**
+ * Post-install script for npm package
+ * Installs the Python package via pip
+ */
+
+const { spawn } = require('child_process');
+const { platform } = require('os');
+
+console.log('📦 Installing Elvic ASCII Studio Python dependencies...\n');
+
+// Determine the pip command to use
+const pipCommands = ['pip3', 'pip'];
+
+function tryInstall(pipCmd) {
+  return new Promise((resolve, reject) => {
+    console.log(`Trying to install with ${pipCmd}...`);
+    
+    const proc = spawn(pipCmd, ['install', 'elvic-ascii-studio'], {
+      stdio: 'inherit',
+      shell: true
+    });
+
+    proc.on('error', (err) => {
+      reject(err);
+    });
+
+    proc.on('close', (code) => {
+      if (code === 0) {
+        resolve(true);
+      } else {
+        reject(new Error(`${pipCmd} install failed with code ${code}`));
+      }
+    });
+  });
+}
+
+async function installPythonPackage() {
+  for (const pipCmd of pipCommands) {
+    try {
+      await tryInstall(pipCmd);
+      console.log('\n✅ Elvic ASCII Studio installed successfully!');
+      console.log('\nYou can now run: elvic-ascii\n');
+      return;
+    } catch (err) {
+      // Try next pip command
+      continue;
+    }
+  }
+
+  // If we get here, all pip commands failed
+  console.error('\n❌ Failed to install Python dependencies');
+  console.error('\nPlease install manually:');
+  console.error('  pip install elvic-ascii-studio');
+  console.error('\nOr install Python 3.8+ from:');
+  console.error('  - macOS: https://www.python.org/downloads/ or brew install python3');
+  console.error('  - Linux: sudo apt install python3-pip');
+  console.error('  - Windows: https://www.python.org/downloads/\n');
+  process.exit(1);
+}
+
+installPythonPackage();
+

package/scripts/test-installation.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+
+/**
+ * Test script to verify installation
+ */
+
+const { spawn } = require('child_process');
+
+console.log('🧪 Testing Elvic ASCII Studio installation...\n');
+
+function testPython() {
+  return new Promise((resolve, reject) => {
+    const proc = spawn('python3', ['--version'], { stdio: 'pipe' });
+    
+    let output = '';
+    proc.stdout.on('data', (data) => {
+      output += data.toString();
+    });
+
+    proc.on('close', (code) => {
+      if (code === 0) {
+        console.log('✅ Python found:', output.trim());
+        resolve(true);
+      } else {
+        reject(new Error('Python not found'));
+      }
+    });
+
+    proc.on('error', () => {
+      reject(new Error('Python not found'));
+    });
+  });
+}
+
+function testPipPackage() {
+  return new Promise((resolve, reject) => {
+    const proc = spawn('pip3', ['show', 'elvic-ascii-studio'], { stdio: 'pipe' });
+    
+    let output = '';
+    proc.stdout.on('data', (data) => {
+      output += data.toString();
+    });
+
+    proc.on('close', (code) => {
+      if (code === 0 && output.includes('Name: elvic-ascii-studio')) {
+        const versionMatch = output.match(/Version: (.+)/);
+        const version = versionMatch ? versionMatch[1] : 'unknown';
+        console.log('✅ elvic-ascii-studio package found (version:', version + ')');
+        resolve(true);
+      } else {
+        reject(new Error('Package not installed'));
+      }
+    });
+
+    proc.on('error', () => {
+      reject(new Error('pip not found'));
+    });
+  });
+}
+
+async function runTests() {
+  try {
+    await testPython();
+    await testPipPackage();
+    console.log('\n✅ All tests passed! You can run: elvic-ascii\n');
+    process.exit(0);
+  } catch (err) {
+    console.error('\n❌ Test failed:', err.message);
+    console.error('\nPlease run: npm install\n');
+    process.exit(1);
+  }
+}
+
+runTests();
+