exportify 0.1.0__tar.gz

exportify-0.1.0/.gitignore

@@ -0,0 +1,232 @@
+# SPDX-FileCopyrightText: 2025 Knitli Inc.
+# SPDX-FileContributor: Adam Poulemanos <adam@knit.li>
+#
+# SPDX-License-Identifier: MIT OR Apache-2.0
+
+# local configs
+.claude/*.local.*
+**/*.local.*
+**/*.local.*.license
+mise.local.toml
+mise.*.local.toml
+mise.local.toml.license
+mise.*.local.toml.license
+hk.local.pkl.license
+.ruff_cache
+.roo/mcp.json
+# local terminal zsh config -- can contain sensitive info
+.vscode/terminal.local.zsh
+*mcp*.backup*
+
+# CLAUDE.md -- we symlink this file from AGENTS.md in the setup script
+CLAUDE.md
+GEMINI.md
+
+# non-public working files
+.workbench/
+.devenv/
+.testbuild/
+.history
+.temp/
+
+# Workspace files
+*.code-workspace
+*.code-workspace.license
+
+# mkdocs
+.cache
+
+# Playwright
+logs
+_.log
+report.[0-9]_[0-9]_[0-9]_[0-9]_.json
+out
+dist/
+*.tgz
+coverage
+*.lcov
+.env
+*.local.*
+*.local
+.eslintcache
+.cache
+!.cache/uv/
+*.tsbuildinfo
+**/dist/
+
+# venv
+**/.venv
+.venv/
+
+# node and docs-site
+node_modules/
+**/node_modules/
+docs-site/dist/
+docs-site/.cache/
+docs-site/.astro/
+
+# Cache files
+**/__pycache__/
+**/.pytest_cache/
+__pycache__/
+.pytest_cache/
+.eslintcache
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+.pytest_cache
+
+dist/
+site/
+*.tar
+*.tar.*
+*.jar
+*.exe
+*.msi
+*.zip
+*.tgz
+*.log
+*.log.*
+*.sig
+
+.DS_Store
+*.swp
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Local config
+ipython_config.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.tlog
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+*.snk
+
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+bower_components/
+
+# Local History for Visual Studio Code
+.history/
+lib64/
+remote-debug-profile/
+
+# zcomp and zhistory files
+.vscode/zsh/.zcompdump
+.vscode/zsh/.zcompdump-*
+.vscode/zsh/.zsh_history
+
+__pycache__/
+**/.pytest_cache/
+.pytest_cache/
+# //!SECTION  EXCEPTIONS -- Put all inverted ("!") rules at the end of the file!
+
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Leave launch.json public
+!.vscode/launch.json
+!.vscode/launch.json.license
+
+# Leave settings.json and workspace zshrc/init public
+!.vscode/tasks.json
+!.vscode/tasks.json.license
+!.vscode/extensions.json
+!.vscode/extensions.json.license
+!.vscode/mcp.json
+!.vscode/mcp.json.license
+!.vscode/settings.json
+!.vscode/settings.json.license
+!.vscode/terminal.extra.zsh
+!.vscode/terminal.extra.zsh.example
+!.vscode/zsh/.zshrc
+
+# project-level git files that should be public and easily get caught in ignores
+!.gitattributes
+!.gitconfig.license
+!.gitignore
+!.gitconfig
+!.mailmap
+
+!.cache/uv/
+
+# Generated Files
+**/htmlcov/
+.coverage
+.coveragexml
+.vscode/.history/
+coverage.xml
+docs-site/dist/
+htmlcov/
+lcov-report/
+server.json
+server.json.license
+server.yaml
+server.yaml.license
+test-results.xml
+
+.jj/
+
+# Finally, stuff we *really* don't want to let leak
+.local.env
+mise.local.toml
+mise.local.env
+
+.gemini/
+gha-creds-*.json
+
+src/exportify/_version.py

exportify-0.1.0/LICENSE-Apache-2.0

@@ -0,0 +1 @@
+./LICENSES/Apache-2.0.txt

exportify-0.1.0/LICENSE-MIT

@@ -0,0 +1 @@
+./LICENSES/MIT.txt

exportify-0.1.0/LICENSES/Apache-2.0.txt

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright 2026 Knitli Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

exportify-0.1.0/LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026 Knitli Inc.
+
+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.

exportify-0.1.0/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.4
+Name: exportify
+Version: 0.1.0
+Summary: Export, __all__, and lazy import management for Python projects.
+Project-URL: Homepage, https://github.com/knitli/exportify
+Project-URL: Issues, https://github.com/knitli/exportify/issues
+Project-URL: Repository, https://github.com/knitli/exportify
+Author: Knitli Inc.
+Author-email: Adam Poulemanos <adam@knit.li>
+License-File: LICENSE-Apache-2.0
+License-File: LICENSE-MIT
+License-File: LICENSES/Apache-2.0.txt
+License-File: LICENSES/MIT.txt
+Keywords: __all__,__init__,code-generation,exports,lazy-imports,package-management
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: cyclopts>=4.5.0
+Requires-Dist: lateimport>=0.1.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=14.3.0
+Requires-Dist: textcase>=0.4.5

exportify-0.1.0/README.md

@@ -0,0 +1,233 @@
+<!--
+SPDX-FileCopyrightText: 2026 Knitli Inc.
+
+SPDX-License-Identifier: MIT OR Apache-2.0
+-->
+
+# exportify
+
+**exportify** is a CLI tool and library for managing Python package exports: generating `__init__.py` files with lazy imports (using [`lateimport`](https://github.com/knitli/lateimport)), managing `__all__` declarations, and validating import consistency.
+
+Exportify was previously developed as an internal dev tool to assist with our [CodeWeaver](https://github.com/knitli/codeweaver) project; it slowly grew in function until it didn't make sense to keep it as part of that project. Here it is for anyone to use.
+
+## What it Does
+
+Exportify **solves the problem of managing consistency and updates in export patterns across a codebase.** It ensures module and package-level `__all__` exports are consistent, accurate, and complete. It can also validate 
+
+Exportify offers a simple rule-based system for enforcing `__all__` and `__init__` patterns across a codebase with optional per-file overrides. Comes with sane defaults.
+
+## Features
+
+- **Lazy `__init__.py` generation** — generates `__init__.py` files using a lazy `__getattr__` pattern powered by [`lateimport`](https://pypi.org/project/lateimport/), keeping package imports fast and circular-import-free
+- **YAML-driven rule engine** — declarative rules control which symbols are exported, with priority ordering and pattern matching
+- **Export propagation** — symbols exported from submodules automatically propagate up the package hierarchy
+- **Code preservation** — manually written code above the `# === MANAGED EXPORTS ===` sentinel is preserved across regeneration
+- **Validation** — checks that lazy import calls are well-formed and that `__all__` declarations are consistent
+- **Cache** — SHA-256-based analysis cache for fast incremental updates
+
+## Installation
+
+Easiest to install with [`uv`](https://docs.astral.sh/uv/getting-started/installation/):
+
+```bash
+uv tool install exportify
+```
+
+or `pipx`:
+
+```bash
+pipx install exportify
+```
+
+Python 3.12+ required.
+
+## Quick Start
+
+```bash
+# Create a default config file (.exportify/config.yaml)
+exportify init
+
+# Check current state — runs all checks by default
+exportify check
+
+# Bootstrap __init__.py files for packages that don't have one
+exportify generate
+
+# Preview what fix would change without writing anything
+exportify fix --dry-run
+
+# Sync exports and __all__ to match rules
+exportify fix
+
+# Show overall export/import health
+exportify status
+```
+
+## Documentation
+
+### For new users
+
+| Document | Description |
+|----------|-------------|
+| [Getting Started](docs/getting-started.md) | Step-by-step tutorial for new projects |
+
+### Reference
+
+| Document | Description |
+|----------|-------------|
+| [CLI Reference](docs/cli-reference.md) | Complete command reference with all flags |
+| [Rule Engine](src/exportify/rules/README.md) | Rule syntax, priorities, match criteria, provenance |
+| [Configuration](docs/init.md) | Initializing and configuring exportify |
+
+### Guides
+
+| Document | Description |
+|----------|-------------|
+| [Troubleshooting & FAQ](docs/troubleshooting.md) | Common issues and answers |
+| [Contributing](docs/contributing.md) | Development setup and how to contribute |
+
+### Internals (for contributors)
+
+| Document | Description |
+|----------|-------------|
+| [Caching](docs/caching.md) | Cache implementation and API |
+| [Overload Handling](docs/overload-handling.md) | `@overload` decorator support |
+| [Provenance Support](docs/provenance.md) | Symbol provenance in rules |
+| [Schema Versioning](docs/schema-versioning.md) | Config schema version management |
+
+## Configuration
+
+Rules live in `.exportify/config.yaml` (created by `exportify init` or written manually). Exportify searches for the config file in this order:
+
+1. `EXPORTIFY_CONFIG` environment variable (any path)
+2. `.exportify/config.yaml`
+3. `.exportify/config.yml`
+4. `.exportify.yaml` in the current working directory
+5. `.exportify.yml`
+6. `exportify.yaml`
+7. `exportify.yml`
+
+```yaml
+schema_version: "1.0"
+
+rules:
+  - name: "exclude-private"
+    priority: 1000
+    match:
+      name_pattern: "^_"
+    action: exclude
+
+  - name: "include-public-classes"
+    priority: 700
+    match:
+      name_pattern: "^[A-Z]"
+      member_types: [class]
+    action: include
+    propagate: root
+
+  - name: "include-public-functions"
+    priority: 700
+    match:
+      name_pattern: "^[a-z]"
+      member_types: [function]
+    action: include
+    propagate: parent
+```
+
+### Rule Priority Bands
+
+| Priority | Purpose |
+|----------|---------|
+| 1000 | Absolute exclusions (private, dunders) |
+| 900–800 | Infrastructure/framework exclusions |
+| 700 | Primary export rules (classes, functions) |
+| 600–500 | Import handling |
+| 300–400 | Special cases |
+| 0–200 | Defaults/fallbacks |
+
+See the [Rule Engine docs](src/exportify/rules/README.md) for the full rule syntax including logical combinations, match criteria, and advanced propagation options.
+
+### Propagation Levels
+
+- `none` — export only in the defining module
+- `parent` — export in the defining module and its direct parent
+- `root` — export all the way to the package root
+- `custom` — specify explicit target module
+
+## Generated Output
+
+Exportify generates `__init__.py` files using the lazy `__getattr__` pattern from `lateimport`:
+
+```python
+# SPDX-FileCopyrightText: 2026 Your Name
+#
+# SPDX-License-Identifier: MIT
+
+# === MANAGED EXPORTS ===
+# This section is automatically generated. Manual edits below this line will be overwritten.
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+from types import MappingProxyType
+
+from lateimport import create_late_getattr
+
+if TYPE_CHECKING:
+    from mypackage.core import MyClass
+    from mypackage.utils import helper_function
+
+_dynamic_imports: MappingProxyType[str, tuple[str, str]] = MappingProxyType({
+    "MyClass": (__spec__.parent, "core"),
+    "helper_function": (__spec__.parent, "utils"),
+})
+
+__getattr__ = create_late_getattr(_dynamic_imports, globals(), __name__)
+
+__all__ = ("MyClass", "helper_function")
+
+def __dir__() -> list[str]:
+    """List available attributes for the package."""
+    return list(__all__)
+```
+
+> [!IMPORTANT]
+> To use exportify for lazy `__init__` management, you must add `lateimport` as a runtime dependency.
+
+## Code Preservation
+
+Add a `# === MANAGED EXPORTS ===` sentinel to an existing `__init__.py` to protect manually written code above it:
+
+```python
+"""My package."""
+
+from .compat import legacy_function  # kept across regeneration
+
+# === MANAGED EXPORTS ===
+# ... generated section below (managed by exportify)
+```
+
+Everything above the sentinel is left untouched on every `fix` or `generate` run.
+
+## CLI Reference
+
+| Command | Description |
+|---------|-------------|
+| `exportify check` | Check exports and `__all__` declarations for consistency |
+| `exportify fix` | Sync exports and `__all__` to match rules |
+| `exportify generate` | Bootstrap new `__init__.py` files for packages missing one |
+| `exportify status` | Show current export/import health status |
+| `exportify doctor` | Run health checks and provide actionable advice |
+| `exportify init` | Initialize exportify with a default config file |
+| `exportify clear-cache` | Clear the analysis cache |
+
+See the [full CLI reference](docs/cli-reference.md) for all flags and options.
+
+## Requirements
+
+- Python 3.12+
+- [`lateimport`](https://pypi.org/project/lateimport/) (installed automatically)
+
+## License
+
+Dual-licensed under MIT and Apache 2.0. See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-Apache-2.0](LICENSE-Apache-2.0).