Skip to content

AshrafMorningstar/auto-copyright-master

# auto-copyright-master 🚀

<div align="center">
  <img src="assets/logo.png" alt="auto-copyright-master Logo" width="200" height="auto" onerror="this.style.display='none'"/>
  <br/>

  <h1>auto-copyright-master</h1>

  <p><strong>Effortlessly protect your code with intelligent, automated copyright headers.</strong></p>

  <p>
    <a href="https://github.com/AshrafMorningstar/auto-copyright-master">GitHub Repository</a> |
    <a href="https://pypi.org/project/auto-copyright-master/">PyPI</a>
  </p>
</div>

---

## 🔥 Why This Project?

Open‑source projects and internal codebases often forget to embed proper copyright notices, leading to licensing ambiguities and legal risk.  
**auto-copyright-master** scans your assets, detects missing headers, and injects clean, standards‑compliant notices in seconds—so you can focus on building, not paperwork.

---

## ✨ Key Features

- **One‑Command Execution** – Run a single CLI call to process an entire repository.  
- **Multi‑Language Support** – Detects and updates Python, JavaScript, Java, C/C++, Go, and more.  
- **Configurable Templates** – Choose from MIT, Apache, GPL, or custom templates via `config.yaml`.  
- **Dry‑Run Mode** – Preview changes before they touch your files.  
- **Idempotent Updates** – Re‑running the tool never duplicates headers.  
- **Git‑Aware Integration** – Skips files already committed with correct notices.  
- **Extensible Plugin System** – Add new language parsers without touching core code.  

---

## 🚀 Installation & Usage

### Prerequisites
- Python 3.8 +  
- `git` (optional, for repository awareness)

### Install via PyPI
```bash
pip install auto-copyright-master

Quick Start

# Scan the current directory and apply missing notices
auto-copyright-master .

# Dry‑run mode (shows a diff without writing)
auto-copyright-master . --dry-run

# Use a custom configuration file
auto-copyright-master . --config path/to/config.yaml

Advanced Example (Git‑aware)

# Only modify untracked or changed files
auto-copyright-master . --git-aware

Uninstall

pip uninstall auto-copyright-master

📚 Documentation

  • Full CLI Reference: auto-copyright-master --help
  • Configuration Guide: See assets/config.yaml.example for template options.
  • Contribution Guidelines: Review CONTRIBUTING.md for code standards and pull‑request flow.

🤝 Contributing

We welcome community contributions! Please read our Code of Conduct and Contributing documents before submitting a pull request.


📜 License

Distributed under the MIT License. See LICENSE for details.


🌐 Search Engine Optimization (SEO) Keywords

python, copyright automation, code licensing, open source compliance, cli tool, auto header insertion, software asset management, developer utilities, license enforcement, code quality


About

Automated copyright insertion for code assets – fast, reliable, and SEO‑optimized.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors