ipython-postfix-completion 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

ipython_postfix_completion/__init__.py

@@ -53,6 +53,8 @@ DEFAULT_TEMPLATES: dict[str, str] = {
     "len": "len({expr})",
     "not": "not {expr}",
     "par": "({expr})",
+    "var": "{expr} = ",
+    "await": "await {expr}",
     "return": "return {expr}",
     "if": "if {expr}:\n{indent}    ",
     "while": "while {expr}:\n{indent}    ",

ipython_postfix_completion-0.1.1.dist-info/METADATA

@@ -0,0 +1,218 @@
+Metadata-Version: 2.4
+Name: ipython-postfix-completion
+Version: 0.1.1
+Summary: Configurable postfix completion extension for IPython.
+Author: IPython Postfix Completion Contributors
+License-Expression: BSD-3-Clause
+Keywords: ipython,completion,postfix,extension
+Classifier: Framework :: IPython
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ipython>=9.0
+Requires-Dist: traitlets>=5.13
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: ipython-postfix-completion[test]; extra == "dev"
+Dynamic: license-file
+
+# IPython Postfix Completion
+
+Configurable postfix completion extension for IPython.
+
+Package on PyPI: `ipython-postfix-completion`
+
+## Install
+
+Install into the current Python environment with `uv`:
+
+```bash
+uvx --with ipython-postfix-completion ipython
+```
+
+Install into the current ipython environment with `uv`:
+
+```bash
+uv tool install ipython --with ipython-postfix-completion
+```
+
+## Load
+
+Inside IPython:
+
+```python
+%load_ext ipython_postfix_completion
+```
+
+To load it automatically, add this to `ipython_config.py`:
+
+```python
+c.InteractiveShellApp.extensions = ["ipython_postfix_completion"]
+```
+
+## Quick Example: Add a `for` Template
+
+Add a template for the current IPython session:
+
+```python
+%postfix_template add for "for item in {expr}:\n{indent}    "
+```
+
+Use it:
+
+```python
+items.for<Tab>
+```
+
+It expands to:
+
+```python
+for item in items:
+    
+```
+
+Runtime templates only affect the current IPython session. Put templates in
+`ipython_config.py` if you want them to persist.
+
+## Runtime Magic
+
+List effective templates:
+
+```python
+%postfix_template list
+```
+
+Add or override a template for the current session:
+
+```python
+%postfix_template add debug "print({expr}=)"
+%postfix_template add forin "for item in {expr}:\n{indent}    "
+```
+
+Disable a template for the current session:
+
+```python
+%postfix_template remove tuple
+```
+
+Reset one runtime change:
+
+```python
+%postfix_template reset forin
+```
+
+Reset all runtime changes:
+
+```python
+%postfix_template reset --all
+```
+
+## Persistent Config
+
+Add persistent templates in `ipython_config.py`:
+
+```python
+c.PostfixCompletionConfig.templates = {
+    "debug": "print({expr}=)",
+    "forin": "for item in {expr}:\n{indent}    ",
+}
+
+c.PostfixCompletionConfig.disabled_templates = ["tuple"]
+```
+
+Template names must match `[A-Za-z_][A-Za-z0-9_]*`.
+
+Templates must include `{expr}` and may also use `{indent}`. No other template
+fields are allowed.
+
+## Built-in Templates
+
+Default templates:
+
+| Name | Expansion |
+| --- | --- |
+| `print` | `print({expr})` |
+| `len` | `len({expr})` |
+| `not` | `not {expr}` |
+| `par` | `({expr})` |
+| `var` | `{expr} = ` |
+| `await` | `await {expr}` |
+| `return` | `return {expr}` |
+| `if` | `if {expr}:\n{indent}    ` |
+| `while` | `while {expr}:\n{indent}    ` |
+| `raise` | `raise {expr}` |
+| `yield` | `yield {expr}` |
+| `str` | `str({expr})` |
+| `list` | `list({expr})` |
+| `set` | `set({expr})` |
+| `dict` | `dict({expr})` |
+| `tuple` | `tuple({expr})` |
+
+Use `%postfix_template list` in IPython to see the exact effective set, including
+custom and disabled templates.
+
+## Local Validation
+
+Run tests:
+
+```bash
+uv run --extra test pytest -q
+```
+
+Build and check release artifacts:
+
+```bash
+uv run --extra dev python -m build
+uv run --extra dev python -m twine check dist/*
+```
+
+Validate the wheel in a clean local virtual environment:
+
+```bash
+uv venv .venv-check
+uv pip install --python .venv-check/bin/python dist/*.whl
+.venv-check/bin/ipython
+```
+
+Then inside IPython:
+
+```python
+%load_ext ipython_postfix_completion
+%postfix_template add for "for item in {expr}:\n{indent}    "
+%postfix_template list
+```
+
+## Publish
+
+Publishing uses GitHub Actions and PyPI Trusted Publishing. Configure the
+existing PyPI project once under **Manage > Publishing > Add a new publisher**:
+
+| Setting | Value |
+| --- | --- |
+| Owner | `fishandsheep` |
+| Repository | `ipython-postfix-completion` |
+| Workflow | `publish.yml` |
+| Environment | `pypi` |
+
+For each release, update `project.version` in `pyproject.toml`, commit and push
+the change, then create a matching `v` tag. For example, after changing the
+version to `0.1.1`:
+
+```bash
+git tag v0.1.1
+git push origin v0.1.1
+```
+
+The workflow verifies the tag against `project.version`, runs tests, builds and
+checks both distributions, then publishes them to PyPI using a short-lived OIDC
+credential. The already-published `0.1.0` release cannot be uploaded again.

ipython_postfix_completion-0.1.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+ipython_postfix_completion/__init__.py,sha256=Ihs9zrkmwcmDydHIxRn4KU7yeRR_NWxHpB9WaidvyXs,18145
+ipython_postfix_completion-0.1.1.dist-info/licenses/LICENSE,sha256=omLR-7QW1K3l6AG7ih1N5L8Z58UY-ROrQL82ANN9PnM,1547
+ipython_postfix_completion-0.1.1.dist-info/METADATA,sha256=10PHgmlDTJQVOwdahbiqMKFEdkxQvdCEvWyO1jo3uQk,4960
+ipython_postfix_completion-0.1.1.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+ipython_postfix_completion-0.1.1.dist-info/top_level.txt,sha256=W2sJCvsBheoCB2nbzJeD7-p5PR6lVDNicVLxNxmeraY,27
+ipython_postfix_completion-0.1.1.dist-info/RECORD,,

ipython_postfix_completion-0.1.0.dist-info/METADATA

@@ -1,150 +0,0 @@
-Metadata-Version: 2.4
-Name: ipython-postfix-completion
-Version: 0.1.0
-Summary: Configurable postfix completion extension for IPython.
-Author: IPython Postfix Completion Contributors
-License-Expression: BSD-3-Clause
-Keywords: ipython,completion,postfix,extension
-Classifier: Framework :: IPython
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: ipython>=9.0
-Requires-Dist: traitlets>=5.13
-Provides-Extra: test
-Requires-Dist: pytest>=7; extra == "test"
-Provides-Extra: dev
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: ipython-postfix-completion[test]; extra == "dev"
-Dynamic: license-file
-
-# IPython Postfix Completion
-
-Configurable postfix completion extension for IPython.
-
-## Install
-
-From a local checkout:
-
-```bash
-python -m pip install -e .
-```
-
-From PyPI after publishing:
-
-```bash
-python -m pip install ipython-postfix-completion
-```
-
-## Load
-
-Inside IPython:
-
-```python
-%load_ext ipython_postfix_completion
-```
-
-To load it automatically, add this to `ipython_config.py`:
-
-```python
-c.InteractiveShellApp.extensions = ["ipython_postfix_completion"]
-```
-
-## Runtime Templates
-
-Add a template for the current session:
-
-```python
-%postfix_template add forin "for item in {expr}:\n{indent}    "
-```
-
-Use it:
-
-```python
-items.forin<Tab>
-```
-
-This expands to:
-
-```python
-for item in items:
-    
-```
-
-List effective templates:
-
-```python
-%postfix_template list
-```
-
-Disable a template for the current session:
-
-```python
-%postfix_template remove tuple
-```
-
-Reset one runtime change:
-
-```python
-%postfix_template reset forin
-```
-
-Reset all runtime changes:
-
-```python
-%postfix_template reset --all
-```
-
-## Persistent Config
-
-Add persistent templates in `ipython_config.py`:
-
-```python
-c.PostfixCompletionConfig.templates = {
-    "debug": "print({expr}=)",
-    "forin": "for item in {expr}:\n{indent}    ",
-}
-
-c.PostfixCompletionConfig.disabled_templates = ["tuple"]
-```
-
-Template names must match `[A-Za-z_][A-Za-z0-9_]*`.
-
-Templates must include `{expr}` and may also use `{indent}`. No other template fields are allowed.
-
-## Development
-
-Run tests:
-
-```bash
-python -m pip install -e ".[test]"
-python -m pytest
-```
-
-Build release artifacts:
-
-```bash
-python -m pip install build twine
-python -m build
-python -m twine check dist/*
-```
-
-Publish to TestPyPI:
-
-```bash
-python -m twine upload --repository testpypi dist/*
-```
-
-Publish to PyPI:
-
-```bash
-python -m twine upload dist/*
-```

ipython_postfix_completion-0.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-ipython_postfix_completion/__init__.py,sha256=DRxZk3AHYjxgytPi07L7mumRC35xpxJIvFQmqING7Hs,18092
-ipython_postfix_completion-0.1.0.dist-info/licenses/LICENSE,sha256=omLR-7QW1K3l6AG7ih1N5L8Z58UY-ROrQL82ANN9PnM,1547
-ipython_postfix_completion-0.1.0.dist-info/METADATA,sha256=TufiR1ICd7vXLBVvvdj7zYPaiiSkiySe3Ub9wkxDneo,2850
-ipython_postfix_completion-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-ipython_postfix_completion-0.1.0.dist-info/top_level.txt,sha256=W2sJCvsBheoCB2nbzJeD7-p5PR6lVDNicVLxNxmeraY,27
-ipython_postfix_completion-0.1.0.dist-info/RECORD,,