Skip to content

Releases: darth-veitcher/uuid-forge

v0.1.1 - Documentation Fixes

Choose a tag to compare

@darth-veitcher darth-veitcher released this 01 Oct 16:21

Documentation Fixes

This patch release fixes all documentation to match the actual v0.1.0 API implementation.

Fixed

  • Updated all API documentation with correct class names (UUIDGenerator, IDConfig, Namespace)
  • Fixed all code examples to use correct method signatures
  • Rewrote CLI documentation to match actual CLI commands
  • Removed references to non-existent CLI features
  • Updated 14 documentation files across getting-started, guides, use-cases, and API reference sections

Changes

  • All generate() calls now correctly show generate(entity_type, **kwargs) signature
  • CLI documentation now accurately reflects 8 actual commands: generate, extract, new-salt, init, validate, info, docs, test
  • Removed incorrect CLI options: --version, --format, --case parameters
  • Removed non-existent features: config subcommand, preset system

Full Changelog: v0.1.0...v0.1.1

v0.1.0: Clean Namespace API and Production-Ready Features

Choose a tag to compare

@darth-veitcher darth-veitcher released this 01 Oct 10:30

🎉 First Stable Release!

✨ Major Features

🎯 Clean Namespace Class:

  • Simple domain-to-UUID conversion: Namespace('domain.com')
  • Eliminates complex import patterns: uuid5(NAMESPACE_DNS, ...)
  • Clean equality, hashing, and string representation
  • Full backward compatibility with existing UUID namespaces

📚 Comprehensive Documentation:

  • Enhanced README with OO patterns and configuration examples
  • Repository, Factory, and Dependency Injection patterns
  • Multi-tenant configuration examples
  • All code examples automatically validated

🧪 Complete Test Coverage:

  • test_readme_examples.py with 18 test classes
  • Every README code example automatically validated
  • 150+ tests with 85%+ coverage
  • Prevents documentation regression

🔧 Self-Contained Imports:

  • Re-export UUID, uuid5, NAMESPACE_DNS from main package
  • Eliminates need for separate uuid module imports
  • Clean developer experience: from uuid_forge import UUID

🚀 Production Ready

  • ✅ All tests passing with comprehensive coverage
  • ✅ Type checking clean (mypy)
  • ✅ Backward compatibility preserved
  • ✅ Zero-coordination UUID generation across storage systems
  • ✅ Secure cryptographic salt support
  • ✅ CLI included for salt generation and configuration

📦 Installation

pip install uuid-forge

🎯 Perfect For

  • Microservices architectures needing consistent IDs
  • Multi-storage systems (Postgres + S3 + Redis + QDrant + MinIO)
  • Zero-coordination design patterns
  • Deterministic testing scenarios
  • Data migration with consistent IDs

Made with ❤️ for developers who value simplicity and determinism