sirnaforge 0.2.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 (97) hide show
  1. sirnaforge-0.2.0/.gitignore +93 -0
  2. sirnaforge-0.2.0/.pre-commit-config.yaml +47 -0
  3. sirnaforge-0.2.0/CHANGELOG.md +151 -0
  4. sirnaforge-0.2.0/CONTRIBUTING.md +210 -0
  5. sirnaforge-0.2.0/LICENSE +21 -0
  6. sirnaforge-0.2.0/Makefile +439 -0
  7. sirnaforge-0.2.0/PKG-INFO +938 -0
  8. sirnaforge-0.2.0/README.md +878 -0
  9. sirnaforge-0.2.0/data/mirna_databases/combined_human_mirnas.fa +0 -0
  10. sirnaforge-0.2.0/data/mirna_databases/mirgenedb_human.fa +0 -0
  11. sirnaforge-0.2.0/data/mirna_databases/mirna_seed_regions.fa +0 -0
  12. sirnaforge-0.2.0/docker/DOCKER_SUMMARY.md +210 -0
  13. sirnaforge-0.2.0/docker/Dockerfile +125 -0
  14. sirnaforge-0.2.0/docker/entrypoint.sh +88 -0
  15. sirnaforge-0.2.0/docker/environment-nextflow.yml +35 -0
  16. sirnaforge-0.2.0/environment-dev.yml +82 -0
  17. sirnaforge-0.2.0/examples/complete_workflow_example.py +165 -0
  18. sirnaforge-0.2.0/examples/gene_search_example.py +51 -0
  19. sirnaforge-0.2.0/examples/local_docker_test_example.py +74 -0
  20. sirnaforge-0.2.0/examples/sample_transcripts.fasta +8 -0
  21. sirnaforge-0.2.0/examples/workflow_output/orf_reports/TP53_orf_validation.txt +242 -0
  22. sirnaforge-0.2.0/examples/workflow_output/transcripts/TP53_canonical.fasta +2 -0
  23. sirnaforge-0.2.0/examples/workflow_output/transcripts/TP53_transcripts.fasta +1058 -0
  24. sirnaforge-0.2.0/examples/workflow_output/transcripts/temp_for_design.fasta +1058 -0
  25. sirnaforge-0.2.0/nextflow_pipeline/INTEGRATION_GUIDE.md +148 -0
  26. sirnaforge-0.2.0/nextflow_pipeline/README.md +269 -0
  27. sirnaforge-0.2.0/nextflow_pipeline/candidates.fasta +5994 -0
  28. sirnaforge-0.2.0/nextflow_pipeline/genomes.yaml +28 -0
  29. sirnaforge-0.2.0/nextflow_pipeline/main.nf +134 -0
  30. sirnaforge-0.2.0/nextflow_pipeline/modules/local/aggregate_results.nf +174 -0
  31. sirnaforge-0.2.0/nextflow_pipeline/modules/local/build_bowtie_index.nf +58 -0
  32. sirnaforge-0.2.0/nextflow_pipeline/modules/local/build_bwa_index.nf +57 -0
  33. sirnaforge-0.2.0/nextflow_pipeline/modules/local/environment.yml +11 -0
  34. sirnaforge-0.2.0/nextflow_pipeline/modules/local/mirna_offtarget_analysis.nf +67 -0
  35. sirnaforge-0.2.0/nextflow_pipeline/modules/local/offtarget_analysis.nf +79 -0
  36. sirnaforge-0.2.0/nextflow_pipeline/modules/local/prepare_candidates.nf +65 -0
  37. sirnaforge-0.2.0/nextflow_pipeline/modules/local/resolve_indices.nf +65 -0
  38. sirnaforge-0.2.0/nextflow_pipeline/modules/local/sirnaforge_analysis.nf +0 -0
  39. sirnaforge-0.2.0/nextflow_pipeline/modules/local/split_candidates.nf +67 -0
  40. sirnaforge-0.2.0/nextflow_pipeline/modules/local/transcriptome_offtarget_analysis.nf +67 -0
  41. sirnaforge-0.2.0/nextflow_pipeline/nextflow.config +218 -0
  42. sirnaforge-0.2.0/nextflow_pipeline/subworkflows/local/sirna_offtarget_analysis.nf +147 -0
  43. sirnaforge-0.2.0/pyproject.toml +314 -0
  44. sirnaforge-0.2.0/scripts/download_mirna_databases.py +205 -0
  45. sirnaforge-0.2.0/scripts/generate_realistic_toy_mirna.py +124 -0
  46. sirnaforge-0.2.0/scripts/generate_test_data.sh +86 -0
  47. sirnaforge-0.2.0/scripts/generate_toy_mirna_db.py +132 -0
  48. sirnaforge-0.2.0/scripts/generate_toy_transcriptome.py +241 -0
  49. sirnaforge-0.2.0/scripts/test_docker_categories.sh +44 -0
  50. sirnaforge-0.2.0/scripts/test_nextflow_integration.sh +58 -0
  51. sirnaforge-0.2.0/scripts/validate_fast_ci.py +144 -0
  52. sirnaforge-0.2.0/setup-conda-env.sh +155 -0
  53. sirnaforge-0.2.0/src/sirnaforge/__init__.py +77 -0
  54. sirnaforge-0.2.0/src/sirnaforge/cli.py +837 -0
  55. sirnaforge-0.2.0/src/sirnaforge/core/__init__.py +1 -0
  56. sirnaforge-0.2.0/src/sirnaforge/core/design.py +470 -0
  57. sirnaforge-0.2.0/src/sirnaforge/core/off_target.py +713 -0
  58. sirnaforge-0.2.0/src/sirnaforge/core/thermodynamics.py +188 -0
  59. sirnaforge-0.2.0/src/sirnaforge/data/__init__.py +21 -0
  60. sirnaforge-0.2.0/src/sirnaforge/data/base.py +901 -0
  61. sirnaforge-0.2.0/src/sirnaforge/data/gene_search.py +254 -0
  62. sirnaforge-0.2.0/src/sirnaforge/data/mirna_manager.py +634 -0
  63. sirnaforge-0.2.0/src/sirnaforge/data/orf_analysis.py +448 -0
  64. sirnaforge-0.2.0/src/sirnaforge/models/__init__.py +19 -0
  65. sirnaforge-0.2.0/src/sirnaforge/models/schemas.py +280 -0
  66. sirnaforge-0.2.0/src/sirnaforge/models/sirna.py +337 -0
  67. sirnaforge-0.2.0/src/sirnaforge/pipeline/__init__.py +17 -0
  68. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/__init__.py +6 -0
  69. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/config.py +487 -0
  70. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/runner.py +462 -0
  71. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/main.nf +134 -0
  72. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/aggregate_results.nf +99 -0
  73. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/build_bowtie_index.nf +58 -0
  74. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/build_bwa_index.nf +57 -0
  75. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/environment.yml +11 -0
  76. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/offtarget_analysis.nf +73 -0
  77. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/prepare_candidates.nf +65 -0
  78. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/resolve_indices.nf +65 -0
  79. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/sirnaforge_analysis.nf +0 -0
  80. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/modules/local/split_candidates.nf +67 -0
  81. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/nextflow.config +218 -0
  82. sirnaforge-0.2.0/src/sirnaforge/pipeline/nextflow/workflows/subworkflows/local/sirna_offtarget_analysis.nf +147 -0
  83. sirnaforge-0.2.0/src/sirnaforge/pipeline/resources/__init__.py +5 -0
  84. sirnaforge-0.2.0/src/sirnaforge/pipeline/resources/genomes.yaml +28 -0
  85. sirnaforge-0.2.0/src/sirnaforge/pipeline/resources/resources.py +177 -0
  86. sirnaforge-0.2.0/src/sirnaforge/pipeline/resources/test_data/genomes.yaml +28 -0
  87. sirnaforge-0.2.0/src/sirnaforge/pipeline/resources/test_data/test_candidates.fasta +10 -0
  88. sirnaforge-0.2.0/src/sirnaforge/pipeline/resources/test_data/test_mirna_seeds.fasta +14 -0
  89. sirnaforge-0.2.0/src/sirnaforge/pipeline/resources/test_data/test_transcriptome.fasta +6 -0
  90. sirnaforge-0.2.0/src/sirnaforge/utils/__init__.py +1 -0
  91. sirnaforge-0.2.0/src/sirnaforge/utils/logging_utils.py +73 -0
  92. sirnaforge-0.2.0/src/sirnaforge/validation/__init__.py +31 -0
  93. sirnaforge-0.2.0/src/sirnaforge/validation/config.py +110 -0
  94. sirnaforge-0.2.0/src/sirnaforge/validation/middleware.py +302 -0
  95. sirnaforge-0.2.0/src/sirnaforge/validation/utils.py +285 -0
  96. sirnaforge-0.2.0/src/sirnaforge/workflow.py +1157 -0
  97. sirnaforge-0.2.0/uv.lock +4721 -0
@@ -0,0 +1,93 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ *.egg-info/
24
+ .installed.cfg
25
+ *.egg
26
+ MANIFEST
27
+
28
+ # PyInstaller
29
+ *.manifest
30
+ *.spec
31
+
32
+ # Installer logs
33
+ pip-log.txt
34
+ pip-delete-this-directory.txt
35
+
36
+ # Unit test / coverage reports
37
+ htmlcov/
38
+ .tox/
39
+ .nox/
40
+ .coverage
41
+ .coverage.*
42
+ .cache
43
+ nosetests.xml
44
+ coverage.xml
45
+ *.cover
46
+ .hypothesis/
47
+ .pytest_cache/
48
+
49
+ # Virtual environments
50
+ .env
51
+ .venv/
52
+ env/
53
+ venv/
54
+ ENV/
55
+ env.bak/
56
+ venv.bak/
57
+
58
+ # IDEs
59
+ .vscode/
60
+ .idea/
61
+ *.swp
62
+ *.swo
63
+ *~
64
+
65
+ # OS
66
+ .DS_Store
67
+ Thumbs.db
68
+
69
+ # Project specific
70
+ cache/
71
+ *.log
72
+ results/
73
+ output/
74
+ temp/
75
+ tmp/
76
+
77
+ # Nextflow
78
+ .nextflow/
79
+ .nextflow.log*
80
+ work/
81
+
82
+ # Docker
83
+ .dockerignore
84
+
85
+ # Development
86
+ .mypy_cache/
87
+ .ruff_cache/
88
+
89
+ # Documentation
90
+ docs/_build/
91
+
92
+ nextflow_work/
93
+ nxf-tmp.*
@@ -0,0 +1,47 @@
1
+ repos:
2
+ - repo: https://github.com/pre-commit/pre-commit-hooks
3
+ rev: v4.6.0
4
+ hooks:
5
+ - id: trailing-whitespace
6
+ - id: end-of-file-fixer
7
+ - id: check-yaml
8
+ - id: check-added-large-files
9
+ - id: check-merge-conflict
10
+ - id: debug-statements
11
+
12
+ - repo: https://github.com/astral-sh/ruff-pre-commit
13
+ rev: v0.13.0
14
+ hooks:
15
+ - id: ruff
16
+ args: [--fix, --exit-non-zero-on-fix]
17
+ - id: ruff-format
18
+
19
+ - repo: https://github.com/psf/black
20
+ rev: 24.10.0
21
+ hooks:
22
+ - id: black
23
+ language_version: python3
24
+
25
+ - repo: https://github.com/pre-commit/mirrors-mypy
26
+ rev: v1.14.1
27
+ hooks:
28
+ - id: mypy
29
+ additional_dependencies: [types-requests]
30
+ exclude: ^(tests/|examples/)
31
+
32
+ - repo: local
33
+ hooks:
34
+ - id: pytest-check
35
+ name: pytest-check
36
+ entry: uv run pytest
37
+ language: system
38
+ pass_filenames: false
39
+ always_run: true
40
+ stages: [pre-push]
41
+
42
+ - id: nextflow-lint
43
+ name: nextflow-lint
44
+ entry: bash -c 'if command -v nextflow >/dev/null 2>&1; then find nextflow_pipeline -name "*.nf" -exec nextflow lint {} \; 2>/dev/null || true; else echo "โš ๏ธ Nextflow not found, skipping lint"; fi'
45
+ language: system
46
+ files: \.nf$
47
+ pass_filenames: false
@@ -0,0 +1,151 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ### โœจ New Features
11
+ - Features to be added
12
+
13
+ ### ๐Ÿ”ง Improvements
14
+ - Changes in existing functionality and enhancements
15
+
16
+ ### ๐Ÿ› Bug Fixes
17
+ - Bug fixes and issue resolutions
18
+
19
+ ### ๐Ÿ“š Documentation
20
+ - Documentation updates and improvements
21
+
22
+ ### ๐Ÿงช Testing
23
+ - Testing improvements and new test coverage
24
+
25
+ ### ๐Ÿ“ฆ Dependencies
26
+ - Dependency updates and changes
27
+
28
+ ### ๐Ÿšจ Breaking Changes
29
+ - Breaking changes that require user action
30
+
31
+ ### ๐Ÿ”’ Security
32
+ - Security updates and vulnerability fixes
33
+
34
+ ---
35
+
36
+ ## Release Template
37
+ When preparing a new release, copy this template and replace `[X.Y.Z]` with the actual version:
38
+
39
+ ```markdown
40
+ ## [X.Y.Z] - YYYY-MM-DD
41
+
42
+ ### โœจ New Features
43
+ - Brief description of new features
44
+
45
+ ### ๐Ÿ”ง Improvements
46
+ - Improvements to existing functionality
47
+ - Performance enhancements
48
+
49
+ ### ๐Ÿ› Bug Fixes
50
+ - Fixed specific issues
51
+ - Resolved edge cases
52
+
53
+ ### ๐Ÿ“Š Performance
54
+ - Performance improvements with metrics if available
55
+
56
+ ### ๐Ÿงช Testing
57
+ - New tests added
58
+ - Test coverage improvements
59
+ ```
60
+
61
+ ---
62
+
63
+ ## [0.2.0] - 2025-09-27
64
+
65
+ ### โœจ New Features
66
+ - **miRNA Database Cache System** (`sirnaforge cache`) - Local caching and management of miRNA databases from multiple sources with automatic updates
67
+ - **Comprehensive Data Validation** - Pandera DataFrameSchemas for type-safe output validation ensuring consistent CSV/TSV report formatting
68
+ - **Enhanced Thermodynamic Scoring** - Modified composite score to heavily favor (90%) duplex binding energy for improved siRNA selection accuracy
69
+ - **Workflow Input Flexibility** - Added FASTA file input support for custom transcript analysis workflows
70
+ - **Embedded Nextflow Pipeline** - Integrated Nextflow execution directly within Python API for scalable processing
71
+
72
+ ### ๐Ÿ”ง Improvements
73
+ - **Performance Optimization** - Parallelized off-target analysis and improved memory efficiency for large transcript sets
74
+ - **CLI Enhancement** - Better Unicode support, cleaner help text, and improved error reporting
75
+ - **Data Schema Validation** - Robust output validation with detailed error messages using modern Pandera 0.26.1 patterns
76
+ - **Documentation Overhaul** - Comprehensive testing guide, thermodynamic documentation, and improved API references
77
+ - **Development Workflow** - Enhanced Makefile with Docker testing categories, release validation, and conda environment support
78
+
79
+ ### ๏ฟฝ Bug Fixes
80
+ - **Security Improvements** - Resolved security linting issues and improved dependency management
81
+ - **Off-target Analysis** - Fixed alignment indexing and improved multi-species database handling
82
+ - **CI/CD Pipeline** - Resolved build failures, improved test categorization, and enhanced release automation
83
+ - **Unicode Handling** - Fixed CLI display issues in various terminal environments
84
+
85
+ ### ๐Ÿ“Š Performance
86
+ - **10-100x Faster Dependencies** - Full migration to uv package manager for ultra-fast installs and environment management
87
+ - **Optimized Algorithms** - Improved thermodynamic calculation efficiency with better filtering strategies
88
+ - **Parallel Processing** - Enhanced concurrent execution for off-target analysis across multiple genomes
89
+
90
+ ### ๐Ÿงช Testing & Infrastructure
91
+ - **Enhanced Test Categories** - Smoke tests (256MB), integration tests (2GB), and full CI validation
92
+ - **Docker Improvements** - Multi-stage builds, intelligent entrypoint, and resource-aware testing
93
+ - **Release Automation** - Comprehensive GitHub Actions workflow with quality gates and artifact management
94
+
95
+ ### ๐Ÿ“š Documentation
96
+ - **Testing Guide** - Comprehensive documentation for all test categories and Docker workflows
97
+ - **Thermodynamic Guide** - Detailed explanation of scoring algorithms and parameter optimization
98
+ - **CLI Reference** - Auto-generated command documentation with examples
99
+ - **Development Setup** - Streamlined onboarding with conda environment and uv integration
100
+
101
+ ### ๐Ÿ“ฆ Dependencies & Architecture
102
+ - **Modern Python Support** - Maintained compatibility across Python 3.9-3.12 with improved type safety
103
+ - **Pydantic Integration** - Enhanced data models with validation middleware and error handling
104
+ - **Containerization** - Production-ready Docker images with conda bioinformatics stack
105
+ - **Package Management** - Full uv adoption for dependency resolution and virtual environment management
106
+
107
+ ## [0.1.0] - 2025-09-06
108
+
109
+ ### Added
110
+ - Initial release of siRNAforge toolkit
111
+ - Core siRNA design algorithms with thermodynamic scoring
112
+ - Multi-database gene search (Ensembl, RefSeq, GENCODE)
113
+ - Rich command-line interface with Typer and Rich
114
+ - Comprehensive siRNA candidate scoring system
115
+ - Off-target prediction framework
116
+ - Nextflow pipeline integration for scalable analysis
117
+ - Docker containerization for reproducible environments
118
+ - Python API with Pydantic data models
119
+ - Comprehensive test suite with unit and integration tests
120
+ - Modern development tooling with uv, black, ruff, mypy
121
+
122
+ ### Core Features
123
+ - **Gene Search**: Multi-database transcript retrieval
124
+ - **siRNA Design**: Algorithm-driven candidate generation
125
+ - **Quality Control**: GC content, structure, and specificity filters
126
+ - **Scoring System**: Composite scoring with multiple components
127
+ - **Workflow Orchestration**: End-to-end gene-to-siRNA pipeline
128
+ - **CLI Interface**: Rich, user-friendly command-line tools
129
+ - **Python API**: Programmatic access for automation
130
+
131
+ ### Supported Operations
132
+ - `sirnaforge workflow`: Complete gene-to-siRNA analysis
133
+ - `sirnaforge search`: Gene and transcript search
134
+ - `sirnaforge design`: siRNA candidate generation
135
+ - `sirnaforge validate`: Input file validation
136
+ - `sirnaforge config`: Configuration display
137
+ - `sirnaforge version`: Version information
138
+
139
+ ### Technical Stack
140
+ - **Language**: Python 3.9-3.12
141
+ - **Package Management**: uv for fast dependency resolution
142
+ - **Data Models**: Pydantic for type-safe data handling
143
+ - **CLI Framework**: Typer with Rich for beautiful output
144
+ - **Testing**: pytest with comprehensive coverage
145
+ - **Code Quality**: black, ruff, mypy for consistency
146
+ - **Containerization**: Multi-stage Docker builds
147
+ - **Pipeline**: Nextflow integration for scalability
148
+ - **Documentation**: Sphinx with MyST parser, Read the Docs theme
149
+
150
+ [Unreleased]: https://github.com/austin-s-h/sirnaforge/compare/v0.1.0...HEAD
151
+ [0.1.0]: https://github.com/austin-s-h/sirnaforge/releases/tag/v0.1.0
@@ -0,0 +1,210 @@
1
+ # Contributing to siRNAforge
2
+
3
+ Thank you for your interest in contributing to siRNAforge! ๐Ÿงฌ
4
+
5
+ ## ๐ŸŽฏ Ways to Contribute
6
+
7
+ - ๐Ÿ› **Bug Reports**: Found a bug? Open an issue with details
8
+ - ๐Ÿ’ก **Feature Requests**: Have an idea? We'd love to hear it
9
+ - ๐Ÿ“– **Documentation**: Help improve our docs
10
+ - ๐Ÿงช **Code**: Submit pull requests for bug fixes or features
11
+ - ๐Ÿ”ฌ **Testing**: Help test new features and report issues
12
+
13
+ ## ๐Ÿš€ Getting Started
14
+
15
+ ### 1. Development Setup
16
+
17
+ ```bash
18
+ # Fork the repository on GitHub, then clone
19
+ git clone https://github.com/YOUR-USERNAME/sirnaforge.git
20
+ cd sirnaforge
21
+
22
+ # Set up development environment
23
+ make install-dev
24
+ # or manually:
25
+ uv sync --dev
26
+ uv run pre-commit install
27
+ ```
28
+
29
+ ### 2. Development Workflow
30
+
31
+ ```bash
32
+ # Create a feature branch
33
+ git checkout -b feature/your-feature-name
34
+
35
+ # Make your changes and add tests
36
+ # Run the development checks
37
+ make check # Runs linting and tests
38
+
39
+ # Format your code
40
+ make format
41
+
42
+ # Commit with descriptive messages
43
+ git commit -m "feat: add new siRNA scoring algorithm"
44
+
45
+ # Push and create pull request
46
+ git push origin feature/your-feature-name
47
+ ```
48
+
49
+ ## ๐Ÿ“‹ Development Standards
50
+
51
+ ### Code Quality
52
+ - **Type Hints**: All code must include proper type annotations
53
+ - **Testing**: New features require corresponding tests
54
+ - **Documentation**: Update docstrings and README as needed
55
+ - **Formatting**: Code is automatically formatted with Black and Ruff
56
+
57
+ ### Testing
58
+ ```bash
59
+ # Run all tests
60
+ make test
61
+
62
+ # Run tests with coverage
63
+ make test-cov
64
+
65
+ # Run specific test files
66
+ uv run pytest tests/unit/test_specific_module.py -v
67
+ ```
68
+
69
+ ### Linting & Formatting
70
+ ```bash
71
+ # Check code quality
72
+ make lint
73
+
74
+ # Auto-format code
75
+ make format
76
+ ```
77
+
78
+ ## ๐Ÿ“ Pull Request Guidelines
79
+
80
+ ### Before Submitting
81
+ - [ ] Code follows project style guidelines
82
+ - [ ] Tests pass locally (`make test`)
83
+ - [ ] New features include tests
84
+ - [ ] Documentation is updated
85
+ - [ ] Commit messages are descriptive
86
+
87
+ ### PR Description Template
88
+ ```markdown
89
+ ## Description
90
+ Brief description of changes
91
+
92
+ ## Type of Change
93
+ - [ ] Bug fix (non-breaking change that fixes an issue)
94
+ - [ ] New feature (non-breaking change that adds functionality)
95
+ - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
96
+ - [ ] Documentation update
97
+
98
+ ## Testing
99
+ - [ ] Tests pass locally
100
+ - [ ] New tests added for new functionality
101
+
102
+ ## Checklist
103
+ - [ ] Code follows style guidelines
104
+ - [ ] Self-review completed
105
+ - [ ] Documentation updated
106
+ ```
107
+
108
+ ## ๐Ÿ› Bug Reports
109
+
110
+ When filing a bug report, please include:
111
+
112
+ 1. **Environment details**:
113
+ - Python version
114
+ - Operating system
115
+ - Package version
116
+
117
+ 2. **Steps to reproduce**:
118
+ - Minimal code example
119
+ - Input files (if applicable)
120
+ - Expected vs actual behavior
121
+
122
+ 3. **Error messages**:
123
+ - Full traceback
124
+ - Log files if relevant
125
+
126
+ ## ๐Ÿ’ก Feature Requests
127
+
128
+ For new features, please:
129
+
130
+ 1. **Check existing issues** to avoid duplicates
131
+ 2. **Describe the use case** - why is this needed?
132
+ 3. **Propose implementation** - how should it work?
133
+ 4. **Consider scope** - should this be core functionality or a plugin?
134
+
135
+ ## ๐ŸŽจ Code Style
136
+
137
+ We use modern Python best practices:
138
+
139
+ - **Black** for code formatting (120 char line length)
140
+ - **Ruff** for linting and import sorting
141
+ - **MyPy** for type checking
142
+ - **Pre-commit hooks** for automated checks
143
+
144
+ ## ๐Ÿงช Testing Guidelines
145
+
146
+ ### Test Structure
147
+ - Unit tests in `tests/unit/`
148
+ - Integration tests in `tests/integration/`
149
+ - Pipeline tests in `tests/pipeline/`
150
+
151
+ ### Test Coverage
152
+ - Aim for >90% code coverage
153
+ - Focus on critical paths and edge cases
154
+ - Include both positive and negative test cases
155
+
156
+ ### Mock External Dependencies
157
+ - Mock file I/O operations
158
+ - Mock network requests
159
+ - Mock external tools (ViennaRNA, alignment tools)
160
+
161
+ ## ๐Ÿ“š Documentation
162
+
163
+ - **Code**: Comprehensive docstrings with examples
164
+ - **API**: Auto-generated from docstrings
165
+ - **Tutorials**: Practical examples in `/examples`
166
+ - **README**: Keep the main README up-to-date
167
+
168
+ ## ๐Ÿšข Release Process
169
+
170
+ 1. Update `CHANGELOG.md`
171
+ 2. Bump version in `src/sirnaforge/__init__.py`
172
+ 3. Create GitHub release
173
+ 4. CI automatically publishes to PyPI
174
+
175
+ ## ๐Ÿค Community Guidelines
176
+
177
+ - Be respectful and inclusive
178
+ - Help others learn and contribute
179
+ - Provide constructive feedback
180
+ - Follow the project's Code of Conduct
181
+
182
+ ## ๐Ÿ“ž Getting Help
183
+
184
+ - ๐Ÿ’ฌ **GitHub Discussions**: For questions and ideas
185
+ - ๐Ÿ› **Issues**: For bugs and feature requests
186
+ - ๐Ÿ“ง **Email**: For private matters
187
+
188
+ ## ๐Ÿท๏ธ Commit Message Format
189
+
190
+ We follow conventional commits:
191
+
192
+ - `feat:` - New features
193
+ - `fix:` - Bug fixes
194
+ - `docs:` - Documentation changes
195
+ - `style:` - Code style changes
196
+ - `refactor:` - Code refactoring
197
+ - `test:` - Adding or updating tests
198
+ - `chore:` - Maintenance tasks
199
+
200
+ Examples:
201
+ ```
202
+ feat: add thermodynamic stability scoring
203
+ fix: handle edge case in GC content calculation
204
+ docs: update installation instructions
205
+ test: add integration tests for workflow
206
+ ```
207
+
208
+ ---
209
+
210
+ **Thank you for contributing to siRNAforge!** ๐Ÿงฌโœจ
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Austin S. Hovland.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.