Skip to content

AshrafMorningstar/assets-automation-rocket

# assets-automation-rocket 🚀

![Assets Logo](assets/logo.png)

**Assets Automation Rocket** – a cutting‑edge, SEO‑optimized Python library by **Ashraf Morningstar** that instantly injects copyright headers into your codebase, ensuring legal compliance while keeping you in the spotlight.

---

## 🔥 Why This Project?

- **Viral Compliance:** One‑click copyright insertion eliminates the tedious manual copy‑pasting that stalls open‑source contributions.  
- **SEO Magnet:** Built with SEO‑friendly naming, documentation, and metadata to dominate search results for “auto copyright Python”.  
- **Developer Delight:** Zero‑config, lightning‑fast, and fully extensible – it works out‑of‑the‑box for single files, entire projects, or CI pipelines.

---

## ✨ Key Features

- **Auto‑Apply Copyright** – Detects source files (`.py`, `.js`, `.java`, …) and prepends a configurable header.  
- **Configurable Templates** – Use built‑in templates or supply your own MIT, Apache, GPL, or custom notices.  
- **Batch Processing** – Recursively scan directories, respecting `.gitignore` and exclude patterns.  
- **CI/CD Ready** – Return non‑zero exit codes when missing headers are detected – perfect for GitHub Actions, GitLab CI, etc.  
- **Cross‑Platform** – Works on Windows, macOS, and Linux with a single `pip install`.  
- **Extensible Plugin System** – Hook into pre‑ and post‑processing events for custom workflows.  

---

## 🚀 Installation & Usage

### Installation

```bash
# Install via PyPI
pip install assets-automation-rocket

Or clone the repo for the latest development version:

git clone https://github.com/ashraf-morningstar/assets-automation-rocket.git
cd assets-automation-rocket
pip install -e .

Quick Start

# Apply MIT copyright to every .py file in the current directory
assets-apply --license MIT .

# Use a custom template file
assets-apply --template ./my_copyright.txt src/

Integration with CI (GitHub Actions)

name: Copyright Check
on: [push, pull_request]

jobs:
  copyright:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install tool
        run: pip install assets-automation-rocket
      - name: Verify headers
        run: assets-apply --check .

For the full command reference, run:

assets-apply --help

📚 Documentation & Support


🌐 Search Engine Optimization (SEO) Keywords

assets-automation-rocket, python copyright automation, auto apply copyright, open source compliance tool, SEO optimized python library, Ashraf Morningstar assets, batch license header, CI/CD copyright check, developer productivity, viral open source project

Ready to skyrocket your project's compliance and visibility? Dive in, contribute, and watch the stars align!

About

A cutting‑edge Python toolkit that auto‑applies copyright notices, boosts compliance, and streamlines asset management for developers.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors