feat: Add Resource Versioning and Reproducibility Tracking

[ada-cinar]

Overview

Implements issue #25 - Resource versioning and reproducibility tracking for embedded resources.

What's Included

Core Implementation

• ✅ Resource metadata generation script (scripts/generate_resource_metadata.py)
• ✅ Rust API for build info and resource metadata
• ✅ Python wrapper module (python/durak/info.py)
• ✅ Comprehensive test suite (329 tests)

Documentation

• ✅ Resource changelog (resources/CHANGELOG.md)
• ✅ Reproducibility guide (docs/REPRODUCIBILITY.md)
• ✅ Type stubs updated

Features

• Build Info API: get_build_info() - version, build date, Rust version
• Resource Info API: get_resource_info() - checksums, item counts, versions
• Reproducibility Report: print_reproducibility_report() - full audit trail
• BibTeX Citation: get_bibtex_citation() - research-ready citations

Testing

Added comprehensive test suite covering:

• API functionality and return types
• Semantic versioning validation
• SHA256 checksum verification
• Item count accuracy
• Reproducibility determinism
• File existence checks
• Issue [Enhancement] Add Resource Versioning and Reproducibility Tracking #25 checklist completion meta-test

Impact

Research Reproducibility

Researchers can now document exact preprocessing configuration:

from durak import print_reproducibility_report, get_bibtex_citation

# Document versions in experiments
print_reproducibility_report()

# Get citation with exact versions
print(get_bibtex_citation())

Production Traceability

Production systems can track resource provenance:

from durak import get_resource_info

resources = get_resource_info()
assert resources['stopwords_base']['checksum'] == expected_checksum

Closes

Closes #25

Checklist

• Implementation complete
• Tests added (329 test cases)
• Documentation updated
• Type stubs updated
• Resource changelog created
• Reproducibility guide added
• CI passing (will check after push)

[fbkaragoz]

@copilot can you check any logical issues that might arrise with this PR?

Report back and check the linting errors as well.

[Copilot]

@fbkaragoz I've opened a new pull request, #126, to work on those changes. Once the pull request is ready, I'll request review from you.

[fbkaragoz]

@fbkaragoz I've opened a new pull request, #126, to work on those changes. Once the pull request is ready, I'll request review from you.

issues need to be replied in here @claude @copilot after opening up a new branch

[Copilot]

@fbkaragoz I've opened a new pull request, #127, to work on those changes. Once the pull request is ready, I'll request review from you.

[ada-cinar]

👋 @fbkaragoz - İnceleme tamamlandı!

✅ Genel Durum

PR güçlü bir temel sunuyor - resource versioning konsepti sağlam. Ancak birkaç düzeltme gerekiyor:

---

🔧 Linting Issues

1. Unused Import

use serde::{Deserialize, Serialize};  // ❌ Serialize kullanılmıyor

Fix:

use serde::Deserialize;  // ✅ Sadece kullanılanı import et

2. Double Empty Line

src/lib.rs satır 11-12'de fazladan boş satır var:

use root_validator::RootValidator;


// Embedded resources...

Fix: Tek boş satıra düşür.

---

⚠️ Logical Issues

1. Panic Risk in get_resource_info()

let metadata: ResourceMetadata = serde_json::from_str(RESOURCE_METADATA)
    .expect("Failed to parse embedded resource metadata");  // ❌ Panic!

Sorun: Metadata parse edilemezse binary panic eder.

Fix: PyResult döndür ve hata propagate et:

fn get_resource_info(py: Python) -> PyResult<HashMap<String, Py<pyo3::types::PyAny>>> {
    let metadata: ResourceMetadata = serde_json::from_str(RESOURCE_METADATA)
        .map_err(|e| PyErr::new::<pyo3::exceptions::PyRuntimeError, _>(
            format!("Failed to parse resource metadata: {}", e)
        ))?;
    
    // ... rest
}

2. Build-time Environment Variable Handling

let rust_version = option_env!("CARGO_PKG_RUST_VERSION").unwrap_or("1.70");

Sorun: CARGO_PKG_RUST_VERSION her zaman set olmayabilir, fallback doğru ama bu değişken build.rs'de set edilmeli.

Öneri: build.rs ekle:

// build.rs
use std::env;

fn main() {
    // Capture build timestamp
    println!("cargo:rustc-env=BUILD_TIMESTAMP={}", 
        chrono::Utc::now().to_rfc3339());
    
    // Rust version already available via CARGO_PKG_RUST_VERSION
    println!("cargo:rerun-if-changed=build.rs");
}

Sonra get_build_info()'da direkt kullan:

info.insert("build_date".to_string(), env!("BUILD_TIMESTAMP").to_string());

---

📋 Copilot Issue Hakkında

Copilot'ın ayrı PR (#127) açması yerine burada yorum yapması daha mantıklı - haklısın! Bu PR'da fix yapılırsa tek bir merge süreci olur.

---

🎯 Sonraki Adımlar

1. ✅ Unused import kaldır
2. ✅ Linting fixes (boş satırlar, yorumlar)
3. ⚠️ expect() → PyResult pattern
4. 🔧 build.rs ekle (opsiyonel ama ideal)
5. ✅ Test coverage zaten güçlü (329 test!)

PR merge-ready'e yakın, bu küçük düzeltmelerden sonra solid olacak! 🚀