ocean-crow-mizukage 0.2.3
A project scaffolding tool by OceanCrow with assistance from Grok, built by xAI
Requires Python: >=3.8

# 🌊 OceanCrow_Mizukage 🌊

**Version:** 0.2.3  
**Created by:** Sheldon Kenny Salmon of OceanCrow with assistance from Grok, built by xAI  
**License:** MIT License  
**Repository:** https://github.com/OceanCrow-TT/ocean_crow_mizukage  
**Issues:** https://github.com/OceanCrow-TT/ocean_crow_mizukage/issues  
**Homepage:** https://oceancrow.carrd.co  

## 📖 Overview

OceanCrow_Mizukage is a powerful command-line tool designed to scaffold, automate, and secure Python projects with ninja-like efficiency. Whether you're starting a basic script, a Flask app, or a data science project, Mizukage streamlines the process with features like environment setup, code optimization, and security analysis. Built with love by OceanCrow and enhanced by xAI's Grok, this tool is your partner in coding mastery!

## 🚀 Installation

### Prerequisites
- Python 3.9 or higher
- pip (Python package manager)

### Steps

**Clone the Repository (optional, for development):**
```bash
git clone https://github.com/OceanCrow-TT/ocean_crow_mizukage.git
cd ocean_crow_mizukage
```

**Set Up a Virtual Environment (recommended):**
```bash
python -m venv env
source env/bin/activate # On Windows: env\Scripts\activate
```

**Install Dependencies:**
```bash
pip install click rich pytest flask pandas numpy
```

**Install Mizukage:**

From source (after building):
```bash
python -m build
pip install dist/ocean_crow_mizukage-0.2.1.tar.gz
```

From PyPI (recommended, now live):
```bash
pip install ocean_crow_mizukage
```

## 🎮 Usage

Mizukage is invoked via the command line. Run `mizukage --help` to see available options and commands.

### Basic Commands

**Show Help:**
```bash
mizukage --help
```

**Output:**
```
Usage: mizukage [OPTIONS] COMMAND

Options:
  --quick Use last config
  --undo Revert to backup
  --feedback TEXT Submit feedback
  --theme [default|dark] Output theme
  --help Show this message and exit.

Commands:
  start Start the project setup
```

**Start a New Project:**
```bash
mizukage start
```
Prompts for project name, type (basic, flask, datascience), and features. Sets up the project structure and runs the workflow.

**Quick Start with Last Config:**
```bash
mizukage --quick start
```
Uses the last saved configuration without prompting.

**Use Dark Theme:**
```bash
mizukage --theme dark start
```
Runs with a dark-themed UI.

**Submit Feedback:**
```bash
mizukage --feedback "Great tool! Add X feature."
```
Saves feedback to feedback.txt and suggests sharing on X with @OceanCrowtt.

**Revert to Backup:**
```bash
mizukage --undo
```
Restores the last backup of the config file.

### Project Workflow

1. **Setup:** Enter project details and select features (e.g., scaffold, autoenv, codeflow).
2. **Execution:** Mizukage creates directories, generates files, sets up a virtual environment, and runs optimizations.
3. **Output:** A success banner and a 4D map are generated.

### Example Project Structure

After running `mizukage start` with default settings:

```
MyMegaProject/
├── src/
│ └── main.py
├── tests/
├── docs/
│ ├── README.md
│ ├── contribution.md
│ └── LICENSE
├── env/ (if autoenv enabled)
├── start_project.bat (or .sh on Unix)
├── commands.txt
└── diagram.txt
```

## 🎨 Features

- **Scaffold:** Creates project directories and template files.
- **Autoenv:** Sets up a virtual environment.
- **Codeflow:** Automates testing with pytest.
- **Databridge:** Generates dummy data files.
- **Mindmap:** Creates a simple project map.
- **Quantum:** Adds optimized code snippets.
- **Orchestrate:** Runs all features in sequence.

## ⚙️ Configuration

- Config is stored in `~/.ocean_crow_config.json`.
- Backups are saved as `~/.ocean_crow_config_backup_*.json`.
- Use `--undo` to revert to the latest backup.

## 🛠️ Development

### Contributing

1. Fork the repository.
2. Create a branch: `git checkout -b feature/your-feature`.
3. Commit changes: `git commit -m 'Add your feature'`.
4. Push to the branch: `git push`.
5. Open a Pull Request.

### Building

```bash
python -m build
pip install dist/ocean_crow_mizukage-0.2.1.tar.gz
```

### Publishing to PyPI

1. Ensure twine is installed: `pip install twine`.
2. Upload (with .pypirc configured):
```bash
twine upload dist/*
```

## 🤝 Support

- **Feedback:** Use `mizukage --feedback "Your message"` and tag @OceanCrowtt on X.
- **Issues:** Report bugs or suggestions at https://github.com/OceanCrow-TT/ocean_crow_mizukage/issues.
- **Contact:** Reach out to Sheldon Kenny Salmon at OceanCrowtt@gmail.com or https://oceancrow.carrd.co.

## 📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

## 🌟 Acknowledgments

- Built with ❤️ by Sheldon Kenny Salmon of OceanCrow.
- Enhanced with AI assistance from Grok, created by xAI.
- Thanks to the open-source community for tools like click, rich, and pytest!