teddympnn 0.0.1__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.
@@ -0,0 +1,2 @@
1
+ # Auto detect text files and perform LF normalization
2
+ * text=auto
@@ -0,0 +1,39 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main, dev]
6
+ pull_request:
7
+ branches: [main]
8
+
9
+ jobs:
10
+ test:
11
+ runs-on: ubuntu-latest
12
+ strategy:
13
+ matrix:
14
+ python-version: ["3.11"]
15
+
16
+ steps:
17
+ - uses: actions/checkout@v4
18
+
19
+ - name: Set up Python ${{ matrix.python-version }}
20
+ uses: actions/setup-python@v5
21
+ with:
22
+ python-version: ${{ matrix.python-version }}
23
+
24
+ - name: Install dependencies
25
+ run: |
26
+ python -m pip install --upgrade pip
27
+ pip install -e ".[dev]"
28
+
29
+ - name: Lint
30
+ run: ruff check src/ tests/
31
+
32
+ - name: Format check
33
+ run: ruff format --check src/ tests/
34
+
35
+ - name: Type check
36
+ run: mypy src/
37
+
38
+ - name: Test
39
+ run: pytest
@@ -0,0 +1,39 @@
1
+ name: Upload Python Package
2
+
3
+ on:
4
+ release:
5
+ types: [created]
6
+
7
+ jobs:
8
+ pypi-publish:
9
+ name: upload release to PyPI
10
+ runs-on: ubuntu-latest
11
+ permissions:
12
+ id-token: write
13
+ steps:
14
+ - name: Checkout
15
+ uses: actions/checkout@v4
16
+
17
+ - name: Set up Python
18
+ uses: actions/setup-python@v5
19
+ with:
20
+ python-version: "3.x"
21
+
22
+ - name: Install build tooling (PEP 517)
23
+ run: |
24
+ python -m pip install --upgrade pip
25
+ python -m pip install build
26
+
27
+ - name: Build distributions
28
+ run: python -m build
29
+
30
+ - name: List built artifacts (size)
31
+ run: ls -lh dist/
32
+
33
+ - name: Validate metadata (optional)
34
+ run: |
35
+ python -m pip install twine
36
+ twine check dist/*
37
+
38
+ - name: Publish package distributions to PyPI
39
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,184 @@
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
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ #uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ #poetry.lock
109
+
110
+ # pdm
111
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
112
+ #pdm.lock
113
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
114
+ # in version control.
115
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
116
+ .pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
121
+ __pypackages__/
122
+
123
+ # Celery stuff
124
+ celerybeat-schedule
125
+ celerybeat.pid
126
+
127
+ # SageMath parsed files
128
+ *.sage.py
129
+
130
+ # Environments
131
+ .env
132
+ .venv
133
+ env/
134
+ venv/
135
+ ENV/
136
+ env.bak/
137
+ venv.bak/
138
+
139
+ # Spyder project settings
140
+ .spyderproject
141
+ .spyproject
142
+
143
+ # Rope project settings
144
+ .ropeproject
145
+
146
+ # mkdocs documentation
147
+ /site
148
+
149
+ # mypy
150
+ .mypy_cache/
151
+ .dmypy.json
152
+ dmypy.json
153
+
154
+ # Pyre type checker
155
+ .pyre/
156
+
157
+ # pytype static type analyzer
158
+ .pytype/
159
+
160
+ # Cython debug symbols
161
+ cython_debug/
162
+
163
+ # PyCharm
164
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
165
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
166
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
167
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
168
+ #.idea/
169
+
170
+ # Ruff stuff:
171
+ .ruff_cache/
172
+
173
+ # PyPI configuration file
174
+ .pypirc
175
+
176
+ # Cursor
177
+ # Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to
178
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
179
+ # refer to https://docs.cursor.com/context/ignore-files
180
+ .cursorignore
181
+ .cursorindexingignore
182
+
183
+ # macOS
184
+ .DS_Store
@@ -0,0 +1 @@
1
+ 3.11
@@ -0,0 +1,52 @@
1
+ # Agent Instructions
2
+
3
+ General instructions for AI coding agents working on this project.
4
+ Not specific to any single agent or tool.
5
+
6
+ ## Project Overview
7
+
8
+ teddyMPNN is a message passing neural network for protein-protein interfaces.
9
+
10
+ ## Architecture
11
+
12
+ <!-- Describe the main modules/components, their responsibilities, and how they interact.
13
+ Include data flow if relevant. -->
14
+
15
+ TODO: Fill in as the project develops.
16
+
17
+ ## Development Workflow
18
+
19
+ - Install: `pip install -e ".[dev]"`
20
+ - Test: `pytest`
21
+ - Lint: `ruff check src/ tests/`
22
+ - Format: `ruff format src/ tests/`
23
+ - Type check: `mypy src/`
24
+
25
+ Always run tests and lint before considering work complete.
26
+
27
+ ## Conventions
28
+
29
+ - **Formatting**: Ruff handles this. Do not manually adjust formatting.
30
+ - **Imports**: Sorted by ruff (isort rules). Do not manually reorder.
31
+ - **Types**: All function signatures must have type annotations. Use modern syntax (`X | None` not `Optional[X]`).
32
+ - **Docstrings**: Google style. Required on all public functions, classes, and modules.
33
+ - **Tests**: Every new function or class should have corresponding tests. Use `pytest` fixtures, not `setUp`/`tearDown`.
34
+ - **Error handling**: Prefer specific exceptions over bare `except`. Define custom exceptions in a `exceptions.py` module if the project needs them.
35
+ - **Naming**: snake_case for functions/variables, PascalCase for classes, UPPER_SNAKE for constants.
36
+
37
+ ## What Not to Do
38
+
39
+ - Do not add dependencies without explicit approval. Prefer the standard library when reasonable.
40
+ - Do not create separate config files (`.flake8`, `pytest.ini`, `mypy.ini`, etc.). All tool config lives in `pyproject.toml`.
41
+ - Do not use `setup.py`, `setup.cfg`, or `requirements.txt`.
42
+ - Do not modify CI configuration without explicit approval.
43
+ - Do not add `# type: ignore` without a comment explaining why.
44
+ - Do not write tests that depend on external services or network access without mocking.
45
+
46
+ ## Sensitive Areas
47
+
48
+ <!-- List files, modules, or patterns that need extra care — e.g., security-critical code,
49
+ performance-sensitive paths, or tricky algorithms. Agents should be extra cautious
50
+ modifying these and should flag changes for human review. -->
51
+
52
+ TODO: Fill in as the project develops.
@@ -0,0 +1,52 @@
1
+ # teddyMPNN
2
+
3
+ A message passing neural network for protein-protein interfaces.
4
+
5
+ ## Quick Reference
6
+
7
+ ```bash
8
+ # Install (editable, with dev dependencies)
9
+ pip install -e ".[dev]"
10
+
11
+ # Run tests
12
+ pytest
13
+
14
+ # Lint and format
15
+ ruff check src/ tests/
16
+ ruff format src/ tests/
17
+
18
+ # Type check
19
+ mypy src/
20
+
21
+ # CLI
22
+ python -m teddympnn --help
23
+ ```
24
+
25
+ ## Project Structure
26
+
27
+ ```
28
+ src/teddympnn/ # Main package code
29
+ tests/ # Test suite (mirrors src structure)
30
+ ```
31
+
32
+ ## Code Conventions
33
+
34
+ - Python 3.11+ — use modern syntax (type unions with `|`, `match` statements, etc.)
35
+ - All public functions and classes need docstrings (Google style)
36
+ - Type hints on all function signatures
37
+ - Tests go in `tests/` mirroring the src structure: `src/foo/bar.py` → `tests/test_bar.py`
38
+ - Ruff handles formatting and linting — don't override its defaults beyond pyproject.toml config
39
+
40
+ ## Before Committing
41
+
42
+ 1. `ruff check --fix src/ tests/` — auto-fix lint issues
43
+ 2. `ruff format src/ tests/` — format code
44
+ 3. `pytest` — all tests pass
45
+ 4. Write a meaningful commit message: `<component>: <what changed and why>`
46
+
47
+ ## Architecture
48
+
49
+ <!-- Update this section as the project develops. Describe the main components,
50
+ how data flows, and any non-obvious design decisions. -->
51
+
52
+ TODO: Fill in as the project takes shape.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Bryan Briney
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.
@@ -0,0 +1,41 @@
1
+ Metadata-Version: 2.4
2
+ Name: teddympnn
3
+ Version: 0.0.1
4
+ Summary: A message passing neural network for protein-protein interfaces
5
+ Project-URL: Repository, https://github.com/briney/teddympnn
6
+ Author-email: Bryan Briney <briney@scripps.edu>
7
+ License-Expression: MIT
8
+ License-File: LICENSE
9
+ Requires-Python: >=3.11
10
+ Requires-Dist: typer>=0.9
11
+ Provides-Extra: dev
12
+ Requires-Dist: mypy>=1.0; extra == 'dev'
13
+ Requires-Dist: pre-commit>=3.0; extra == 'dev'
14
+ Requires-Dist: pytest>=7.0; extra == 'dev'
15
+ Requires-Dist: ruff>=0.4; extra == 'dev'
16
+ Description-Content-Type: text/markdown
17
+
18
+ # teddyMPNN
19
+
20
+ A message passing neural network for protein-protein interfaces.
21
+
22
+ ## Installation
23
+
24
+ ```bash
25
+ pip install teddympnn
26
+ ```
27
+
28
+ For development:
29
+
30
+ ```bash
31
+ git clone https://github.com/briney/teddympnn.git
32
+ cd teddympnn
33
+ pip install -e ".[dev]"
34
+ ```
35
+
36
+ ## Usage
37
+
38
+ ```bash
39
+ python -m teddympnn --help
40
+ ```
41
+
@@ -0,0 +1,24 @@
1
+ # teddyMPNN
2
+
3
+ A message passing neural network for protein-protein interfaces.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pip install teddympnn
9
+ ```
10
+
11
+ For development:
12
+
13
+ ```bash
14
+ git clone https://github.com/briney/teddympnn.git
15
+ cd teddympnn
16
+ pip install -e ".[dev]"
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ```bash
22
+ python -m teddympnn --help
23
+ ```
24
+