Add contribution docs and Turkish README; update UI

EdgeTypE · EdgeTypE · commit 09b1ffbeb5e2 · 2025-10-28T16:48:16.000+03:00
Added CODE_OF_CONDUCT.md and CONTRIBUTING.md for project governance and contribution guidelines. Introduced README_TR.md for Turkish documentation. Updated README.md with badges, improved instructions, and added UI/CLI usage details. Modified app.py to default UI language to English and removed emoji prefixes from UI labels for a cleaner look.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+-   Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+-   The use of sexualized language or imagery, and sexual attention or advances of any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or email address, without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at **edgetype@goygoyengine.com**. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interaction in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,94 @@
+# Contributing to Pattern Analyzer
+
+First off, thank you for considering contributing to Pattern Analyzer! We welcome any contributions, from fixing a typo in the documentation to implementing a brand-new analysis plugin.
+
+This document provides guidelines for contributing to the project.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Pattern Analyzer Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+There are many ways to contribute to Pattern Analyzer:
+
+- **Reporting Bugs**: If you find a bug, please open an issue and provide detailed steps to reproduce it.
+- **Suggesting Enhancements**: Have an idea for a new feature or a new plugin? Open an issue to discuss it.
+- **Improving Documentation**: If you find parts of the documentation unclear or incomplete, feel free to submit a pull request with your improvements.
+- **Writing Code**: Contribute by fixing bugs, improving existing features, or adding new plugins.
+
+## Your First Code Contribution
+
+Unsure where to begin? A great place to start is by looking for issues tagged with `good first issue` or `help wanted`.
+
+### Development Setup
+
+To get your development environment ready, please follow these steps:
+
+1.  **Fork the repository** on GitHub.
+
+2.  **Clone your fork** locally:
+    ```bash
+    git clone https://github.com/edgetype/pattern-analyzer.git
+    cd pattern-analyzer
+    ```
+
+3.  **Create a virtual environment**:
+    ```bash
+    python -m venv .venv
+    ```
+
+4.  **Activate the virtual environment**:
+    -   On Windows:
+        ```powershell
+        .venv\Scripts\Activate.ps1
+        ```
+    -   On macOS and Linux:
+        ```bash
+        source .venv/bin/activate
+        ```
+
+5.  **Install dependencies** in editable mode. This is crucial as it allows your local code changes to be immediately reflected when you run the `patternanalyzer` command.
+    ```bash
+    pip install -e .[test,ml,ui]
+    ```
+
+### Pull Request Process
+
+1.  **Create a new branch** for your feature or bug fix:
+    ```bash
+    git checkout -b feature/my-awesome-plugin-or-something-else
+    ```
+
+2.  **Make your changes**. Write clean, readable code and follow the existing code style.
+
+3.  **Add tests** for your changes. This is very important.
+    -   If you're fixing a bug, add a test that fails without your change and passes with it.
+    -   If you're adding a new feature, add tests that cover its functionality.
+    -   Tests are located in the `tests/` directory.
+
+4.  **Run the full test suite** to ensure everything is working correctly:
+    ```bash
+    pytest
+    ```
+
+5.  **Update the documentation** if necessary.
+    -   If you've added a new plugin, add it to the `docs/test-reference.md` file.
+    -   If you've changed the CLI or API, update the relevant sections in the `docs/` folder.
+
+6.  **Commit your changes** with a clear and descriptive commit message.
+
+7.  **Push your branch** to your fork on GitHub:
+    ```bash
+    git push origin feature/my-awesome-plugin
+    ```
+
+8.  **Open a Pull Request** to the `main` branch of the original repository.
+    -   Provide a clear title and a detailed description of your changes.
+    -   If your PR addresses an existing issue, link it by including `Closes #123` in the description.
+
+Your pull request will be reviewed, and we'll provide feedback. Thank you for your contribution!
+
+### A Note on Plugin Development
+
+One of the most valuable ways to contribute is by creating new plugins. The framework is designed to make this easy. For a detailed guide on creating your own tests, transforms, or visualizers, please see our **[Plugin Developer Guide](./docs/plugin-developer-guide.md)**.
diff --git a/README.md b/README.md
@@ -1,7 +1,15 @@
+
+<!-- Badges -->
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/)
+[![Donate](https://img.shields.io/badge/sponsor-GitHub%20Sponsors-ff69b4.svg)](https://github.com/sponsors/edgetype)
+
 # Pattern Analyzer
 
 Pattern Analyzer is a comprehensive, plugin-based framework for binary data analysis in Python. It provides a powerful engine to apply statistical tests, cryptographic analysis, and structural format detection on any binary data source.
 
+*[Turkish](./README_TR.md)*
+
 ## Features
 
 - **Extensible Plugin Architecture**: Easily add new statistical tests, data transformers, or visualizers.
@@ -23,7 +31,7 @@ It is recommended to install Pattern Analyzer in a virtual environment.
 
 ```bash
 # Clone the repository
-git clone https://github.com/your-username/pattern-analyzer.git
+git clone https://github.com/edgetype/pattern-analyzer.git
 cd pattern-analyzer
 
 # Create and activate a virtual environment
@@ -43,6 +51,8 @@ The optional dependencies are:
 
 ### Command Line Interface (CLI)
 
+**Standard Analysis**
+
 Analyze a binary file using a default set of tests and save the report.
 
 ```bash
@@ -52,7 +62,33 @@ patternanalyzer analyze test.bin --out report.json
 Use a specific configuration profile for a focused analysis (e.g., cryptographic tests).
 
 ```bash
-patternanalyzer analyze encrypted.bin --profile crypto --out crypto_report.json
+patternanalyzer analyze encrypted.bin --profile crypto --out crypto_report.json```
+
+**Discovery Mode**
+
+If you don't know what kind of transformation might have been applied to your data, use `--discover` mode. It automatically tries to find common patterns like single-byte XOR keys and reports the most likely candidates.
+
+```bash
+patternanalyzer analyze secret.bin --discover --out discover_report.json
+```
+The output file `discover_report.json` will contain a list of potential transformations and a preview of the resulting data.
+
+### User Interfaces (Web & Terminal)
+
+**Web UI (Streamlit)**
+
+Launch an interactive web interface to upload files and visualize results.
+
+```bash
+patternanalyzer serve-ui
+```
+
+**Terminal UI (TUI)**
+
+Start a terminal-based interface for analysis directly in your console.
+
+```bash
+patternanalyzer tui
 ```
 
 ### Python API
diff --git a/README_TR.md b/README_TR.md
@@ -0,0 +1,151 @@
+[Click for the English version](./README.md)
+
+# Pattern Analyzer
+
+Pattern Analyzer, ikili (binary) verileri analiz etmek için Python'da yazılmış kapsamlı ve eklenti tabanlı bir çerçevedir. Herhangi bir ikili veri kaynağına istatistiksel testler, kriptografik analizler ve yapısal format tespiti uygulamak için güçlü bir motor sağlar.
+
+## Özellikler
+
+- **Genişletilebilir Eklenti Mimarisi**: Kolayca yeni istatistiksel testler, veri dönüştürücüler veya görselleştiriciler ekleyin.
+- **Zengin Eklenti Kütüphanesi**: Aşağıdakiler için çok çeşitli yerleşik eklentilerle birlikte gelir:
+  - **İstatistiksel Analiz**: NIST benzeri testler (Monobit, Runs, FFT), Dieharder'dan esinlenilmiş testler ve Hurst Exponent ve Entropi gibi gelişmiş metrikler.
+  - **Kriptografik Analiz**: ECB modu şifrelemesini, tekrarlayan anahtar XOR desenlerini algılar ve AES S-box'ları gibi bilinen sabitleri arar.
+  - **Yapısal Analiz**: ZIP, PNG ve PDF gibi formatlar için temel ayrıştırıcılar.
+  - **Makine Öğrenmesi**: Anomali tespiti için Autoencoder, LSTM ve önceden eğitilmiş sınıflandırıcılar kullanır.
+- **Çoklu Arayüzler**: Pattern Analyzer'ı istediğiniz gibi kullanın:
+  - Betikleme ve otomasyon için **Komut Satırı Arayüzü (CLI)**.
+  - Etkileşimli analiz ve görselleştirme için **Web Kullanıcı Arayüzü (Streamlit)**.
+  - Terminal tabanlı etkileşim için **Metin Tabanlı Kullanıcı Arayüzü (TUI)**.
+  - Pattern Analyzer'ı diğer hizmetlere entegre etmek için **REST API (FastAPI)**.
+- **Yüksek Performanslı Motor**: Güvenlik ve kararlılık için paralel test yürütmeyi, büyük dosyalar için akış (streaming) analizini ve sanal alanlı (sandboxed) eklenti yürütmeyi destekler.
+
+## Kurulum
+
+Pattern Analyzer'ı sanal bir ortamda kurmanız önerilir.
+
+```bash
+# Depoyu klonlayın
+git clone https://github.com/edgetype/pattern-analyzer.git
+cd pattern-analyzer
+
+# Sanal bir ortam oluşturun ve etkinleştirin
+python -m venv .venv
+# Windows'ta: .venv\Scripts\activate
+# macOS/Linux'ta: source .venv/bin/activate
+
+# Paketi tüm isteğe bağlı bağımlılıklarla birlikte düzenlenebilir modda kurun
+pip install -e .[test,ml,ui]
+```
+İsteğe bağlı bağımlılıklar:
+- `test`: `pytest` ile test paketini çalıştırmak için.
+- `ml`: Makine öğrenmesi tabanlı eklentiler için (TensorFlow, scikit-learn).
+- `ui`: Streamlit web arayüzü ve Textual TUI için.
+
+## Hızlı Başlangıç
+
+### Komut Satırı Arayüzü (CLI)
+
+**Standart Analiz**
+
+Bir ikili dosyayı varsayılan test setiyle analiz edin ve raporu kaydedin.
+
+```bash
+patternanalyzer analyze test.bin --out report.json
+```
+
+Odaklanmış bir analiz için belirli bir yapılandırma profili kullanın (örneğin, kriptografik testler).
+
+```bash
+patternanalyzer analyze encrypted.bin --profile crypto --out crypto_report.json
+```
+
+**Keşif Modu (Discovery Mode)**
+
+Verilerinize ne tür bir dönüşüm uygulanmış olabileceğini bilmiyorsanız `--discover` modunu kullanın. Bu mod, tek baytlık XOR anahtarları gibi yaygın desenleri otomatik olarak bulmaya çalışır ve en olası adayları raporlar.
+
+```bash
+patternanalyzer analyze secret.bin --discover --out discover_report.json
+```
+Çıktı dosyası `discover_report.json`, potansiyel dönüşümlerin bir listesini ve sonuç verisinin bir önizlemesini içerecektir.
+
+### Kullanıcı Arayüzleri (Web & Terminal)
+
+**Web Arayüzü (Streamlit)**
+
+Dosyaları yüklemek ve sonuçları görselleştirmek için etkileşimli bir web arayüzü başlatın.
+
+```bash
+patternanalyzer serve-ui
+```
+
+**Terminal Arayüzü (TUI)**
+
+Doğrudan konsolunuzda analiz yapmak için terminal tabanlı bir arayüz başlatın.
+
+```bash
+patternanalyzer tui
+```
+
+### Python API
+
+Programatik olarak bir analiz işlem hattı çalıştırın.
+
+```python
+from patternanalyzer.engine import Engine
+
+# Analiz motorunu başlat
+engine = Engine()
+
+# Bir dosyadan veri yükle
+with open("test.bin", "rb") as f:
+    data_bytes = f.read()
+
+# Bir analiz yapılandırması tanımla
+# Bu örnek, monobit testini çalıştırmadan önce basit bir XOR dönüşümü uygular
+config = {
+    "transforms": [{"name": "xor_const", "params": {"xor_value": 127}}],
+    "tests": [{"name": "monobit", "params": {}}],
+    "fdr_q": 0.05 # Yanlış Keşif Oranı (FDR) anlamlılık seviyesini ayarla
+}
+
+# Analizi çalıştır
+output = engine.analyze(data_bytes, config)
+
+# Sonuçları yazdır
+import json
+print(json.dumps(output, indent=2))
+```
+
+## Proje Yapısı
+
+```
+pattern-analyzer/
+├── patternanalyzer/               # Çerçevenin ana kaynak kodu
+│   ├── plugins/              # Yerleşik analiz ve dönüşüm eklentileri
+│   ├── __init__.py
+│   ├── engine.py             # Çekirdek analiz motoru
+│   ├── plugin_api.py         # Eklentiler için temel sınıflar (Test, Transform, Visual)
+│   ├── cli.py                # Click tabanlı Komut Satırı Arayüzü
+│   ├── api.py                # FastAPI tabanlı REST API
+│   ├── tui.py                # Textual tabanlı Terminal Kullanıcı Arayüzü
+│   └── ...
+├── app.py                    # Streamlit Web Kullanıcı Arayüzü
+├── docs/                     # MkDocs için dokümantasyon dosyaları
+├── tests/                    # Pytest birim ve entegrasyon testleri
+├── pyproject.toml            # Proje üst verileri ve bağımlılıklar
+└── README.md
+```
+
+## Katkıda Bulunma
+
+Katkılarınızı bekliyoruz! Lütfen bir "issue" açmaktan veya bir "pull request" göndermekten çekinmeyin.
+
+1.  Depoyu "fork"layın.
+2.  Yeni bir özellik dalı oluşturun (`git checkout -b feature/my-new-feature`).
+3.  Değişikliklerinizi uygulayın ve testler ekleyin.
+4.  Tüm testlerin geçtiğinden emin olun (`pytest`).
+5.  Bir "pull request" gönderin.
+
+## Lisans
+
+Bu proje MIT Lisansı altında lisanslanmıştır. Ayrıntılar için [LICENSE](LICENSE) dosyasına bakın.
diff --git a/app.py b/app.py
