samplesheet-parser 2.5.2__tar.gz → 2.6.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. samplesheet_parser-2.6.0/.github/ISSUE_TEMPLATE/bug_report.md +28 -0
  2. samplesheet_parser-2.6.0/.github/ISSUE_TEMPLATE/config.yml +8 -0
  3. samplesheet_parser-2.6.0/.github/ISSUE_TEMPLATE/feature_request.md +19 -0
  4. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/.github/workflows/copilot-instructions.md +4 -4
  5. samplesheet_parser-2.6.0/.github/workflows/draft-pdf.yml +31 -0
  6. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/.gitignore +5 -1
  7. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/.zenodo.json +2 -2
  8. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/CHANGELOG.md +124 -81
  9. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/CITATION.cff +2 -2
  10. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/CONTRIBUTING.md +6 -6
  11. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/Makefile +4 -4
  12. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/PKG-INFO +43 -37
  13. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/README.md +38 -35
  14. samplesheet_parser-2.6.0/SECURITY.md +23 -0
  15. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/api.md +13 -13
  16. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/cli.md +17 -10
  17. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/examples.md +12 -12
  18. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/conversion.md +4 -4
  19. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/diffing.md +2 -2
  20. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/filtering.md +9 -9
  21. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/merging.md +6 -6
  22. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/parsing.md +32 -9
  23. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/quickstart.md +3 -3
  24. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/splitting.md +7 -7
  25. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/validation.md +105 -7
  26. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/writing.md +2 -2
  27. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/index.md +9 -6
  28. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/installation.md +1 -1
  29. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/eval/FINDINGS.md +15 -15
  30. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/eval/README.md +7 -7
  31. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/eval/run_eval.py +4 -4
  32. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_converter.py +6 -6
  33. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_diff.py +11 -9
  34. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_filter.py +8 -8
  35. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_index_utils.py +13 -13
  36. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_merger.py +12 -12
  37. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_splitter.py +7 -7
  38. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_writer.py +8 -8
  39. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/parse_examples.py +20 -20
  40. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/README.md +28 -28
  41. samplesheet_parser-2.6.0/images/samplesheet_parser_arch_latest.png +0 -0
  42. samplesheet_parser-2.6.0/images/samplesheet_parser_arch_latest_dark.png +0 -0
  43. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/mkdocs.yml +1 -1
  44. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/convert/meta.yml +1 -1
  45. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/meta.yml +1 -1
  46. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/meta.yml +1 -1
  47. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/merge/meta.yml +1 -1
  48. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/split/meta.yml +1 -1
  49. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/meta.yml +1 -1
  50. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/paper.bib +3 -5
  51. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/paper.md +68 -36
  52. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/pyproject.toml +4 -2
  53. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/__init__.py +49 -21
  54. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/cli.py +100 -20
  55. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/factory.py +2 -2
  56. samplesheet_parser-2.6.0/samplesheet_parser/schema.py +176 -0
  57. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/validators.py +410 -25
  58. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/scripts/demo_converter.py +12 -11
  59. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/scripts/demo_diff.py +25 -29
  60. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/scripts/demo_writer.py +37 -47
  61. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_cli.py +192 -0
  62. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_parsers/test_v2.py +17 -0
  63. samplesheet_parser-2.6.0/tests/test_validators/test_pluggable.py +521 -0
  64. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_validators/test_validators.py +30 -0
  65. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/.github/workflows/ci.yml +0 -0
  66. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/.pre-commit-config.yaml +0 -0
  67. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/.readthedocs.yaml +0 -0
  68. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/CODE_OF_CONDUCT.md +0 -0
  69. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/LICENSE +0 -0
  70. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/changelog.md +0 -0
  71. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/ci.md +0 -0
  72. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/contributing.md +0 -0
  73. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/guide/index_utils.md +0 -0
  74. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/docs/requirements.txt +0 -0
  75. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/eval/__init__.py +0 -0
  76. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/eval/generate_corpus.py +0 -0
  77. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/eval/reference_rules.py +0 -0
  78. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_color_balance.py +0 -0
  79. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/demo_element_aviti.py +0 -0
  80. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/ProjectAlpha_SampleSheet.csv +0 -0
  81. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/ProjectBeta_SampleSheet.csv +0 -0
  82. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/ProjectDelta_SampleSheet_collision.csv +0 -0
  83. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/ProjectGamma_SampleSheet.csv +0 -0
  84. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/combined_clean.csv +0 -0
  85. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/combined_collision_forced.csv +0 -0
  86. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/combined_mixed_formats.csv +0 -0
  87. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/element_aviti_RunManifest.csv +0 -0
  88. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_dual_index.csv +0 -0
  89. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_multi_lane.csv +0 -0
  90. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_single_index.csv +0 -0
  91. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_with_lab_qc_settings.csv +0 -0
  92. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_with_manifests.csv +0 -0
  93. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_nextseq_single_index.csv +0 -0
  94. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_novaseq_x_dual_index.csv +0 -0
  95. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_with_cloud_settings.csv +0 -0
  96. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_with_index_umi.csv +0 -0
  97. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_with_pipeline_settings.csv +0 -0
  98. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_with_read_umi.csv +0 -0
  99. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/images/samplesheet_parser_arch_v03.png +0 -0
  100. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/images/samplesheet_parser_arch_v2.3.png +0 -0
  101. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/images/samplesheet_parser_overview.png +0 -0
  102. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/convert/environment.yml +0 -0
  103. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/convert/main.nf +0 -0
  104. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/convert/tests/main.nf.test +0 -0
  105. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/environment.yml +0 -0
  106. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/main.nf +0 -0
  107. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/tests/main.nf.test +0 -0
  108. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/tests/main.nf.test.snap +0 -0
  109. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/environment.yml +0 -0
  110. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/main.nf +0 -0
  111. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/tests/main.nf.test +0 -0
  112. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/tests/nextflow.config +0 -0
  113. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/environment.yml +0 -0
  114. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/main.nf +0 -0
  115. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/meta.yml +0 -0
  116. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/tests/main.nf.test +0 -0
  117. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/tests/main.nf.test.snap +0 -0
  118. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/merge/environment.yml +0 -0
  119. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/merge/main.nf +0 -0
  120. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/merge/tests/main.nf.test +0 -0
  121. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/split/environment.yml +0 -0
  122. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/split/main.nf +0 -0
  123. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/split/tests/main.nf.test +0 -0
  124. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/environment.yml +0 -0
  125. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/main.nf +0 -0
  126. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/tests/main.nf.test +0 -0
  127. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/tests/main.nf.test.snap +0 -0
  128. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/chemistry.py +0 -0
  129. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/converter.py +0 -0
  130. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/diff.py +0 -0
  131. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/enums.py +0 -0
  132. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/filter.py +0 -0
  133. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/index_utils.py +0 -0
  134. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/instruments.py +0 -0
  135. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/merger.py +0 -0
  136. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/parsers/__init__.py +0 -0
  137. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/parsers/element.py +0 -0
  138. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/parsers/v1.py +0 -0
  139. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/parsers/v2.py +0 -0
  140. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/protocol.py +0 -0
  141. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/py.typed +0 -0
  142. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/splitter.py +0 -0
  143. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/samplesheet_parser/writer.py +0 -0
  144. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/__init__.py +0 -0
  145. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/conftest.py +0 -0
  146. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/fixtures/SampleSheet_v1_dual_index.csv +0 -0
  147. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/fixtures/SampleSheet_v2_dual_index.csv +0 -0
  148. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/fixtures/SampleSheet_v2_modified.csv +0 -0
  149. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_chemistry.py +0 -0
  150. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_converter.py +0 -0
  151. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_diff.py +0 -0
  152. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_eval.py +0 -0
  153. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_factory.py +0 -0
  154. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_filter.py +0 -0
  155. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_index_utils.py +0 -0
  156. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_instruments.py +0 -0
  157. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_merger.py +0 -0
  158. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_parsers/__init__.py +0 -0
  159. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_parsers/test_element.py +0 -0
  160. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_parsers/test_v1.py +0 -0
  161. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_reference_rules.py +0 -0
  162. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_splitter.py +0 -0
  163. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_validators/__init__.py +0 -0
  164. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_validators/test_hamming.py +0 -0
  165. {samplesheet_parser-2.5.2 → samplesheet_parser-2.6.0}/tests/test_writer.py +0 -0
@@ -0,0 +1,28 @@
1
+ ---
2
+ name: Bug report
3
+ about: Report a problem so it can be fixed
4
+ title: ''
5
+ labels: bug
6
+ assignees: ''
7
+ ---
8
+
9
+ **Describe the bug**
10
+ A clear and concise description of what went wrong.
11
+
12
+ **To reproduce**
13
+ A minimal example that triggers it. Please include:
14
+
15
+ - `samplesheet-parser` version (`samplesheet --version`)
16
+ - Python version (`python --version`)
17
+ - Operating system
18
+ - A minimal sample sheet that reproduces the problem (redact any sensitive sample IDs)
19
+ - The exact command or code you ran
20
+
21
+ **Expected behavior**
22
+ What you expected to happen.
23
+
24
+ **Actual behavior**
25
+ What actually happened, including the full error message or traceback.
26
+
27
+ **Additional context**
28
+ Instrument/format involved, or anything else that might help.
@@ -0,0 +1,8 @@
1
+ blank_issues_enabled: true
2
+ contact_links:
3
+ - name: Documentation
4
+ url: https://samplesheet-parser.readthedocs.io
5
+ about: Usage guide and API reference.
6
+ - name: Question or usage help
7
+ url: https://github.com/chaitanyakasaraneni/samplesheet-parser/issues/new
8
+ about: Open an issue and label it as a question. The maintainer monitors issues.
@@ -0,0 +1,19 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea or improvement
4
+ title: ''
5
+ labels: enhancement
6
+ assignees: ''
7
+ ---
8
+
9
+ **Is your request related to a problem?**
10
+ A clear description of the problem or limitation you're running into.
11
+
12
+ **Describe the solution you'd like**
13
+ What you'd like to happen.
14
+
15
+ **Describe alternatives you've considered**
16
+ Any alternative approaches or workarounds.
17
+
18
+ **Additional context**
19
+ Instruments or formats involved, example sheets, or anything else relevant.
@@ -23,10 +23,10 @@ and writing Illumina SampleSheet.csv files. The codebase follows strict typing
23
23
  **Do not suggest `_validate_field` or defensive input validation on fields
24
24
  with naturally constrained input domains**, including:
25
25
 
26
- - `set_software_version(version)` — version strings like `"4.2.7"` do not
26
+ - `set_software_version(version)` - version strings like `"4.2.7"` do not
27
27
  contain commas by definition
28
- - `set_reads(read1, read2, index1, index2)` — integer parameters
29
- - `set_override_cycles(override)` — semicolon-delimited cycle strings where
28
+ - `set_reads(read1, read2, index1, index2)` - integer parameters
29
+ - `set_override_cycles(override)` - semicolon-delimited cycle strings where
30
30
  commas are not valid syntax anyway
31
31
  - Any integer, enum, or boolean parameter
32
32
 
@@ -49,5 +49,5 @@ or classes prefixed with `_`).
49
49
  - Line length: 88 (ruff default)
50
50
  - Type annotations: required on all public methods
51
51
  - Test naming: `test_<what>_<condition>_<expected>` pattern
52
- - No `assert` in production code — raise `ValueError` with a descriptive message
52
+ - No `assert` in production code - raise `ValueError` with a descriptive message
53
53
  - Method chaining: all configuration methods return `self`
@@ -0,0 +1,31 @@
1
+ name: Draft PDF
2
+
3
+ on:
4
+ push:
5
+ paths:
6
+ - paper.md
7
+ - paper.bib
8
+ - .github/workflows/draft-pdf.yml
9
+ workflow_dispatch:
10
+
11
+ jobs:
12
+ paper:
13
+ runs-on: ubuntu-latest
14
+ name: Build the JOSS paper draft
15
+ steps:
16
+ - name: Checkout
17
+ uses: actions/checkout@v4
18
+
19
+ - name: Build draft PDF
20
+ uses: openjournals/openjournals-draft-action@master
21
+ with:
22
+ journal: joss
23
+ # Path to the paper within the repository.
24
+ paper-path: paper.md
25
+
26
+ - name: Upload the compiled PDF
27
+ uses: actions/upload-artifact@v4
28
+ with:
29
+ name: paper
30
+ # openjournals/inara writes the compiled PDF next to paper.md.
31
+ path: paper.pdf
@@ -7,7 +7,7 @@ demo_output.txt
7
7
  eval/results/
8
8
  corpus/**
9
9
  images/gen_arch_excalidraw.py
10
- images/samplesheet_parser_arch_v2.3.excalidraw
10
+ images/samplesheet_parser_arch_latest.excalidraw
11
11
 
12
12
  # Cache and build artifacts
13
13
  __pycache__/
@@ -53,3 +53,7 @@ uv.lock
53
53
  *.tmp
54
54
 
55
55
  site/
56
+
57
+ # Demo script output (examples/demo_filter.py, demo_splitter.py)
58
+ examples/sample_sheets/filtered/
59
+ examples/sample_sheets/split/
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "title": "samplesheet-parser: A multi-vendor parser, validator, and converter for sequencing sample sheets",
3
- "description": "Dependency-free Python library and CLI for parsing, validating, converting, diffing, and merging sequencing sample sheets across vendors — Illumina IEM V1 (bcl2fastq), Illumina BCLConvert V2, and Element AVITI run manifests. Provides format auto-detection behind a shared interface, bidirectional V1/V2 conversion, structural and index-integrity validation, and instrument-aware optical color-balance checking.",
3
+ "description": "Dependency-free Python library and CLI for parsing, validating, converting, diffing, and merging sequencing sample sheets across vendors - Illumina IEM V1 (bcl2fastq), Illumina BCLConvert V2, and Element AVITI run manifests. Provides format auto-detection behind a shared interface, bidirectional V1/V2 conversion, structural and index-integrity validation, and instrument-aware optical color-balance checking.",
4
4
  "upload_type": "software",
5
5
  "access_right": "open",
6
6
  "license": "Apache-2.0",
7
- "version": "2.5.2",
7
+ "version": "2.6.0",
8
8
  "keywords": [
9
9
  "bioinformatics", "Illumina", "Element AVITI", "avidity", "SampleSheet",
10
10
  "BCLConvert", "color balance", "multi-vendor", "demultiplexing",
@@ -10,6 +10,49 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
10
10
 
11
11
  _No unreleased changes._
12
12
 
13
+ ## [2.6.0] - 2026-11-18
14
+
15
+ ### Added
16
+
17
+ - **Configurable validation strictness.** `SampleSheetValidator.validate()` now
18
+ accepts a `strictness` argument (`Strictness.LENIENT`, `.STANDARD`, or
19
+ `.STRICT`). `STANDARD` is the default and reproduces the previous behavior
20
+ exactly, so existing callers are unaffected. `LENIENT` relaxes the index and
21
+ color-balance thresholds; `STRICT` tightens them and additionally runs the
22
+ bundled Illumina v2 conformance and JSON Schema checks. The three overlapping
23
+ knobs (`min_hamming_distance`, `check_color_balance`, `color_balance_mode`)
24
+ default to the preset and can still be overridden per call.
25
+ - **Pluggable validators.** `validate()` accepts an `extra_validators` list of
26
+ callables, letting callers add project-specific checks to the chain without
27
+ subclassing. A `ValidatorError` type and the `Validator` protocol are exported
28
+ for building custom validators.
29
+ - **Bundled Illumina v2 JSON Schema and resolvable registry.** A full Draft
30
+ 2020-12 schema for BCLConvert v2 sheets ships in `samplesheet_parser.schema`
31
+ (`ILLUMINA_V2_SCHEMA`), together with `build_registry()` and the
32
+ `ILLUMINA_V2_URN` / `SAMSHEE_V2_URN` identifiers. The registry resolves the
33
+ `urn:samshee:illuminav2/v1` reference used by samshee, so schemas written for
34
+ samshee resolve against this package too. The `illumina_v2_conformance`,
35
+ `illumina_v2_schema_validator`, `json_schema_validator`, `sheet_to_dict`, and
36
+ `sheet_to_sections` helpers are exported.
37
+ - **CLI `--strictness` and `--schema` on `samplesheet validate`.**
38
+ `--strictness {lenient,standard,strict}` selects the preset; `--schema PATH`
39
+ validates the sheet against a caller-supplied JSON Schema. Text output now
40
+ prints the resolved mode and the effective index-distance and color-balance
41
+ settings; JSON output reports the strictness level and schema source. Exit
42
+ codes are unchanged.
43
+ - **Optional `jsonschema` dependency via the `[schema]` extra.** JSON Schema
44
+ validation requires `jsonschema>=4.18`, installed with
45
+ `pip install "samplesheet-parser[schema]"`. When it is absent, schema checks
46
+ degrade gracefully to a `SCHEMA_SKIPPED` note rather than failing, so the core
47
+ library stays dependency-free.
48
+
49
+ ### Documentation
50
+
51
+ - Expanded the validation guide and CLI reference to cover strictness levels,
52
+ JSON Schema validation, the samshee-compatible URN, and the `[schema]` extra.
53
+ - Refreshed the architecture diagram and added dark-mode variants of the README
54
+ and documentation homepage images.
55
+
13
56
  ## [2.5.2] - 2026-08-26
14
57
 
15
58
  ### Changed (behavioral)
@@ -224,21 +267,21 @@ _No unreleased changes._
224
267
 
225
268
  ### Added
226
269
 
227
- - **`SampleSheetParser` Protocol** (`samplesheet_parser.protocol`) — a
270
+ - **`SampleSheetParser` Protocol** (`samplesheet_parser.protocol`) - a
228
271
  `runtime_checkable` structural protocol satisfied by both `SampleSheetV1`
229
272
  and `SampleSheetV2`. Third-party parsers that implement the same interface
230
273
  can be registered with the factory without inheriting from any base class.
231
274
  `isinstance(sheet, SampleSheetParser)` works at runtime.
232
- - **`SampleSheetFactory.register(detector, parser_class, version)`** — class
275
+ - **`SampleSheetFactory.register(detector, parser_class, version)`** - class
233
276
  method that registers a custom format detector. Registered detectors are
234
277
  tried before the built-in V1/V2 detection in LIFO order. Useful for
235
278
  supporting hypothetical V3 formats or vendor-specific variants.
236
- - **`SampleSheetFactory.clear_registry()`** — removes all custom registrations.
279
+ - **`SampleSheetFactory.clear_registry()`** - removes all custom registrations.
237
280
  Intended for use in tests to prevent cross-test contamination.
238
- - **`detect_workflow()` accepts `extra_a` / `extra_b` keyword arguments** —
281
+ - **`detect_workflow()` accepts `extra_a` / `extra_b` keyword arguments** -
239
282
  caller-supplied `frozenset[str]` of instrument names checked before the
240
283
  built-in tables. Allows narrowing workflow classification without subclassing.
241
- - **`hamming_distance` is now a public export** — available as
284
+ - **`hamming_distance` is now a public export** - available as
242
285
  `from samplesheet_parser import hamming_distance` and documented in the API
243
286
  reference.
244
287
 
@@ -267,15 +310,15 @@ _No unreleased changes._
267
310
 
268
311
  ### Added
269
312
 
270
- - **`samplesheet_parser.instruments`** — public module exposing
313
+ - **`samplesheet_parser.instruments`** - public module exposing
271
314
  `Workflow` (StrEnum: `A` / `B`), `WORKFLOW_A_INSTRUMENTS` /
272
315
  `WORKFLOW_B_INSTRUMENTS` / `AMBIGUOUS_INSTRUMENTS` tables,
273
316
  `detect_workflow()`, `parse_workflow()`, and `reverse_complement()`.
274
- - **`SampleSheetConverter(path, *, workflow=...)`** — explicit workflow
317
+ - **`SampleSheetConverter(path, *, workflow=...)`** - explicit workflow
275
318
  override accepting `"a"`, `"b"`, or a `Workflow` enum value. Required for
276
319
  ambiguous instruments such as `NovaSeq 6000` (workflow depends on v1.0
277
320
  vs v1.5 chemistry).
278
- - **`samplesheet convert --workflow {a,b}` / `-w`** — CLI override that
321
+ - **`samplesheet convert --workflow {a,b}` / `-w`** - CLI override that
279
322
  takes precedence over auto-detection.
280
323
 
281
324
  [#30]: https://github.com/chaitanyakasaraneni/samplesheet-parser/issues/30
@@ -291,7 +334,7 @@ _No unreleased changes._
291
334
 
292
335
  ### Added
293
336
 
294
- - **`SampleSheetSplitter` and `SplitResult`** — splits a combined sheet into
337
+ - **`SampleSheetSplitter` and `SplitResult`** - splits a combined sheet into
295
338
  one file per project or per lane (the inverse of `SampleSheetMerger`).
296
339
  - `SampleSheetSplitter(path, *, by="project"|"lane", target_version=None, unassigned_label="unassigned")`
297
340
  - `split(output_dir, *, prefix="", suffix="_SampleSheet.csv", validate=True) → SplitResult`
@@ -303,11 +346,11 @@ _No unreleased changes._
303
346
  - `SampleSheetSplitter` and `SplitResult` are exported from the top-level
304
347
  package.
305
348
 
306
- - **`SampleSheetFilter` and `FilterResult`** — extracts a subset of samples
349
+ - **`SampleSheetFilter` and `FilterResult`** - extracts a subset of samples
307
350
  from a sheet by project, lane, or sample ID (with glob support).
308
351
  - `SampleSheetFilter(path, *, target_version=None)`
309
352
  - `filter(output_path, *, project=None, lane=None, sample_id=None, validate=True) → FilterResult`
310
- - Multiple criteria are ANDed — a sample must match all provided criteria.
353
+ - Multiple criteria are ANDed - a sample must match all provided criteria.
311
354
  - `sample_id` supports glob patterns (e.g. `"CTRL_*"`, `"SAMPLE_00[1-3]"`)
312
355
  via `fnmatch.fnmatchcase` for consistent case-sensitive behavior across
313
356
  platforms.
@@ -316,65 +359,65 @@ _No unreleased changes._
316
359
  - `SampleSheetFilter` and `FilterResult` are exported from the top-level
317
360
  package.
318
361
 
319
- - **`samplesheet split` CLI command** — splits a combined sheet into per-group
362
+ - **`samplesheet split` CLI command** - splits a combined sheet into per-group
320
363
  files. Accepts `--by project|lane`, `--output-dir / -d`, `--to v1|v2`,
321
364
  `--format json|text`, and `--prefix`. Exits 0 on clean split, 1 if warnings
322
365
  were produced, 2 on bad arguments or unreadable files.
323
366
 
324
- - **`samplesheet filter` CLI command** — filters samples by `--project / -p`,
367
+ - **`samplesheet filter` CLI command** - filters samples by `--project / -p`,
325
368
  `--lane / -l`, and `--sample-id / -s` (glob patterns supported). Accepts
326
369
  `--output / -o`, `--to v1|v2`, and `--format json|text`. Exits 0 when
327
370
  samples match, 1 when no samples match, 2 on bad arguments.
328
371
 
329
- - **`SampleSheetWriter.clear_samples()`** — public method to remove all samples
372
+ - **`SampleSheetWriter.clear_samples()`** - public method to remove all samples
330
373
  from a writer while preserving header, reads, and settings. Enables the
331
374
  copy-metadata-then-repopulate pattern without accessing the private
332
375
  `_samples` attribute.
333
376
 
334
- - **`--format json` for `samplesheet convert`** — the convert command now accepts
377
+ - **`--format json` for `samplesheet convert`** - the convert command now accepts
335
378
  `--format json` and emits a structured JSON object with `input`, `output`,
336
379
  `source_version`, and `target_version` keys. All seven CLI subcommands now
337
380
  support `--format json` uniformly.
338
381
 
339
- - **Bioconda recipe (`recipes/meta.yaml`)** — a `noarch: python` conda recipe
382
+ - **Bioconda recipe (`recipes/meta.yaml`)** - a `noarch: python` conda recipe
340
383
  with `loguru` as the only runtime dependency. Python version is not pinned
341
384
  (noarch packages rely on the conda solver for compatibility). The CLI extra
342
385
  (`typer`) is intentionally omitted from the base recipe so the conda package
343
386
  stays lightweight; users who need the `samplesheet` CLI can
344
387
  `conda install typer` alongside.
345
388
 
346
- - **nf-core compatible Nextflow modules** — three modules following
389
+ - **nf-core compatible Nextflow modules** - three modules following
347
390
  nf-core/modules conventions, each with `main.nf`, `meta.yml`,
348
391
  `environment.yml`, nf-test tests, and `tags.yml`:
349
- - `SAMPLESHEETPARSER_VALIDATE` — validates V1/V2 sheets and emits a
392
+ - `SAMPLESHEETPARSER_VALIDATE` - validates V1/V2 sheets and emits a
350
393
  structured JSON report; exits 1 on errors so pipelines fail before
351
394
  demultiplexing.
352
- - `SAMPLESHEETPARSER_CONVERT` — bidirectional V1↔V2 conversion with target
395
+ - `SAMPLESHEETPARSER_CONVERT` - bidirectional V1↔V2 conversion with target
353
396
  version passed as a channel value.
354
- - `SAMPLESHEETPARSER_INFO` — emits a JSON metadata summary (format, sample
397
+ - `SAMPLESHEETPARSER_INFO` - emits a JSON metadata summary (format, sample
355
398
  count, lanes, index type, read lengths, adapters) for run logging and
356
399
  conditional pipeline branching.
357
400
 
358
- - **Example scripts** — `examples/demo_splitter.py` and
401
+ - **Example scripts** - `examples/demo_splitter.py` and
359
402
  `examples/demo_filter.py` demonstrating the new split and filter APIs with
360
403
  three and four runnable scenarios respectively.
361
404
 
362
405
  ### Tests
363
406
 
364
- - **`tests/test_splitter.py`** — 46 tests covering: split by project and lane,
407
+ - **`tests/test_splitter.py`** - 46 tests covering: split by project and lane,
365
408
  header/reads/settings preservation, unassigned samples (custom label),
366
409
  incomplete records (missing `Sample_ID` or `Index`, all-incomplete group),
367
410
  empty input, target version override, custom prefix/suffix, output directory
368
411
  creation, `SplitResult` summary and `source_version`, and error conditions
369
412
  (`FileNotFoundError`, `ValueError` on invalid `--by`).
370
413
 
371
- - **`tests/test_filter.py`** — 46 tests covering: filter by project, lane
414
+ - **`tests/test_filter.py`** - 46 tests covering: filter by project, lane
372
415
  (string and int), and sample ID (exact and glob); multiple ANDed criteria;
373
416
  no-match behaviour (no file written, `matched_count == 0`); header/settings
374
417
  preservation; target version override; `FilterResult` attributes; incomplete
375
418
  records; and error conditions (`ValueError`, `FileNotFoundError`).
376
419
 
377
- - **`TestCLISplit` and `TestCLIFilter`** in `tests/test_cli.py` — 13 tests each
420
+ - **`TestCLISplit` and `TestCLIFilter`** in `tests/test_cli.py` - 13 tests each
378
421
  covering happy paths, JSON output, warning exit codes, error exit codes,
379
422
  exception paths (via `monkeypatch`), and text output formatting.
380
423
 
@@ -388,24 +431,24 @@ _No unreleased changes._
388
431
 
389
432
  ### Added
390
433
 
391
- - **`--version` / `-V` CLI flag** — prints the installed package version
434
+ - **`--version` / `-V` CLI flag** - prints the installed package version
392
435
  and exits. Reads the version via `importlib.metadata` so the full package
393
436
  is not loaded just to print a version string.
394
437
 
395
- - **`demo_converter.py`** — runnable example covering V1→V2 conversion,
438
+ - **`demo_converter.py`** - runnable example covering V1→V2 conversion,
396
439
  V2→V1 (lossy) conversion, and a full V1→V2→V1 roundtrip with sample
397
440
  identity verification.
398
441
 
399
- - **`demo_diff.py`** — runnable example covering five diff scenarios:
442
+ - **`demo_diff.py`** - runnable example covering five diff scenarios:
400
443
  identical sheets, header change, sample added, index correction, and
401
444
  cross-format (V1 vs its V2 conversion) diff.
402
445
 
403
- - **`demo_writer.py`** — runnable example covering the fluent
446
+ - **`demo_writer.py`** - runnable example covering the fluent
404
447
  `SampleSheetWriter` API: building V1 and V2 sheets from scratch,
405
448
  correcting a sample index on an existing sheet, and removing a sample
406
449
  before submission.
407
450
 
408
- - **`demo_index_utils.py`** — runnable example covering
451
+ - **`demo_index_utils.py`** - runnable example covering
409
452
  `normalize_index_lengths` with trim and pad strategies, dual-index
410
453
  normalization, and a real-sheet walkthrough.
411
454
 
@@ -418,12 +461,12 @@ _No unreleased changes._
418
461
 
419
462
  - `cli.py` fallback type aliases (`_FormatOption`, `_OutputOption`,
420
463
  `_VersionOption`) reduced from `type: ignore[assignment,misc]` to
421
- `type: ignore[misc]` — the `assignment` suppression was unused under
464
+ `type: ignore[misc]` - the `assignment` suppression was unused under
422
465
  current mypy.
423
466
 
424
467
  ### Tests
425
468
 
426
- - `TestCLIVersion` — four new tests covering `--version` exit code, `-V`
469
+ - `TestCLIVersion` - four new tests covering `--version` exit code, `-V`
427
470
  short flag, package name in output, version string in output, and
428
471
  `PackageNotFoundError` fallback to `"unknown"`.
429
472
 
@@ -436,15 +479,15 @@ _No unreleased changes._
436
479
 
437
480
  ### Added
438
481
 
439
- - **`py.typed` marker** — package now ships inline type information per
482
+ - **`py.typed` marker** - package now ships inline type information per
440
483
  PEP 561, enabling mypy and pyright to type-check downstream code without
441
484
  extra configuration.
442
485
 
443
- - **`InstrumentPlatform` and `UMILocation` enums exported** — both were
486
+ - **`InstrumentPlatform` and `UMILocation` enums exported** - both were
444
487
  already defined in `enums.py` but not part of the public API. They are now
445
488
  importable directly from the top-level package and listed in `__all__`.
446
489
 
447
- - **`.pre-commit-config.yaml`** — pre-commit hook configuration included in
490
+ - **`.pre-commit-config.yaml`** - pre-commit hook configuration included in
448
491
  the repository (black, ruff with `--fix`, mypy, and standard file hygiene
449
492
  hooks) so contributors get the same checks locally that CI enforces.
450
493
 
@@ -470,7 +513,7 @@ _No unreleased changes._
470
513
  `samplesheet_parser/__init__.py`, where the version-detection block
471
514
  intentionally precedes the package re-exports.
472
515
 
473
- - **Stability guarantee** — `1.0.0` marks the first stable release.
516
+ - **Stability guarantee** - `1.0.0` marks the first stable release.
474
517
  The public API (all names in `__init__.__all__`) is now subject to
475
518
  semantic versioning: breaking changes will not be made without a major
476
519
  version bump.
@@ -481,12 +524,12 @@ _No unreleased changes._
481
524
 
482
525
  ### Added
483
526
 
484
- - **`samplesheet info` CLI command** — prints a concise summary of any V1 or
527
+ - **`samplesheet info` CLI command** - prints a concise summary of any V1 or
485
528
  V2 sample sheet (format, sample count, lanes, index type, read lengths,
486
529
  adapters, experiment name, instrument). Supports `--format json` for
487
530
  machine-readable output; exits 0 on success, 2 on unreadable files.
488
531
 
489
- - **Configurable Hamming distance threshold** — `SampleSheetValidator.validate()`
532
+ - **Configurable Hamming distance threshold** - `SampleSheetValidator.validate()`
490
533
  now accepts a `min_hamming_distance` keyword argument (default: 3) so labs
491
534
  using longer indexes can enforce stricter thresholds without changing the
492
535
  module-level constant.
@@ -497,17 +540,17 @@ _No unreleased changes._
497
540
  invalid input). The JSON output includes `min_hamming_distance` for
498
541
  auditability.
499
542
 
500
- - **`normalize_index_lengths()` utility** — normalizes index sequence lengths
543
+ - **`normalize_index_lengths()` utility** - normalizes index sequence lengths
501
544
  across a list of sample dicts (output of `sheet.samples()`) to a consistent
502
545
  length before merging sheets with mixed-length indexes.
503
- - `strategy="trim"` — trims all indexes to the shortest sequence length.
504
- - `strategy="pad"` — pads shorter indexes to the longest length using `"N"`
546
+ - `strategy="trim"` - trims all indexes to the shortest sequence length.
547
+ - `strategy="pad"` - pads shorter indexes to the longest length using `"N"`
505
548
  wildcard characters (supported by BCLConvert ≥ 3.9 and bcl2fastq ≥ 2.20).
506
549
  - Auto-detects V1-style (`index`/`index2`) and V2-style (`Index`/`Index2`)
507
550
  field names; explicit `index1_key`/`index2_key` overrides supported.
508
551
  - Exported from the top-level package as `normalize_index_lengths`.
509
552
 
510
- - **CI / pre-commit integration guide** in README — GitHub Actions workflow
553
+ - **CI / pre-commit integration guide** in README - GitHub Actions workflow
511
554
  and pre-commit hook configuration for automatic sample sheet validation on
512
555
  every commit or pull request that touches a `SampleSheet.csv`.
513
556
 
@@ -543,59 +586,59 @@ _No unreleased changes._
543
586
 
544
587
  ### Fixed
545
588
 
546
- - **`SampleSheetMerger`** — `INDEX_DISTANCE_TOO_LOW` and `DUPLICATE_INDEX`
589
+ - **`SampleSheetMerger`** - `INDEX_DISTANCE_TOO_LOW` and `DUPLICATE_INDEX`
547
590
  were reported twice in `--force` merges (once by the pre-merge cross-sheet
548
591
  check, once by the post-merge validator). Duplicate codes are now suppressed
549
- in `_validate_merged` — the more descriptive pre-merge message is always
592
+ in `_validate_merged` - the more descriptive pre-merge message is always
550
593
  preferred.
551
594
 
552
595
  ## [0.3.0] - 2026-03-10
553
596
 
554
597
  ### Added
555
598
 
556
- - **`SampleSheetMerger`** — combines multiple per-project sample sheets into a
599
+ - **`SampleSheetMerger`** - combines multiple per-project sample sheets into a
557
600
  single sheet for a flow cell run.
558
- - `add(path)` — register an input sheet (V1 or V2); mixed formats are
601
+ - `add(path)` - register an input sheet (V1 or V2); mixed formats are
559
602
  auto-converted to the target version before merging.
560
- - `merge(output_path, validate=True, abort_on_conflicts=True)` — merges all
603
+ - `merge(output_path, validate=True, abort_on_conflicts=True)` - merges all
561
604
  registered sheets, writes the combined output, and returns a `MergeResult`.
562
- - **Index collision detection** — raises a conflict when two samples share
605
+ - **Index collision detection** - raises a conflict when two samples share
563
606
  the same lane and index sequence across project boundaries.
564
- - **Hamming distance check** — warns when the combined I7+I5 distance between
607
+ - **Hamming distance check** - warns when the combined I7+I5 distance between
565
608
  any two samples across sheets falls below 3.
566
- - **Read-length conflict detection** — raises a conflict when registered
609
+ - **Read-length conflict detection** - raises a conflict when registered
567
610
  sheets specify incompatible `Read1Cycles`/`Read2Cycles` (V2) or `[Reads]`
568
611
  lengths (V1).
569
- - **Adapter conflict detection** — warns when adapter sequences differ across
612
+ - **Adapter conflict detection** - warns when adapter sequences differ across
570
613
  sheets.
571
- - **Mixed-format warning** — emits a warning when V1 and V2 sheets are
614
+ - **Mixed-format warning** - emits a warning when V1 and V2 sheets are
572
615
  combined, with the auto-conversion strategy logged.
573
- - `MergeResult` dataclass — exposes `conflicts`, `warnings`, `sample_count`,
616
+ - `MergeResult` dataclass - exposes `conflicts`, `warnings`, `sample_count`,
574
617
  `source_versions`, `output_path`, `has_conflicts`, and `summary()`;
575
618
  consistent with `ValidationResult` and `DiffResult`.
576
- - `abort_on_conflicts=True` (default) — skips writing the output file when
619
+ - `abort_on_conflicts=True` (default) - skips writing the output file when
577
620
  any conflict is present; set `False` (via `--force` in the CLI) to write
578
621
  despite conflicts.
579
622
  - `SampleSheetMerger` and `MergeResult` are exported from the top-level
580
623
  package.
581
624
 
582
- - **`samplesheet` CLI** — command-line interface exposing the four core
625
+ - **`samplesheet` CLI** - command-line interface exposing the four core
583
626
  operations, available as an optional extra (`pip install
584
627
  "samplesheet-parser[cli]"`; adds `typer` as a dependency).
585
- - `samplesheet validate <file>` — exits 0 if clean, 1 if errors, 2 on
628
+ - `samplesheet validate <file>` - exits 0 if clean, 1 if errors, 2 on
586
629
  usage/parse errors. Supports `--format json` for machine-readable output.
587
- - `samplesheet convert <file> --to <v1|v2> --output <path>` — converts
630
+ - `samplesheet convert <file> --to <v1|v2> --output <path>` - converts
588
631
  between formats; exits 0 on success, 1 on conversion error, 2 on bad
589
632
  arguments.
590
- - `samplesheet diff <old> <new>` — exits 0 if identical, 1 if differences
633
+ - `samplesheet diff <old> <new>` - exits 0 if identical, 1 if differences
591
634
  detected (useful in CI pre-run checks). Supports `--format json`.
592
- - `samplesheet merge <files...> --output <path>` — merges two or more sheets;
635
+ - `samplesheet merge <files...> --output <path>` - merges two or more sheets;
593
636
  exits 0 on clean merge, 1 on conflicts or warnings, 2 on bad arguments.
594
637
  Supports `--force`, `--to <v1|v2>`, and `--format json`.
595
638
  - All commands print errors to stderr and structured data to stdout.
596
639
  - Entry point configured in `pyproject.toml`:
597
640
  `samplesheet = "samplesheet_parser.cli:main"`.
598
- - Module imports cleanly without `typer` installed — missing-extra error is
641
+ - Module imports cleanly without `typer` installed - missing-extra error is
599
642
  surfaced only at invocation time.
600
643
 
601
644
  ### Changed
@@ -611,19 +654,19 @@ _No unreleased changes._
611
654
 
612
655
  ### Added
613
656
 
614
- - **`SampleSheetWriter`** — programmatic creation and editing of IEM V1 and
657
+ - **`SampleSheetWriter`** - programmatic creation and editing of IEM V1 and
615
658
  BCLConvert V2 sample sheets.
616
659
  - Build sheets from scratch with a fluent API: `set_header()`, `set_reads()`,
617
660
  `set_adapter()`, `set_override_cycles()`, `set_software_version()`,
618
661
  `set_setting()`, `add_sample()`.
619
- - `from_sheet(sheet, version=)` class method — load any parsed V1/V2 sheet,
662
+ - `from_sheet(sheet, version=)` class method - load any parsed V1/V2 sheet,
620
663
  edit in place, and write back; pass a different `version` to convert format
621
664
  while editing.
622
665
  - `remove_sample(sample_id, lane=)` and `update_sample(sample_id, **fields)`
623
666
  for surgical edits to existing sheets.
624
- - `write(path, validate=True)` — runs `SampleSheetValidator` before writing
667
+ - `write(path, validate=True)` - runs `SampleSheetValidator` before writing
625
668
  by default; raises `ValueError` with the full error list if validation fails.
626
- - `to_string()` — serialise to a string without writing to disk (useful for
669
+ - `to_string()` - serialise to a string without writing to disk (useful for
627
670
  testing and inspection).
628
671
  - CSV safety: `_validate_field` rejects commas, newlines, and quotes in all
629
672
  free-text inputs (`sample_id`, `index`, `project`, `run_name`, adapter
@@ -631,7 +674,7 @@ _No unreleased changes._
631
674
  error message.
632
675
  - `SampleSheetWriter` is now exported from the top-level package.
633
676
 
634
- - **`SampleSheetDiff`** — structured comparison of two sample sheets across
677
+ - **`SampleSheetDiff`** - structured comparison of two sample sheets across
635
678
  any combination of V1 and V2 formats.
636
679
  - Compares header, reads, settings, and samples in a single `compare()` call.
637
680
  - Returns a `DiffResult` dataclass with `header_changes`, `samples_added`,
@@ -641,23 +684,23 @@ _No unreleased changes._
641
684
  format-noise diffs.
642
685
  - `DiffResult.summary()` and `DiffResult.has_changes` for quick inspection.
643
686
 
644
- - **`INDEX_DISTANCE_TOO_LOW` validation check** — `SampleSheetValidator` now
687
+ - **`INDEX_DISTANCE_TOO_LOW` validation check** - `SampleSheetValidator` now
645
688
  computes the Hamming distance between every pair of index sequences within
646
689
  each lane and warns when the distance falls below the recommended minimum
647
690
  of 3. For dual-index sheets the combined I7+I5 sequence is used so that
648
691
  pairs well-separated on I5 are not incorrectly flagged.
649
692
 
650
- - **`_hamming_distance` helper** — module-level pure function, independently
693
+ - **`_hamming_distance` helper** - module-level pure function, independently
651
694
  testable, handles sequences of unequal length by comparing up to the shorter
652
695
  sequence length.
653
696
 
654
- - **`scripts/demo_writer.py`** — smoke-test script demonstrating V1/V2
697
+ - **`scripts/demo_writer.py`** - smoke-test script demonstrating V1/V2
655
698
  from-scratch creation and round-trip editing.
656
699
 
657
- - **`scripts/demo_diff.py`** — smoke-test script demonstrating identical,
700
+ - **`scripts/demo_diff.py`** - smoke-test script demonstrating identical,
658
701
  modified, and cross-format diff scenarios.
659
702
 
660
- - **`.github/copilot-instructions.md`** — Copilot review instructions scoping
703
+ - **`.github/copilot-instructions.md`** - Copilot review instructions scoping
661
704
  suggestions to logic bugs, test coverage gaps, and type errors.
662
705
 
663
706
  ### Changed
@@ -671,27 +714,27 @@ _No unreleased changes._
671
714
 
672
715
  ### Added
673
716
 
674
- - **`SampleSheetConverter`** — bidirectional V1 ↔ V2 format conversion.
675
- - `to_v2(output_path)` — converts IEM V1 to BCLConvert V2.
676
- - `to_v1(output_path)` — converts BCLConvert V2 to IEM V1 (lossy; V2-only
717
+ - **`SampleSheetConverter`** - bidirectional V1 ↔ V2 format conversion.
718
+ - `to_v2(output_path)` - converts IEM V1 to BCLConvert V2.
719
+ - `to_v1(output_path)` - converts BCLConvert V2 to IEM V1 (lossy; V2-only
677
720
  fields dropped with a warning).
678
721
  - Auto-detects source format via `SampleSheetFactory`.
679
722
 
680
- - **`scripts/demo_converter.py`** — smoke-test script for converter scenarios
723
+ - **`scripts/demo_converter.py`** - smoke-test script for converter scenarios
681
724
  including V1→V2→V1 and V2→V1→V2 round-trips.
682
725
 
683
- - **`CONTRIBUTING.md`** — local development setup, test instructions, and
726
+ - **`CONTRIBUTING.md`** - local development setup, test instructions, and
684
727
  PR checklist.
685
728
 
686
729
  ---
687
730
 
688
- ## [0.1.1] – [0.1.4] - 2026-02-22 / 2026-02-23
731
+ ## [0.1.1] - [0.1.4] - 2026-02-22 / 2026-02-23
689
732
 
690
733
  ### Fixed
691
734
 
692
- - CI workflow not triggering on tag push — added `tags` trigger to
735
+ - CI workflow not triggering on tag push - added `tags` trigger to
693
736
  `ci.yml` (was gated on tags but never configured to *run* on them).
694
- - PyPI README image not rendering — switched from `badge.fury.io` to
737
+ - PyPI README image not rendering - switched from `badge.fury.io` to
695
738
  `shields.io` dynamic badge; bumped versions to force PyPI to re-render
696
739
  the README on each new release.
697
740
  - Minor ruff and mypy fixes surfaced during initial CI runs.
@@ -705,21 +748,21 @@ _No unreleased changes._
705
748
 
706
749
  ### Added
707
750
 
708
- - **`SampleSheetV1`** — parser for IEM V1 (bcl2fastq-era) sample sheets.
751
+ - **`SampleSheetV1`** - parser for IEM V1 (bcl2fastq-era) sample sheets.
709
752
  Parses `[Header]`, `[Reads]`, `[Settings]`, `[Manifests]`, and `[Data]`
710
753
  sections. Exposes `samples()`, `index_type()`, `adapters`, `read_lengths`,
711
754
  and all standard header fields.
712
755
 
713
- - **`SampleSheetV2`** — parser for BCLConvert V2 (NovaSeq X series) sample
756
+ - **`SampleSheetV2`** - parser for BCLConvert V2 (NovaSeq X series) sample
714
757
  sheets. Parses `[Header]`, `[Reads]`, `[BCLConvert_Settings]`,
715
758
  `[BCLConvert_Data]`, and optional `[Cloud_Data]` sections. Adds
716
759
  `get_umi_length()` and `get_read_structure()` for `OverrideCycles` decoding.
717
760
 
718
- - **`SampleSheetFactory`** — auto-detects V1 vs V2 format using a three-step
761
+ - **`SampleSheetFactory`** - auto-detects V1 vs V2 format using a three-step
719
762
  strategy (header key scan → section name scan → V1 fallback) and returns
720
763
  the appropriate parser.
721
764
 
722
- - **`SampleSheetValidator`** — validates parsed sheets for `EMPTY_SAMPLES`,
765
+ - **`SampleSheetValidator`** - validates parsed sheets for `EMPTY_SAMPLES`,
723
766
  `INVALID_INDEX_CHARS`, `INDEX_TOO_SHORT`, `INDEX_TOO_LONG`,
724
767
  `DUPLICATE_INDEX`, `MISSING_INDEX2`, `DUPLICATE_SAMPLE_ID`, `NO_ADAPTERS`,
725
768
  and `ADAPTER_MISMATCH`. Returns a structured `ValidationResult`.