tsrkit-types 0.1.0__tar.gz

tsrkit_types-0.1.0/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-12-19
+
+### Added
+- Initial release of tsrkit-types library
+- Core `Codable` interface for all types
+- Integer types: `Uint` with fixed-size (`U8`, `U16`, `U32`, `U64`) and variable-size variants
+- String type: `String` with UTF-8 encoding and length prefix
+- Boolean type: `Bool` with single-byte encoding
+- Null types: `Null` singleton and `Nullable[T]` wrapper
+- Choice types: `Choice[T1, T2, ...]` for tagged unions and `Option[T]` for optional values
+- Container types:
+  - Sequence types: `Array`, `Vector`, `TypedArray`, `TypedVector`, `BoundedVector`, `TypedBoundedVector`
+  - Dictionary type: `Dictionary[K, V]` with typed keys and values
+- Bytes types: `Bytes` for raw binary data and `BitArray` for bit sequences
+- Enumeration type: `Enum` with integer backing and string names
+- Structured types: `@struct` decorator for automatic `Codable` implementation
+- Binary serialization with efficient encoding formats
+- JSON serialization with customizable field mapping
+- Type safety with runtime validation
+- Generic type parameters for flexible usage
+- Comprehensive test suite
+- MIT license
+- Complete API documentation
+
+### Features
+- All types implement the `Codable` interface for consistent encoding/decoding
+- Memory-efficient encoding optimized for common use cases
+- Type validation at construction and assignment time
+- Support for nested and complex type compositions
+- Zero-dependency core library
+- Python 3.12+ support
+
+## [Unreleased]
+
+### Planned
+- Performance optimizations for large data structures
+- Additional integer types (signed integers)
+- Time and date types
+- UUID type
+- Decimal/fixed-point numeric types
+- Schema validation and migration support
+- Code generation tools
+- Benchmarking suite
+- Documentation examples and tutorials 

tsrkit_types-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing to TSRKit Types
+
+We welcome contributions! Here's how to get started.
+
+## Development Setup
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/chainscore/tsrkit-types.git
+   cd tsrkit-types
+   ```
+
+2. **Install development dependencies:**
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+## Running Tests
+
+Run the full test suite:
+```bash
+pytest
+```
+
+Run tests with coverage:
+```bash
+pytest --cov=tsrkit_types --cov-report=html
+```
+
+Run tests in parallel (faster):
+```bash
+pytest -n auto
+```
+
+Run specific test files:
+```bash
+pytest tests/test_integers.py
+pytest tests/test_strings.py
+```
+
+## Code Style
+
+- Follow PEP 8
+- Use type hints for all functions and methods
+- Add docstrings for public APIs
+- Keep functions focused and testable
+
+## Submitting Changes
+
+1. **Fork the repository** on GitHub
+2. **Create a feature branch** from `main`:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+3. **Make your changes** and add tests
+4. **Run the test suite** to ensure everything passes
+5. **Commit your changes** with descriptive messages
+6. **Push to your fork** and submit a pull request
+
+## What to Contribute
+
+- Bug fixes
+- New data types or features
+- Performance improvements
+- Documentation improvements
+- Test coverage improvements
+
+## Questions?
+
+Feel free to open an issue for discussion before starting work on major changes.
+
+Thanks for contributing! 🚀 

tsrkit_types-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Chainscore Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

tsrkit_types-0.1.0/MANIFEST.in

@@ -0,0 +1,19 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include CONTRIBUTING.md
+include pytest.ini
+include pyproject.toml
+include setup.py
+
+recursive-include tsrkit_types *.py
+recursive-include tests *.py
+
+exclude .gitignore
+exclude .github/*
+exclude examples/*
+exclude .pytest_cache/*
+exclude __pycache__/*
+exclude *.pyc
+exclude .coverage
+exclude htmlcov/*