codeine 0.1.0__py3-none-any.whl

codeine-0.1.0.dist-info/METADATA

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: codeine
+Version: 0.1.0
+Author: Michael Peter Dunne
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# 🧬 Codeine
+
+**Codeine** is a Python library for generating synonymous protein-coding sequences under biological constraints.
+
+
+## Installation & documentation
+
+**Codeine** is available on PyPI:
+
+```bash
+pip install codeine
+```
+
+Full documentation: **https://codeine.readthedocs.io/**.
+
+## Quick start
+
+```python
+from codeine import CodingSpace
+
+space = CodingSpace('MKTIIALSYIFCLVF')
+
+print(space.n_valid_sequences)
+print(space.sample())
+```
+
+
+## Overview
+
+A protein sequence can typically be encoded by an enormous number of synonymous DNA/RNA coding sequences.
+
+For biotechnological applications such as recombinant expression, we typically must choose a coding sequence while respecting one or more practical constraints, for example:
+- avoiding restriction enzyme sites,
+- avoiding nucleotide homopolymers,
+- fixing specific codons,
+- mutating relative to a reference sequence.
+
+Identifying valid coding sequences under such constraints quickly becomes challenging, especially for longer protein sequences.
+
+**Codeine** represents the complete space of valid coding sequences for a given protein and experimental setup. It enables highly efficient sampling, enumeration and mutation library design while guaranteeing that the generated sequences satisfy user-specified constraints.
+
+## Examples
+
+Count valid sequences:
+
+```python
+from codeine import CodingSpace
+
+space = CodingSpace('MKTLEFQNGSCPRYKKL')
+
+print(space.n_valid_sequences)
+```
+
+Sample a single valid sequences:
+
+```python
+from codeine import CodingSpace
+
+space = CodingSpace('MKTLEFQNGSCPRYKKL')
+
+seq = space.sample()
+print(seq)
+```
+
+Sample many:
+```python
+from codeine import CodingSpace
+
+space = CodingSpace('MKTLEFQNGSCPRYKKL')
+
+for seq in space.sample(n=5):
+    print(seq)
+```
+
+Apply restrictions:
+
+```python
+from codeine import CodingSpace, RestrictionSite
+
+space = CodingSpace(
+    'MKTLEFQNGSCPRYKKL',
+    forbidden_motifs=[
+        RestrictionSite.EcoRI,
+        RestrictionSite.BamHI,
+        'CTGCAG',
+    ],
+    codon_restrictions={
+        2: 'AAG',
+        16: 'AAG',
+    },
+    max_homopolymer=4,
+)
+
+print(space.n_valid_sequences)
+print(space.sample())
+```
+
+Use custom codon weights to change sampling distribution:
+
+```python
+from codeine import CodingSpace, CodonWeights
+
+weights = CodonWeights.ecoli()
+
+space = CodingSpace("MKTLEFQNGSCPRYKKL", codon_weights=weights)
+
+seq = space.sample()
+print(seq)
+```
+
+Nonstandard translation tables and RNA:
+
+```python
+from codeine import CodingSpace, TranslationTable
+
+table = TranslationTable(table_id=2, rna=True)
+
+space = CodingSpace("MKTLEFQNGSCPRYKKL", translation_table=table)
+
+seq = space.sample()
+print(seq)
+```
+
+Enumerate all sequences (only recommended for small spaces):
+
+```python
+from codeine import CodingSpace
+
+space = CodingSpace('CYIQNCPLG')
+
+for sequence in space:
+    print(sequence)
+```
+
+Explore mutants of a chosen reference sequence:
+
+```python
+from codeine import CodingSpace
+
+space = CodingSpace('MKTLEFQNGSCPRYKKL')
+
+reference = space.sample()
+
+mutants = space.mutants(
+    reference,
+    free_positions=range(5, 14),
+    min_nts=2,
+    max_nts=5,
+)
+
+mutant = mutants.sample()
+print(mutant)
+```

codeine-0.1.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+codeine/__init__.py,sha256=htuaeXUFkyF9hujDz2xY5B-s4gHksMwRI2dnhI1jYOQ,380
+codeine/constraints/banned.py,sha256=_vcXW4YZ3AgUO_-db_xJtt_A71EX3ehqLKzEHSoftds,13719
+codeine/constraints/base.py,sha256=4rA0QqRPf9nJGKzUGiEtFUUe48JJED2RPMPZ9COFq7I,993
+codeine/constraints/mutations.py,sha256=RZ9A-WOcn8mqHhKCtOLPcMUBO-HQ3I1ylDeU6Bphtu8,3418
+codeine/graph/base.py,sha256=aTxex50txKxGCtrp55JS16zMZ2Dg8UGj27aEocTOljg,8535
+codeine/graph/compile.py,sha256=NCqLIgSxJi3-ziWr-KGutywjVszLi_XSsM3X53xGSjU,16405
+codeine/graph/nodes.py,sha256=TkLOrX9leYQ3245GZTvqaaW5i3VajKM7l3e4yP-NnLI,2482
+codeine/graph/view.py,sha256=la6OjWkWoSh19Sm5hQ2OmKuIEZOVwqensRczdWJ_Mt4,23083
+codeine/motifs/restriction.py,sha256=G4UD9BHjOsab42G8O9O7ebssoh2ZQcLqvezy8ukslwE,2412
+codeine/motifs/validate.py,sha256=vIiZ7JjsIetM2T7M0OJsGFdu0q_sAOUPcz1oOJKnwdg,3243
+codeine/space/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codeine/space/coding.py,sha256=G9XNmJnai8g1mbGHNaOjfFiDM2vrCvTVbMhDF-fdBx0,15418
+codeine/space/mutation.py,sha256=EfJ6AYP46cnKSg1gMIdqQgIxFW5_aFyjJdR5--QaNFI,15502
+codeine/translation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codeine/translation/tables.py,sha256=tmM-5pw030YX69xNnkb8pi-9s1cPD1AUvInrtzSGoxI,5995
+codeine/translation/weights.py,sha256=RyZUhi_ZuU7KSRtNc3du-YAAfOu1l8Nl6jW2JbjraVo,9698
+codeine/translation/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codeine/translation/data/tables.json,sha256=WjPanNn6qxvy0OdxuIGMWtWJiWCS3WiLqePaBn1htsk,38890
+codeine/translation/data/weights.py,sha256=wKD_eLLAgjpLXVYxJwSI3C0_-mN4sK9j_ql5Eq65F_8,11330
+codeine/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codeine/utils/dict.py,sha256=woKX68oXYoHuf7aYEuydWr-Uv4naqqnhQrCQUsjekXI,521
+codeine/utils/display.py,sha256=D29kGOWQE3EEC2IVY2JK7JbHf0iaCumoTcRNwPJDVkM,3015
+codeine/utils/sampling.py,sha256=MFaCL45xhSvdUU-SWI7szHXzPzks6DLI78ZwrQEnlUE,2440
+codeine-0.1.0.dist-info/licenses/LICENSE,sha256=32u-XTG2hRKXdpWqKnogQiHMIhdUpyrT4IsJW61wepU,1070
+codeine-0.1.0.dist-info/METADATA,sha256=hZURnys_KY6BuoDfR0FjzpXmJwdxpeta60kcRbx8HeI,3333
+codeine-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+codeine-0.1.0.dist-info/top_level.txt,sha256=eN1nlAn_yqn2c2wK-lvYDu0A5-CgB6WKOoZgD8aIYOU,8
+codeine-0.1.0.dist-info/RECORD,,

codeine-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

codeine-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Michael Dunne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codeine-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+codeine