coil-compiler 0.1.0__tar.gz

coil_compiler-0.1.0/LICENSE

@@ -0,0 +1,200 @@
+                                 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 the 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 the 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 any 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. Please also get an in-depth
+      understanding of the text from the ASF at
+      http://www.apache.org/foundation/license-faq.html
+
+   Copyright 2025 Nathan Curtis
+
+   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.

coil_compiler-0.1.0/PKG-INFO

@@ -0,0 +1,417 @@
+Metadata-Version: 2.4
+Name: coil-compiler
+Version: 0.1.0
+Summary: A Python-to-executable compiler that just works.
+Author: Nathan Curtis
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/nathannncurtis/coil
+Project-URL: Repository, https://github.com/nathannncurtis/coil
+Project-URL: Issues, https://github.com/nathannncurtis/coil/issues
+Keywords: compiler,executable,exe,packaging,distribution
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Compilers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13.0
+Dynamic: license-file
+
+# Coil
+
+![Python](https://img.shields.io/badge/python-3.9%2B-blue)
+![License](https://img.shields.io/badge/license-Apache%202.0-green)
+![Platform](https://img.shields.io/badge/platform-Windows-lightgrey)
+![Version](https://img.shields.io/badge/version-0.1.0-orange)
+
+**A Python-to-executable compiler that just works.**
+
+---
+
+## Why Coil?
+
+Existing tools for turning Python projects into executables — PyInstaller, cx_Freeze, Nuitka, py2exe — all share the same problem: they're complicated. Hidden imports, missing DLLs, spec files, hook scripts, cryptic errors. You spend more time fighting the tool than building your app.
+
+Coil takes a different approach: **directory in, executable out.** Point it at your project folder, and it handles the rest. No spec files. No hook scripts. No per-file configuration.
+
+- Auto-detects entry points
+- Auto-detects dependencies (or reads your requirements.txt)
+- Bundles an embedded Python runtime — no Python installation needed on the target machine
+- Produces a single portable .exe or a clean bundled directory
+- Built-in decompiler to recover your own source if you need it
+
+## Quick Start
+
+```bash
+pip install coil-compiler
+coil init ./myproject        # Generate coil.toml config
+coil build ./myproject       # Build your executable
+```
+
+Or, if `coil` isn't on your PATH:
+
+```bash
+python -m coil init ./myproject
+python -m coil build ./myproject
+```
+
+That's it. Your executable is in `./dist/`.
+
+## Installation
+
+```bash
+pip install coil-compiler
+```
+
+**Requirements:**
+- Python 3.9 or later
+- Windows (macOS and Linux support planned)
+- pip (for dependency installation during builds)
+
+> **Windows note:** If `coil` isn't recognized after install, your pip Scripts directory may not be on PATH. You can either:
+> - Use `python -m coil` instead (works the same way — all examples below apply)
+> - Or add Python's Scripts directory to your PATH (`python -m site --user-site` will show you where it is)
+
+## Usage
+
+### Basic Build
+
+```bash
+# Auto-detect entry point, build portable exe
+coil build ./myproject
+```
+
+### Specify Entry Point
+
+```bash
+coil build ./myproject --entry app.py
+```
+
+### Portable Mode (Default)
+
+Single standalone .exe. Copy it anywhere and run it. No installation needed.
+
+```bash
+coil build ./myproject --mode portable
+```
+
+### Bundled Mode
+
+Directory containing compiled application files. Multiple scripts become multiple compiled files.
+
+```bash
+coil build ./myproject --mode bundled
+```
+
+### GUI Application
+
+Coil auto-detects GUI frameworks. If your project imports `tkinter`, `PyQt5`, `PyQt6`, `PySide2`, `PySide6`, `wx`, `kivy`, `pygame`, `pyglet`, `dearpygui`, `customtkinter`, `flet`, `pystray`, `infi.systray`, or `plyer`, the console window is hidden automatically.
+
+```bash
+# No --gui needed — Coil detects tkinter/PyQt5/etc. and hides the console
+coil build ./myproject
+
+# Force console window even with GUI imports
+coil build ./myproject --console
+
+# Explicitly set GUI mode (redundant if auto-detected, but works)
+coil build ./myproject --gui
+```
+
+### Specify Python Version
+
+```bash
+coil build ./myproject --python 3.12
+```
+
+### Dependency Control
+
+```bash
+# Exclude packages
+coil build ./myproject --exclude numpy,pandas
+
+# Force-include packages
+coil build ./myproject --include extra-lib
+
+# Use a specific requirements file
+coil build ./myproject --requirements ./reqs.txt
+```
+
+### Multiple Entry Points
+
+Each entry point produces its own executable:
+
+```bash
+coil build ./myproject --entry cli.py --entry gui.py --mode bundled
+```
+
+### Secure Build
+
+Heavy obfuscation. Cannot be reversed by `coil decompile`:
+
+```bash
+coil build ./myproject --secure
+```
+
+### Decompile
+
+Recover source from a default (non-secure) Coil build:
+
+```bash
+coil decompile ./dist/MyApp.exe --output ./recovered
+```
+
+Secure builds cannot be decompiled.
+
+### Clean Build
+
+Build in an isolated environment with only declared dependencies. Guarantees reproducible builds:
+
+```bash
+coil build ./myproject --clean
+```
+
+The clean environment is cached — subsequent builds reuse it if dependencies haven't changed.
+
+### Project Setup
+
+Generate a `coil.toml` config file for your project:
+
+```bash
+coil init ./myproject
+```
+
+This asks a few questions (entry point, console/GUI, icon) and writes a `coil.toml` with sensible defaults. After that, `coil build ./myproject` uses the config automatically — no flags needed.
+
+### Build Profiles
+
+Define named profiles in `coil.toml` for different build scenarios:
+
+```toml
+[profile.dev]
+mode = "bundled"
+secure = false
+verbose = true
+
+[profile.release]
+mode = "portable"
+secure = true
+```
+
+Switch between them with `--profile`:
+
+```bash
+coil build ./myproject --profile dev
+coil build ./myproject --profile release
+```
+
+CLI flags always override profile settings.
+
+### Pre-Build Diagnostics
+
+Check for problems before building:
+
+```bash
+coil doctor ./myproject
+```
+
+Checks Python version, runtime availability, write permissions, config validity, and known package issues.
+
+### Build Preview
+
+See what Coil will include in a build without building:
+
+```bash
+coil inspect ./myproject
+```
+
+Shows entry point, dependencies (stdlib vs third-party), estimated output size, and config.
+
+### Dry Run
+
+See what would be built without building:
+
+```bash
+coil build ./myproject --dry-run --verbose
+```
+
+### Full Example
+
+```bash
+coil build ./myproject \
+  --entry main.py \
+  --mode portable \
+  --os windows \
+  --python 3.12 \
+  --gui \
+  --secure \
+  --exclude numpy,pandas \
+  --output ./dist \
+  --name MyApp \
+  --icon ./assets/icon.ico
+```
+
+## How It Works
+
+1. **Dependency Resolution** — Coil checks for a `requirements.txt` or `pyproject.toml`. If neither exists, it scans every `.py` file using Python's `ast` module to find all imports, separates stdlib from third-party, and resolves import names to PyPI packages.
+
+2. **Runtime Bundling** — Downloads the official Windows embeddable Python distribution matching your target version. No C compiler needed.
+
+3. **Compilation** — All `.py` files are compiled to `.pyc` bytecode. No loose `.py` files in the output.
+
+4. **Packaging** — In portable mode, everything is packed into a single `.exe` file. In bundled mode, a clean directory with the runtime, compiled code, and dependencies.
+
+### Portable Mode Details
+
+The portable `.exe` is a single file you can copy anywhere and run. Here's what happens under the hood:
+
+- **You distribute one file.** The `.exe` contains a lightweight native launcher (~23 KB) with the full application payload appended.
+- **First launch** extracts the runtime to a local cache (`%LOCALAPPDATA%\coil\<app>\<build_hash>\`). This is a one-time operation.
+- **Subsequent launches** detect the cache and start instantly — no extraction needed.
+- **Each build gets a unique hash.** Rebuilding your app creates a new cache entry. Old cache entries are automatically cleaned up (only the 3 most recent are kept).
+- **Cache safety:** Extraction uses file locking to prevent corruption if multiple instances launch simultaneously. A marker file ensures only fully-extracted caches are used — if extraction is interrupted, it will restart cleanly.
+
+To manage the cache manually:
+
+```bash
+coil cache info     # Show cache location and size
+coil cache clear    # Delete all cached runtimes
+```
+
+> **Tip:** If you have a `requirements.txt` or `pyproject.toml`, Coil uses that instead of scanning imports. This is faster and more reliable.
+
+## Configuration (`coil.toml`)
+
+Run `coil init` to generate a config file, or create one manually:
+
+```toml
+[project]
+entry = "main.py"
+name = "MyApp"
+
+[build]
+mode = "portable"
+os = "windows"
+console = true
+python = "3.12"
+clean = false
+
+[build.dependencies]
+# Coil resolves deps automatically from requirements.txt or AST scan
+auto = true
+exclude = []
+include = []
+
+[build.output]
+dir = "./dist"
+icon = ""
+
+# Profiles override [build] settings
+# [profile.dev]
+# mode = "bundled"
+# secure = false
+# verbose = true
+
+# [profile.release]
+# mode = "portable"
+# secure = true
+```
+
+**Priority order:** CLI flags > profile values > `[build]` values > defaults.
+
+## CLI Reference
+
+### Subcommands
+
+| Command | Description |
+|---------|-------------|
+| `coil build <project>` | Build a Python project into an executable |
+| `coil init [project]` | Generate a coil.toml config file |
+| `coil doctor [project]` | Run pre-build diagnostics |
+| `coil inspect [project]` | Preview what Coil will include in a build |
+| `coil decompile <exe>` | Recover source from a default Coil build |
+| `coil cache info` | Show cache location and size |
+| `coil cache clear` | Delete all cached runtimes |
+
+### Build Flags
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--entry` | Auto-detect (`__main__.py` then `main.py`) | Entry point script relative to project dir |
+| `--mode` | `portable` | `portable` (single exe) or `bundled` (directory) |
+| `--os` | Current OS | `windows`, `macos`, `linux` |
+| `--python` | Auto-detect | Target Python version |
+| `--gui` | `false` | Suppress console window |
+| `--console` | `true` | Show console window (default) |
+| `--secure` | `false` | Heavy obfuscation, not reversible |
+| `--clean` | `false` | Build in clean environment with only declared deps |
+| `--profile` | None | Build profile from coil.toml |
+| `--exclude` | None | Comma-separated packages to exclude |
+| `--include` | None | Comma-separated packages to force-include |
+| `--output` | `./dist` | Output directory |
+| `--name` | Project dir name | Output executable name |
+| `--icon` | None | Icon file path (.ico) |
+| `--requirements` | Auto-detect | Path to requirements.txt or pyproject.toml |
+| `--verbose` | `false` | Detailed build output |
+| `--dry-run` | `false` | Preview build without executing |
+
+## Obfuscation
+
+**Default mode:** Source is compiled to bytecode and packaged with metadata that `coil decompile` can use to recover the original `.py` files. This is a safety net — not cryptographic security, but your source isn't casually visible.
+
+**Secure mode (`--secure`):** Bytecode only, debug info stripped, no recovery metadata. `coil decompile` will refuse to process it. This is stronger but not impenetrable — no bytecode obfuscation is NSA-proof. It's meant to raise the bar, not guarantee secrecy.
+
+## FAQ
+
+**Q: Does Coil require Python on the target machine?**
+No. Coil bundles an embedded Python runtime. The resulting executable is fully standalone.
+
+**Q: What about C extensions / native modules?**
+Coil bundles `.pyd` / `.dll` files from installed packages. Most packages with C extensions work out of the box.
+
+**Q: How big are the executables?**
+A minimal project produces an exe around 15-20 MB (mostly the Python runtime). Dependencies add to that. Coil strips unnecessary files to keep size reasonable.
+
+**Q: Can I cross-compile for other platforms?**
+Not yet. Currently Coil only builds Windows executables on Windows. Cross-platform and cross-compilation are on the roadmap.
+
+**Q: What's the difference between portable and bundled?**
+Portable = single `.exe` file you can copy anywhere. On first launch, it extracts the runtime to a local cache and runs from there. Later launches reuse the cache and start instantly. Bundled = directory with the executable and its supporting files. No extraction step — it runs directly from the directory.
+
+**Q: Where does the portable exe store its cache?**
+`%LOCALAPPDATA%\coil\<AppName>\<build_hash>\`. Run `coil cache info` to see details, or `coil cache clear` to remove it. If `%LOCALAPPDATA%` isn't available, it falls back to `%TEMP%` or the exe's own directory.
+
+**Q: Is the portable exe really a single file?**
+Yes. The build output is a single `.exe`. On first run, it extracts a cached copy of the runtime to a local directory. This is not visible to the user as a separate step — the app just starts. Subsequent runs skip extraction entirely.
+
+## Roadmap
+
+- macOS .app support
+- Linux ELF binary support
+- ARM64 bootloader for Windows on ARM
+- Cross-compilation
+- Optional runtime signing (helps with AV false positives)
+
+## Contributing
+
+Contributions welcome. Open an issue or submit a pull request.
+
+```bash
+# Development setup
+git clone https://github.com/nathannncurtis/coil.git
+cd coil
+pip install -e .
+python -m pytest
+```
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) for the full text.