samplesheet-parser 2.5.1__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.1 → 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.1 → samplesheet_parser-2.6.0}/.gitignore +5 -1
  7. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/.zenodo.json +2 -2
  8. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/CHANGELOG.md +135 -81
  9. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/CITATION.cff +2 -2
  10. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/CONTRIBUTING.md +6 -6
  11. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/Makefile +4 -4
  12. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/PKG-INFO +43 -37
  13. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/README.md +38 -35
  14. samplesheet_parser-2.6.0/SECURITY.md +23 -0
  15. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/api.md +13 -13
  16. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/cli.md +19 -12
  17. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/examples.md +12 -12
  18. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/conversion.md +4 -4
  19. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/diffing.md +2 -2
  20. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/filtering.md +9 -9
  21. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/merging.md +6 -6
  22. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/parsing.md +32 -9
  23. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/quickstart.md +3 -3
  24. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/splitting.md +7 -7
  25. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/validation.md +105 -7
  26. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/writing.md +2 -2
  27. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/index.md +9 -6
  28. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/installation.md +1 -1
  29. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/eval/FINDINGS.md +15 -15
  30. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/eval/README.md +7 -7
  31. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/eval/run_eval.py +4 -4
  32. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_converter.py +6 -6
  33. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_diff.py +11 -9
  34. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_filter.py +8 -8
  35. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_index_utils.py +13 -13
  36. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_merger.py +12 -12
  37. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_splitter.py +7 -7
  38. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_writer.py +8 -8
  39. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/parse_examples.py +20 -20
  40. {samplesheet_parser-2.5.1 → 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.1 → samplesheet_parser-2.6.0}/mkdocs.yml +1 -1
  44. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/convert/meta.yml +1 -1
  45. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/meta.yml +1 -1
  46. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/meta.yml +1 -1
  47. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/merge/meta.yml +1 -1
  48. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/split/meta.yml +1 -1
  49. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/meta.yml +1 -1
  50. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/paper.bib +3 -5
  51. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/paper.md +68 -36
  52. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/pyproject.toml +4 -2
  53. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/__init__.py +49 -21
  54. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/cli.py +109 -27
  55. {samplesheet_parser-2.5.1 → 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.1 → samplesheet_parser-2.6.0}/samplesheet_parser/validators.py +410 -25
  58. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/scripts/demo_converter.py +12 -11
  59. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/scripts/demo_diff.py +25 -29
  60. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/scripts/demo_writer.py +37 -47
  61. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_cli.py +199 -4
  62. {samplesheet_parser-2.5.1 → 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.1 → samplesheet_parser-2.6.0}/tests/test_validators/test_validators.py +30 -0
  65. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/.github/workflows/ci.yml +0 -0
  66. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/.pre-commit-config.yaml +0 -0
  67. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/.readthedocs.yaml +0 -0
  68. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/CODE_OF_CONDUCT.md +0 -0
  69. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/LICENSE +0 -0
  70. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/changelog.md +0 -0
  71. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/ci.md +0 -0
  72. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/contributing.md +0 -0
  73. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/guide/index_utils.md +0 -0
  74. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/docs/requirements.txt +0 -0
  75. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/eval/__init__.py +0 -0
  76. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/eval/generate_corpus.py +0 -0
  77. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/eval/reference_rules.py +0 -0
  78. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_color_balance.py +0 -0
  79. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/demo_element_aviti.py +0 -0
  80. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/ProjectAlpha_SampleSheet.csv +0 -0
  81. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/ProjectBeta_SampleSheet.csv +0 -0
  82. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/ProjectDelta_SampleSheet_collision.csv +0 -0
  83. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/ProjectGamma_SampleSheet.csv +0 -0
  84. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/combined_clean.csv +0 -0
  85. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/combined_collision_forced.csv +0 -0
  86. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/combined_mixed_formats.csv +0 -0
  87. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/element_aviti_RunManifest.csv +0 -0
  88. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_dual_index.csv +0 -0
  89. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_multi_lane.csv +0 -0
  90. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_single_index.csv +0 -0
  91. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_with_lab_qc_settings.csv +0 -0
  92. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v1_with_manifests.csv +0 -0
  93. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_nextseq_single_index.csv +0 -0
  94. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_novaseq_x_dual_index.csv +0 -0
  95. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_with_cloud_settings.csv +0 -0
  96. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_with_index_umi.csv +0 -0
  97. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_with_pipeline_settings.csv +0 -0
  98. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/examples/sample_sheets/v2_with_read_umi.csv +0 -0
  99. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/images/samplesheet_parser_arch_v03.png +0 -0
  100. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/images/samplesheet_parser_arch_v2.3.png +0 -0
  101. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/images/samplesheet_parser_overview.png +0 -0
  102. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/convert/environment.yml +0 -0
  103. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/convert/main.nf +0 -0
  104. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/convert/tests/main.nf.test +0 -0
  105. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/environment.yml +0 -0
  106. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/main.nf +0 -0
  107. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/tests/main.nf.test +0 -0
  108. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/diff/tests/main.nf.test.snap +0 -0
  109. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/environment.yml +0 -0
  110. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/main.nf +0 -0
  111. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/tests/main.nf.test +0 -0
  112. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/filter/tests/nextflow.config +0 -0
  113. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/environment.yml +0 -0
  114. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/main.nf +0 -0
  115. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/meta.yml +0 -0
  116. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/tests/main.nf.test +0 -0
  117. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/info/tests/main.nf.test.snap +0 -0
  118. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/merge/environment.yml +0 -0
  119. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/merge/main.nf +0 -0
  120. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/merge/tests/main.nf.test +0 -0
  121. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/split/environment.yml +0 -0
  122. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/split/main.nf +0 -0
  123. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/split/tests/main.nf.test +0 -0
  124. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/environment.yml +0 -0
  125. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/main.nf +0 -0
  126. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/tests/main.nf.test +0 -0
  127. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/modules/nf-core/samplesheetparser/validate/tests/main.nf.test.snap +0 -0
  128. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/chemistry.py +0 -0
  129. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/converter.py +0 -0
  130. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/diff.py +0 -0
  131. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/enums.py +0 -0
  132. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/filter.py +0 -0
  133. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/index_utils.py +0 -0
  134. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/instruments.py +0 -0
  135. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/merger.py +0 -0
  136. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/parsers/__init__.py +0 -0
  137. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/parsers/element.py +0 -0
  138. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/parsers/v1.py +0 -0
  139. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/parsers/v2.py +0 -0
  140. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/protocol.py +0 -0
  141. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/py.typed +0 -0
  142. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/splitter.py +0 -0
  143. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/samplesheet_parser/writer.py +0 -0
  144. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/__init__.py +0 -0
  145. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/conftest.py +0 -0
  146. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/fixtures/SampleSheet_v1_dual_index.csv +0 -0
  147. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/fixtures/SampleSheet_v2_dual_index.csv +0 -0
  148. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/fixtures/SampleSheet_v2_modified.csv +0 -0
  149. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_chemistry.py +0 -0
  150. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_converter.py +0 -0
  151. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_diff.py +0 -0
  152. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_eval.py +0 -0
  153. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_factory.py +0 -0
  154. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_filter.py +0 -0
  155. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_index_utils.py +0 -0
  156. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_instruments.py +0 -0
  157. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_merger.py +0 -0
  158. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_parsers/__init__.py +0 -0
  159. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_parsers/test_element.py +0 -0
  160. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_parsers/test_v1.py +0 -0
  161. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_reference_rules.py +0 -0
  162. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_splitter.py +0 -0
  163. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_validators/__init__.py +0 -0
  164. {samplesheet_parser-2.5.1 → samplesheet_parser-2.6.0}/tests/test_validators/test_hamming.py +0 -0
  165. {samplesheet_parser-2.5.1 → 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.1",
7
+ "version": "2.6.0",
8
8
  "keywords": [
9
9
  "bioinformatics", "Illumina", "Element AVITI", "avidity", "SampleSheet",
10
10
  "BCLConvert", "color balance", "multi-vendor", "demultiplexing",