Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

[0.5.4] - 2026-03-21

Added

• New entity: SubscriptionPlan for subscription management
• New enum: PlanType (ONE_MONTH, THREE_MONTHS, SIX_MONTHS)

Changed

• N/A

Deprecated

• N/A

Removed

• N/A

Fixed

• N/A

Security

• N/A

[0.5.3] - 2026-03-21

Added

• New entity: CryptoOrder for crypto payment orders
• New enum: CryptoOrderStatus (PENDING, COMPLETED, FAILED, EXPIRED)

Changed

• N/A

Deprecated

• N/A

Removed

• N/A

Fixed

• N/A

Security

• N/A

[0.5.1] - 2026-03-21

Added

• New consumption billing entities: ConsumptionBilling, ConsumptionInvoice
• New enums: BillingStatus, InvoiceStatus, ConsumptionPaymentMethod

Changed

• N/A

Deprecated

• N/A

Removed

• N/A

Fixed

• N/A

Security

• N/A

[0.5.5] - 2026-03-21

Added

• SubscriptionPlan entity and PlanType enum (from local commit)

Changed

• N/A

Deprecated

• N/A

Removed

• N/A

Fixed

• N/A

Security

• N/A

[Unreleased]

Added

• Initial project structure
• Domain entities: User, VpnKey, Payment
• Domain enums: VpnType, KeyStatus, PaymentStatus, PaymentMethod
• Pydantic schemas for request/response validation
• Shared constants for plans, bonuses, and error codes
• Utility functions for validation and formatting
• Comprehensive test suite (33 tests)

Changed

• N/A

Deprecated

• N/A

Removed

• N/A

Fixed

• N/A

Security

• N/A

[0.1.0] - 2026-03-18

Added

• Initial Release 🎉
• Core domain entities for the uSipipo ecosystem
• Pydantic v2 schemas for API validation
• Shared constants and error codes
• Utility validators and formatters
• Test coverage for all modules
• Python 3.13+ support
• Published to GitHub Packages

Project Structure

usipipo_commons/
├── domain/
│   ├── entities/      # User, VpnKey, Payment
│   └── enums/         # VpnType, KeyStatus, PaymentStatus, PaymentMethod
├── schemas/           # Pydantic request/response models
├── constants/         # Plans, bonuses, error codes
└── utils/             # Validators, formatters

Dependencies

• pydantic>=2.12.0

Dev Dependencies

• pytest>=8.0.0
• pytest-cov>=4.0.0
• mypy>=1.0.0
• ruff>=0.1.0

Links

• GitHub Repository
• GitHub Packages
• Issue Tracker

What's New

• New entity: CryptoOrder for crypto payment orders
• New enum: CryptoOrderStatus (PENDING, COMPLETED, FAILED, EXPIRED)

Release v0.5.2

What's new

• Add ConsumptionBilling entity
• Add ConsumptionInvoice entity
• Add BillingStatus, InvoiceStatus, ConsumptionPaymentMethod enums

Version

v0.5.1