rustkmer 0.5.2

High-performance k-mer counting tool in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# Version Management

This document describes the version management strategy for RustKmer.

## Version Policy

RustKmer consists of two main components:
- **Rust CLI** (`rustkmer`) - Command-line tool
- **PyO3** (`pyrustkmer`) - Python bindings

Both components are versioned together using **Semantic Versioning (SemVer)**:
- **MAJOR**: Breaking changes
- **MINOR**: New features (backward compatible)
- **PATCH**: Bug fixes

## Version Synchronization

Both components should always be released with the same version number.

### Current Version

```
Rust CLI: 0.5.2
PyO3:     0.5.2
```

### Synchronization

Use the provided sync script to ensure versions stay in sync:

```bash
# Check if versions are in sync
./scripts/sync_versions.sh

# Or set a specific version
./scripts/sync_versions.sh 0.5.1
```

### Manual Update

When updating version, update these files:

1. **Rust CLI**:
   - `Cargo.toml` (root): `version = "X.Y.Z"`
   - `src/cli/args.rs`: Uses `env!("CARGO_PKG_VERSION")` (auto-syncs)

2. **PyO3**:
   - `pyo3/Cargo.toml`: `version = "X.Y.Z"`
   - `pyo3/pyproject.toml`: `version = "X.Y.Z"`

## Release Process

1. Update version in all files
2. Run `./scripts/sync_versions.sh` to verify
3. Update CHANGELOG.md
4. Create release commit
5. Build and test both components
6. Publish to respective package managers

## Version History

| Version | Date | Notes |
|---------|------|-------|
| 0.5.2 | 2026-02-28 | PyO3 count filter (-L/-U) support |
| 0.5.1 | 2026-02-21 | Current version |
| 0.5.0 | 2026-01-18 | Previous version |
| 0.4.1 | 2026-01-18 | PyO3 unified API |
| 0.4.0 | 2026-01-17 | Initial PyO3 release |
| 0.2.0 | 2026-01-16 | CLI refactoring |