pyVSV 0.3.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.
- pyvsv-0.3.0/.gitignore +25 -0
- pyvsv-0.3.0/.python-version +1 -0
- pyvsv-0.3.0/CHANGELOG.md +10 -0
- pyvsv-0.3.0/CONTRIBUTING.md +39 -0
- pyvsv-0.3.0/LICENSE +201 -0
- pyvsv-0.3.0/Makefile +29 -0
- pyvsv-0.3.0/PKG-INFO +230 -0
- pyvsv-0.3.0/README.md +205 -0
- pyvsv-0.3.0/data/README.md +9 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_bdbv_gp/PROVENANCE.md +7 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_bdbv_gp/design.ttl +178 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_bombali_gp/PROVENANCE.md +7 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_bombali_gp/design.ttl +148 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_marv_gp/PROVENANCE.md +9 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_marv_gp/design.ttl +220 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_sudv_gp/PROVENANCE.md +11 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_sudv_gp/design.ttl +200 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_zebov_kikwit_gp/PROVENANCE.md +13 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_zebov_kikwit_gp/design.ttl +337 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_zebov_mayinga_gp/PROVENANCE.md +11 -0
- pyvsv-0.3.0/data/designs/rvsv_dg_zebov_mayinga_gp/design.ttl +223 -0
- pyvsv-0.3.0/data/designs/rvsv_gl_zebov_sgp/PROVENANCE.md +7 -0
- pyvsv-0.3.0/data/designs/rvsv_gl_zebov_sgp/design.ttl +163 -0
- pyvsv-0.3.0/data/designs/vsv_indiana/PROVENANCE.md +7 -0
- pyvsv-0.3.0/data/designs/vsv_indiana/design.ttl +111 -0
- pyvsv-0.3.0/data/processed/.gitkeep +0 -0
- pyvsv-0.3.0/data/raw/MF196237.fasta +161 -0
- pyvsv-0.3.0/data/raw/MF196237.gb +321 -0
- pyvsv-0.3.0/data/raw/MF196238.fasta +161 -0
- pyvsv-0.3.0/data/raw/MF196238.gb +321 -0
- pyvsv-0.3.0/data/raw/NC_001560.fasta +162 -0
- pyvsv-0.3.0/data/raw/NC_001560.gb +534 -0
- pyvsv-0.3.0/data/raw/NC_001560.md +9 -0
- pyvsv-0.3.0/data/raw/NC_001560.ttl +147 -0
- pyvsv-0.3.0/docs/cli.md +98 -0
- pyvsv-0.3.0/docs/images/vsv-recombinant.jpg +0 -0
- pyvsv-0.3.0/docs/images/vsv-structure-genome.jpg +0 -0
- pyvsv-0.3.0/docs/releasing.md +60 -0
- pyvsv-0.3.0/ontology/README.md +44 -0
- pyvsv-0.3.0/ontology/synthetic-virology.ttl +362 -0
- pyvsv-0.3.0/pyproject.toml +100 -0
- pyvsv-0.3.0/scripts/check_install.py +42 -0
- pyvsv-0.3.0/src/vsv/__init__.py +77 -0
- pyvsv-0.3.0/src/vsv/__main__.py +6 -0
- pyvsv-0.3.0/src/vsv/cli/__init__.py +48 -0
- pyvsv-0.3.0/src/vsv/cli/design.py +444 -0
- pyvsv-0.3.0/src/vsv/cli/genome.py +182 -0
- pyvsv-0.3.0/src/vsv/cli/render.py +48 -0
- pyvsv-0.3.0/src/vsv/design/__init__.py +63 -0
- pyvsv-0.3.0/src/vsv/design/antigenome.py +156 -0
- pyvsv-0.3.0/src/vsv/design/classes.py +98 -0
- pyvsv-0.3.0/src/vsv/design/coding.py +85 -0
- pyvsv-0.3.0/src/vsv/design/evidence.py +264 -0
- pyvsv-0.3.0/src/vsv/design/library.py +81 -0
- pyvsv-0.3.0/src/vsv/design/modules.py +82 -0
- pyvsv-0.3.0/src/vsv/design/sbol/__init__.py +5 -0
- pyvsv-0.3.0/src/vsv/design/sbol/read.py +386 -0
- pyvsv-0.3.0/src/vsv/design/sbol/terms.py +120 -0
- pyvsv-0.3.0/src/vsv/design/sbol/write.py +265 -0
- pyvsv-0.3.0/src/vsv/design/vaccine.py +442 -0
- pyvsv-0.3.0/src/vsv/design/vector.py +31 -0
- pyvsv-0.3.0/src/vsv/errors.py +7 -0
- pyvsv-0.3.0/src/vsv/genes.py +41 -0
- pyvsv-0.3.0/src/vsv/genome/__init__.py +74 -0
- pyvsv-0.3.0/src/vsv/genome/annotate.py +134 -0
- pyvsv-0.3.0/src/vsv/genome/formats.py +268 -0
- pyvsv-0.3.0/src/vsv/genome/record.py +160 -0
- pyvsv-0.3.0/src/vsv/genome/sbol/__init__.py +4 -0
- pyvsv-0.3.0/src/vsv/genome/sbol/read.py +207 -0
- pyvsv-0.3.0/src/vsv/genome/sbol/write.py +147 -0
- pyvsv-0.3.0/src/vsv/genome/sequence.py +156 -0
- pyvsv-0.3.0/src/vsv/py.typed +0 -0
- pyvsv-0.3.0/src/vsv/sbol.py +45 -0
- pyvsv-0.3.0/tests/__init__.py +0 -0
- pyvsv-0.3.0/tests/conftest.py +19 -0
- pyvsv-0.3.0/tests/synthetic.py +112 -0
- pyvsv-0.3.0/tests/test_cli.py +37 -0
- pyvsv-0.3.0/tests/test_commands.py +354 -0
- pyvsv-0.3.0/tests/test_design_file.py +116 -0
- pyvsv-0.3.0/tests/test_genome.py +212 -0
- pyvsv-0.3.0/tests/test_library.py +177 -0
- pyvsv-0.3.0/tests/test_ontology.py +102 -0
- pyvsv-0.3.0/tests/test_vaccine.py +235 -0
- pyvsv-0.3.0/uv.lock +970 -0
pyvsv-0.3.0/.gitignore
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Python environments, caches, and distributions
|
|
2
|
+
.venv*/
|
|
3
|
+
__pycache__/
|
|
4
|
+
*.py[cod]
|
|
5
|
+
*.egg-info/
|
|
6
|
+
build/
|
|
7
|
+
dist/
|
|
8
|
+
.pytest_cache/
|
|
9
|
+
.mypy_cache/
|
|
10
|
+
.ruff_cache/
|
|
11
|
+
.coverage
|
|
12
|
+
.coverage.*
|
|
13
|
+
htmlcov/
|
|
14
|
+
coverage.xml
|
|
15
|
+
|
|
16
|
+
# Local configuration and editor state
|
|
17
|
+
.env
|
|
18
|
+
.env.*
|
|
19
|
+
!.env.example
|
|
20
|
+
.DS_Store
|
|
21
|
+
.idea/
|
|
22
|
+
.vscode/
|
|
23
|
+
|
|
24
|
+
# Notebook checkpoints and generated research artifacts
|
|
25
|
+
.ipynb_checkpoints/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.12
|
pyvsv-0.3.0/CHANGELOG.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
Initial PyPI release of `pyVSV`, with the `vsv` Python package and command-line interface.
|
|
6
|
+
|
|
7
|
+
- Requires Python 3.12 or later; CI checks Python 3.12, 3.13, and 3.14.
|
|
8
|
+
- Includes inline type information, the ontology, and the reference SBOL resource in the wheel.
|
|
9
|
+
- Includes tests, documentation, reference data, and curated designs in the source archive. The curated design library is supplied separately when using the installed wheel.
|
|
10
|
+
- Publishes through PyPI Trusted Publishing after the release tag, tests, metadata, and isolated wheel and source installs pass validation.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Development
|
|
2
|
+
|
|
3
|
+
Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then run `make setup` to create the local environment from `uv.lock`. The default interpreter is Python 3.12, pinned in `.python-version`.
|
|
4
|
+
|
|
5
|
+
## Working on the code
|
|
6
|
+
|
|
7
|
+
Genomes live in `vsv.genome`. Architectures, edits, evidence, and the design library live in `vsv.design`. The command-line interface lives in `src/vsv/cli/`. A default `uv sync` installs the library and the dev tools. Add a dependency when a feature needs it.
|
|
8
|
+
|
|
9
|
+
Use type annotations for public interfaces. Keep file access, network access, and command-line argument handling separate from analysis code, so computations can be tested independently. Imports should not initiate downloads, write files, or run analyses.
|
|
10
|
+
|
|
11
|
+
Put automated tests in `tests/`. Use small synthetic fixtures for sequence-related tests, and document their purpose. Tests must run offline without external services or large datasets. Test observable behavior, including error cases, when introducing functionality.
|
|
12
|
+
|
|
13
|
+
Use notebooks for exploration and move reusable logic into the package. Clear notebook outputs before committing and keep generated artifacts in `results/`.
|
|
14
|
+
|
|
15
|
+
## Dependencies
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
uv add <package>
|
|
19
|
+
uv add --dev <development-tool>
|
|
20
|
+
uv lock --upgrade-package <package>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Review and include both `pyproject.toml` and `uv.lock` whenever changing dependencies. Normal development and CI use `--locked` so stale dependency declarations fail instead of silently changing the lockfile.
|
|
24
|
+
|
|
25
|
+
## Checks
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
make format # Apply Ruff formatting
|
|
29
|
+
make check # Lint, formatting check, strict type checking, and tests
|
|
30
|
+
make build # Build a source distribution and wheel in dist/
|
|
31
|
+
make check-dist # Build and validate PyPI metadata and README
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Individual checks are available through `make lint`, `make format-check`, `make typecheck`, and `make test`. These targets run tools through uv, so activating the virtual environment is optional.
|
|
35
|
+
|
|
36
|
+
CI runs these checks on Python 3.12, 3.13, and 3.14, then builds and checks both distributions on Python 3.12. It installs each artifact into a fresh environment to verify metadata, packaged resources, and entry points, and runs the tests from the extracted source distribution. The distribution name is `pyVSV` and its version is defined in `pyproject.toml`. The Python API and CLI read that installed distribution metadata. The import package and the `vsv` command remain `vsv`.
|
|
37
|
+
|
|
38
|
+
See [docs/releasing.md](docs/releasing.md) for PyPI setup, release validation, and publication.
|
|
39
|
+
|
pyvsv-0.3.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
pyvsv-0.3.0/Makefile
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
.PHONY: setup check lint format format-check typecheck test build check-dist
|
|
2
|
+
|
|
3
|
+
DIST_DIR ?= dist
|
|
4
|
+
|
|
5
|
+
setup:
|
|
6
|
+
uv sync --locked
|
|
7
|
+
|
|
8
|
+
check: lint format-check typecheck test
|
|
9
|
+
|
|
10
|
+
lint:
|
|
11
|
+
uv run --locked ruff check .
|
|
12
|
+
|
|
13
|
+
format:
|
|
14
|
+
uv run --locked ruff format .
|
|
15
|
+
|
|
16
|
+
format-check:
|
|
17
|
+
uv run --locked ruff format --check .
|
|
18
|
+
|
|
19
|
+
typecheck:
|
|
20
|
+
uv run --locked mypy
|
|
21
|
+
|
|
22
|
+
test:
|
|
23
|
+
uv run --locked pytest
|
|
24
|
+
|
|
25
|
+
build:
|
|
26
|
+
uv build --no-sources --out-dir "$(DIST_DIR)"
|
|
27
|
+
|
|
28
|
+
check-dist: build
|
|
29
|
+
uv run --locked twine check --strict "$(DIST_DIR)"/*.whl "$(DIST_DIR)"/*.tar.gz
|
pyvsv-0.3.0/PKG-INFO
ADDED
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pyVSV
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Computational genetics tools for Vesicular Stomatitis Virus (VSV) research.
|
|
5
|
+
Project-URL: Homepage, https://github.com/marpaia/pyVSV
|
|
6
|
+
Project-URL: Documentation, https://github.com/marpaia/pyVSV#readme
|
|
7
|
+
Project-URL: Repository, https://github.com/marpaia/pyVSV
|
|
8
|
+
Project-URL: Issues, https://github.com/marpaia/pyVSV/issues
|
|
9
|
+
License-Expression: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: bioinformatics,sbol,vsv
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
|
|
19
|
+
Classifier: Typing :: Typed
|
|
20
|
+
Requires-Python: >=3.12
|
|
21
|
+
Requires-Dist: click>=8.5.0
|
|
22
|
+
Requires-Dist: rdflib<7,>=6.1.1
|
|
23
|
+
Requires-Dist: sbol3>=1.2.0.post0
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
|
|
26
|
+
# pyVSV
|
|
27
|
+
|
|
28
|
+
pyVSV is a Python library for assembling recombinant Vesicular Stomatitis Virus (VSV) vaccine plans on the Indiana antigenome.
|
|
29
|
+
|
|
30
|
+
<p align="center">
|
|
31
|
+
<img src="https://www.arpaia.io/images/vsv/vsv-structure-genome.jpg" alt="VSV Structure and Genome">
|
|
32
|
+
</p>
|
|
33
|
+
<p align="center">
|
|
34
|
+
<em>Liu G, Cao W, Salawudeen A, et al. Vesicular Stomatitis Virus: From Agricultural Pathogen to Vaccine Vector. Pathogens. 2021;10(9):1092. Published 2021 Aug 27. doi:<a href="https://doi.org/10.3390/pathogens10091092">10.3390/pathogens10091092</a></em>
|
|
35
|
+
</p>
|
|
36
|
+
|
|
37
|
+
## Install
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
pip install pyVSV
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The Python library is installed as `pyVSV` but the import package is `vsv`.
|
|
44
|
+
|
|
45
|
+
## Quick start
|
|
46
|
+
|
|
47
|
+
```python
|
|
48
|
+
import vsv
|
|
49
|
+
from vsv import Gene, GlycoproteinForm, Host, Replication, Timing
|
|
50
|
+
|
|
51
|
+
outbreak = vsv.read_record("outbreak.gb") # pathogen record: FASTA, GenBank, or SBOL
|
|
52
|
+
glycoprotein = outbreak.cds(Gene.GLYCOPROTEIN)
|
|
53
|
+
vaccine = vsv.indiana().replace(
|
|
54
|
+
glycoprotein,
|
|
55
|
+
identifier="rvsv_dg_outbreak_gp",
|
|
56
|
+
name="rVSV outbreak glycoprotein",
|
|
57
|
+
antigen_class="zaire-ebolavirus-glycoprotein",
|
|
58
|
+
strain="Kikwit-1995",
|
|
59
|
+
form=GlycoproteinForm.FULL_LENGTH,
|
|
60
|
+
replication=Replication.COMPETENT,
|
|
61
|
+
)
|
|
62
|
+
vaccine.check()
|
|
63
|
+
|
|
64
|
+
# Gene order, the edit, its citation, and the foreign coding sequence.
|
|
65
|
+
vaccine.write_plan("plan.ttl")
|
|
66
|
+
|
|
67
|
+
# That coding sequence spliced into the Indiana reference, NC_001560.1.
|
|
68
|
+
vaccine.write_antigenome("antigenome.ttl")
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
`read_record` reads the pathogen genome from FASTA, GenBank, or an SBOL genome document. `write_plan` stores the plan: ordered genes, the edit, the method citation, and the foreign coding sequence. `write_antigenome` stores the antigenome, the same coding sequence spliced into the Indiana reference NC_001560.1. `vsv.read` opens a plan and returns a `Vaccine`. `read_record` opens that antigenome and returns a `Genome`. Calling code does not handle SBOL objects.
|
|
72
|
+
|
|
73
|
+
## The coding sequence
|
|
74
|
+
|
|
75
|
+
`cds` returns the DNA string for one of the five VSV genes and raises when that gene has no coding sequence. Spans inside a `Genome` are zero-based and half-open. In an SBOL file those spans are one-based inclusive ranges.
|
|
76
|
+
|
|
77
|
+
## Placing the gene
|
|
78
|
+
|
|
79
|
+
`replace` removes the VSV glycoprotein and puts the coding sequence in its place. The new vaccine cites the 2004 glycoprotein-replacement method. The antigen id defaults to `Glycoprotein`.
|
|
80
|
+
|
|
81
|
+
`replication` is `Replication.COMPETENT` when the antigen supplies entry, and `Replication.SINGLE_CYCLE` when it does not.
|
|
82
|
+
|
|
83
|
+
To keep the VSV glycoprotein, or to place the gene first, use `insert`. It keeps the parent's replication class, so it takes no `replication` argument. The published sites are `"g"` and `"leader"`.
|
|
84
|
+
|
|
85
|
+
```python
|
|
86
|
+
# Keep the VSV glycoprotein and add the gene after it. Cites the 1997 method.
|
|
87
|
+
vaccine = vsv.indiana().insert(
|
|
88
|
+
coding,
|
|
89
|
+
after="g",
|
|
90
|
+
identifier="rvsv_gl_outbreak_gp",
|
|
91
|
+
name="rVSV outbreak glycoprotein",
|
|
92
|
+
antigen_class="zaire-ebolavirus-glycoprotein",
|
|
93
|
+
module="outbreak_gp",
|
|
94
|
+
form=GlycoproteinForm.FULL_LENGTH,
|
|
95
|
+
strain="Kikwit-1995",
|
|
96
|
+
)
|
|
97
|
+
|
|
98
|
+
# Place the gene first, after the leader. Cites the 2014 method.
|
|
99
|
+
vaccine = vsv.indiana().insert(
|
|
100
|
+
coding,
|
|
101
|
+
after="leader",
|
|
102
|
+
identifier="rvsv_leader_outbreak_gp",
|
|
103
|
+
name="rVSV outbreak glycoprotein",
|
|
104
|
+
antigen_class="zaire-ebolavirus-glycoprotein",
|
|
105
|
+
module="outbreak_gp",
|
|
106
|
+
form=GlycoproteinForm.FULL_LENGTH,
|
|
107
|
+
strain="Kikwit-1995",
|
|
108
|
+
)
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
`vsv.indiana()` is nucleoprotein, phosphoprotein, matrix protein, glycoprotein, and large polymerase, with realization `NC_001560`.
|
|
112
|
+
|
|
113
|
+
## Checking a vaccine
|
|
114
|
+
|
|
115
|
+
`check()` is true only when `violations` is empty. A knowledge gap is a violation: unknown replication, or an unknown parent. `vsv check` exits 0 when every violation is a gap and exits 1 on any other rule.
|
|
116
|
+
|
|
117
|
+
When the edited antigen has a coding sequence, `check()` also rejects:
|
|
118
|
+
|
|
119
|
+
- an unclosed reading frame
|
|
120
|
+
- a gene-end inside the transcription unit
|
|
121
|
+
- a gene-end joined directly to a gene-start
|
|
122
|
+
- a soluble glycoprotein used as a replication-competent glycoprotein replacement
|
|
123
|
+
- a full-length or tail-chimera competent glycoprotein replacement with no hydrophobic anchor in its last 60 residues
|
|
124
|
+
- a Zaire glycoprotein whose editing site is not eight A's when full-length, or seven A's when soluble
|
|
125
|
+
|
|
126
|
+
```python
|
|
127
|
+
result = vaccine.check()
|
|
128
|
+
if not result:
|
|
129
|
+
for violation in result.violations:
|
|
130
|
+
print(violation.rule, violation.message)
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
`vaccine.observations` is empty until a result is recorded. `write_plan` stores the coding sequence when one is set. The curated shelf cards have none.
|
|
134
|
+
|
|
135
|
+
## Finding precedents
|
|
136
|
+
|
|
137
|
+
`precedents` returns published vaccines with the same arrangement: the glycoprotein replaced, one gene after the glycoprotein, or one gene after the leader. `vsv.library()` reads the curated shelf.
|
|
138
|
+
|
|
139
|
+
```python
|
|
140
|
+
for precedent in vaccine.precedents(vsv.library()):
|
|
141
|
+
print(precedent.id)
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
`antigen_class` keeps vaccines whose antigen is that class or a subclass of it. `phenotype`, `host`, and `timing` keep vaccines with a matching observation. A filovirus query includes the species glycoproteins. A Zaire query does not include Sudan or Marburg. A nonhuman-primate query includes cynomolgus and rhesus.
|
|
145
|
+
|
|
146
|
+
```python
|
|
147
|
+
from vsv import Phenotype
|
|
148
|
+
|
|
149
|
+
vaccine.precedents(
|
|
150
|
+
vsv.library(),
|
|
151
|
+
antigen_class="filovirus-glycoprotein",
|
|
152
|
+
phenotype=Phenotype.PROTECTION,
|
|
153
|
+
host=Host.NONHUMAN_PRIMATE,
|
|
154
|
+
)
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
A vaccine with any number of non-viral genes other than one is not compared.
|
|
158
|
+
|
|
159
|
+
`data/designs/` holds the Indiana chassis and one directory per published filovirus vaccine. Each directory has `design.ttl` and `PROVENANCE.md`. The Turtle describes the ordered genome and the papers. A nucleotide sequence is present only when the antigen feature has an `sbol:Sequence`. The shelf cards have none.
|
|
160
|
+
|
|
161
|
+
The curated library lives in the repository, not in the wheel. `vsv.library()` finds it from a checkout. From an installed package, pass the directory:
|
|
162
|
+
|
|
163
|
+
```python
|
|
164
|
+
from pathlib import Path
|
|
165
|
+
|
|
166
|
+
shelf = vsv.library(Path("path/to/pyVSV/data/designs"))
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Antigenome
|
|
170
|
+
|
|
171
|
+
`vaccine.antigenome()` splices the coding sequence into NC_001560.1 and returns a `Genome`. The chassis sequence is the SBOL document `NC_001560.ttl`. A glycoprotein replacement has five named genes, so `cds` returns the inserted glycoprotein. The backbone is `https://vsv.bio/backbone/VSV-Indiana`. The reference accession is NC_001560.1. The papers' infectious clones stay on `Implementation.plasmid`.
|
|
172
|
+
|
|
173
|
+
A glycoprotein replacement keeps both flanking intergenic dinucleotides on the backbone. An insert between the glycoprotein and the large polymerase prefixes `CT`. An insert after the leader suffixes `CT`, so a gene-end is not joined directly to the next gene-start.
|
|
174
|
+
|
|
175
|
+
A shelf card has no coding sequence, so `antigenome()` and `write_antigenome` raise for those files.
|
|
176
|
+
|
|
177
|
+
## Command line
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
vsv genes data/raw/NC_001560.fasta
|
|
181
|
+
vsv genes data/raw/NC_001560.ttl
|
|
182
|
+
vsv extract -g g --kind protein data/raw/NC_001560.gb
|
|
183
|
+
vsv designs
|
|
184
|
+
vsv show rvsv_dg_zebov_kikwit_gp
|
|
185
|
+
vsv check data/designs/vsv_indiana
|
|
186
|
+
vsv precedents rvsv_dg_zebov_kikwit_gp --locus 3
|
|
187
|
+
vsv precedents data/designs/rvsv_gl_zebov_sgp
|
|
188
|
+
vsv antigenome kikwit.ttl
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
On the command line the genes are `n` (nucleoprotein), `p` (phosphoprotein), `m` (matrix protein), `g` (glycoprotein), and `l` (large polymerase). The full command reference (every subcommand, its filters, and what an empty `precedents` answer means) is in [docs/cli.md](https://github.com/marpaia/pyVSV/blob/master/docs/cli.md).
|
|
192
|
+
|
|
193
|
+
## Literature
|
|
194
|
+
|
|
195
|
+
### Methods the library cites
|
|
196
|
+
|
|
197
|
+
`replace` and `insert` record the citation for the method they implement, so a written plan carries the paper its arrangement came from.
|
|
198
|
+
|
|
199
|
+
| Arrangement | Call | Method paper |
|
|
200
|
+
|---|---|---|
|
|
201
|
+
| Glycoprotein replacement | `replace(...)` | Garbutt et al., *Journal of Virology*, May 2004, [10.1128/jvi.78.10.5458-5465.2004](https://doi.org/10.1128/jvi.78.10.5458-5465.2004) |
|
|
202
|
+
| Gene after the glycoprotein | `insert(..., after="g")` | [10.1128/jvi.71.8.5982-5989.1997](https://doi.org/10.1128/jvi.71.8.5982-5989.1997) |
|
|
203
|
+
| Gene after the leader | `insert(..., after="leader")` | [10.1128/jvi.00019-14](https://doi.org/10.1128/jvi.00019-14) |
|
|
204
|
+
|
|
205
|
+
Each curated design carries its own citations and quoted evidence in its `PROVENANCE.md`.
|
|
206
|
+
|
|
207
|
+
### Vector design and recovery
|
|
208
|
+
|
|
209
|
+
- [Vesicular stomatitis virus (VSV) as a vaccine vector for immunization against viral infections](https://pubmed.ncbi.nlm.nih.gov/24379275/) - Jan 2013
|
|
210
|
+
- [An efficient plasmid-based system for the recovery of recombinant vesicular stomatitis virus encoding foreign glycoproteins](https://www.nature.com/articles/s41598-024-65384-8) - Jun 2024
|
|
211
|
+
- [Leveraging Synthetic Virology for the Rapid Engineering of Vesicular Stomatitis Virus (VSV)](https://pubmed.ncbi.nlm.nih.gov/39459973/) - Oct 2024
|
|
212
|
+
- [Low-dose VSV-EBOV vaccination provides rapid protection from lethal Ebola virus challenge](https://pubmed.ncbi.nlm.nih.gov/41727071/) - Feb 2026
|
|
213
|
+
|
|
214
|
+
### Reference genomes
|
|
215
|
+
|
|
216
|
+
- [Complete Genome Sequences of Two Vesicular Stomatitis Virus Isolates Collected in Mexico](https://pmc.ncbi.nlm.nih.gov/articles/PMC5597772/) - Sep 2017 ([VSV Isolate 1](https://www.ncbi.nlm.nih.gov/nuccore/MF196237), [VSV Isolate 2](https://www.ncbi.nlm.nih.gov/nuccore/MF196238))
|
|
217
|
+
|
|
218
|
+
## Data
|
|
219
|
+
|
|
220
|
+
- [VSV Genome Sequence](https://www.ncbi.nlm.nih.gov/nuccore/NC_001560) - Complete genome sequence of Vesicular Stomatitis Virus (VSV)
|
|
221
|
+
- [VSV Protein Structures](https://www.rcsb.org/structure/6VSV) - 3D structures of VSV proteins available in the Protein Data Bank (PDB)
|
|
222
|
+
- [Vesiculovirus on ViralZone](https://viralzone.expasy.org/21) - Information on the Vesiculovirus genus, including VSV, on ViralZone
|
|
223
|
+
|
|
224
|
+
## Resources
|
|
225
|
+
|
|
226
|
+
- [VSV Gene Expression Vector on VectorBuilder](https://en.vectorbuilder.com/resources/vector-system/pVSV_Exp.html)
|
|
227
|
+
|
|
228
|
+
## License
|
|
229
|
+
|
|
230
|
+
Apache-2.0. See [LICENSE](https://github.com/marpaia/pyVSV/blob/master/LICENSE).
|