static-php-py 0.1.0__py3-none-win_amd64.whl

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,732 @@
1
+ Metadata-Version: 2.4
2
+ Name: static-php-py
3
+ Version: 0.1.0
4
+ Summary: Python wrapper library for static PHP binaries with pre-built distribution support crazywhalecc/static-php-cli
5
+ Project-URL: Homepage, https://github.com/samhsu-dev/static-php-py
6
+ Project-URL: Repository, https://github.com/samhsu-dev/static-php-py
7
+ Project-URL: Issues, https://github.com/samhsu-dev/static-php-py/issues
8
+ Author: static-php-py contributors
9
+ License: GNU GENERAL PUBLIC LICENSE
10
+ Version 2, June 1991
11
+
12
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
13
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
14
+ Everyone is permitted to copy and distribute verbatim copies
15
+ of this license document, but changing it is not allowed.
16
+
17
+ Preamble
18
+
19
+ The licenses for most software are designed to take away your
20
+ freedom to share and change it. By contrast, the GNU General Public
21
+ License is intended to guarantee your freedom to share and change free
22
+ software--to make sure the software is free for all its users. This
23
+ General Public License applies to most of the Free Software
24
+ Foundation's software and to any other program whose authors commit to
25
+ using it. (Some other Free Software Foundation software is covered by
26
+ the GNU Lesser General Public License instead.) You can apply it to
27
+ your programs, too.
28
+
29
+ When we speak of free software, we are referring to freedom, not
30
+ price. Our General Public Licenses are designed to make sure that you
31
+ have the freedom to distribute copies of free software (and charge for
32
+ this service if you wish), that you receive source code or can get it
33
+ if you want it, that you can change the software or use pieces of it
34
+ in new free programs; and that you know you can do these things.
35
+
36
+ To protect your rights, we need to make restrictions that forbid
37
+ anyone to deny you these rights or to ask you to surrender the rights.
38
+ These restrictions translate to certain responsibilities for you if you
39
+ distribute copies of the software, or if you modify it.
40
+
41
+ For example, if you distribute copies of such a program, whether
42
+ gratis or for a fee, you must give the recipients all the rights that
43
+ you have. You must make sure that they, too, receive or can get the
44
+ source code. And you must show them these terms so they know their
45
+ rights.
46
+
47
+ We protect your rights with two steps: (1) copyright the software, and
48
+ (2) offer you this license which gives you legal permission to copy,
49
+ distribute and/or modify the software.
50
+
51
+ Also, for each author's protection and ours, we want to make certain
52
+ that everyone understands that there is no warranty for this free
53
+ software. If the software is modified by someone else and passed on, we
54
+ want its recipients to know that what they have is not the original, so
55
+ that any problems introduced by others will not reflect on the original
56
+ authors' reputations.
57
+
58
+ Finally, any free program is threatened constantly by software
59
+ patents. We wish to avoid the danger that redistributors of a free
60
+ program will individually obtain patent licenses, in effect making the
61
+ program proprietary. To prevent this, we have made it clear that any
62
+ patent must be licensed for everyone's free use or not licensed at all.
63
+
64
+ The precise terms and conditions for copying, distribution and
65
+ modification follow.
66
+
67
+ GNU GENERAL PUBLIC LICENSE
68
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
69
+
70
+ 0. This License applies to any program or other work which contains
71
+ a notice placed by the copyright holder saying it may be distributed
72
+ under the terms of this General Public License. The "Program", below,
73
+ refers to any such program or work, and a "work based on the Program"
74
+ means either the Program or any derivative work under copyright law:
75
+ that is to say, a work containing the Program or a portion of it,
76
+ either verbatim or with modifications and/or translated into another
77
+ language. (Hereinafter, translation is included without limitation in
78
+ the term "modification".) Each licensee is addressed as "you".
79
+
80
+ Activities other than copying, distribution and modification are not
81
+ covered by this License; they are outside its scope. The act of
82
+ running the Program is not restricted, and the output from the Program
83
+ is covered only if its contents constitute a work based on the
84
+ Program (independent of having been made by running the Program).
85
+ Whether that is true depends on what the Program does.
86
+
87
+ 1. You may copy and distribute verbatim copies of the Program's
88
+ source code as you receive it, in any medium, provided that you
89
+ conspicuously and appropriately publish on each copy an appropriate
90
+ copyright notice and disclaimer of warranty; keep intact all the
91
+ notices that refer to this License and to the absence of any warranty;
92
+ and give any other recipients of the Program a copy of this License
93
+ along with the Program.
94
+
95
+ You may charge a fee for the physical act of transferring a copy, and
96
+ you may at your option offer warranty protection in exchange for a fee.
97
+
98
+ 2. You may modify your copy or copies of the Program or any portion
99
+ of it, thus forming a work based on the Program, and copy and
100
+ distribute such modifications or work under the terms of Section 1
101
+ above, provided that you also meet all of these conditions:
102
+
103
+ a) You must cause the modified files to carry prominent notices
104
+ stating that you changed the files and the date of any change.
105
+
106
+ b) You must cause any work that you distribute or publish, that in
107
+ whole or in part contains or is derived from the Program or any
108
+ part thereof, to be licensed as a whole at no charge to all third
109
+ parties under the terms of this License.
110
+
111
+ c) If the modified program normally reads commands interactively
112
+ when run, you must cause it, when started running for such
113
+ interactive use in the most ordinary way, to print or display an
114
+ announcement including an appropriate copyright notice and a
115
+ notice that there is no warranty (or else, saying that you provide
116
+ a warranty) and that users may redistribute the program under
117
+ these conditions, and telling the user how to view a copy of this
118
+ License. (Exception: if the Program itself is interactive but
119
+ does not normally print such an announcement, your work based on
120
+ the Program is not required to print an announcement.)
121
+
122
+ These requirements apply to the modified work as a whole. If
123
+ identifiable sections of that work are not derived from the Program,
124
+ and can be reasonably considered independent and separate works in
125
+ themselves, then this License, and its terms, do not apply to those
126
+ sections when you distribute them as separate works. But when you
127
+ distribute the same sections as part of a whole which is a work based
128
+ on the Program, the distribution of the whole must be on the terms of
129
+ this License, whose permissions for other licensees extend to the
130
+ entire whole, and thus to each and every part regardless of who wrote it.
131
+
132
+ Thus, it is not the intent of this section to claim rights or contest
133
+ your rights to work written entirely by you; rather, the intent is to
134
+ exercise the right to control the distribution of derivative or
135
+ collective works based on the Program.
136
+
137
+ In addition, mere aggregation of another work not based on the Program
138
+ with the Program (or with a work based on the Program) on a volume of
139
+ a storage or distribution medium does not bring the other work under
140
+ the scope of this License.
141
+
142
+ 3. You may copy and distribute the Program (or a work based on it,
143
+ under Section 2) in object code or executable form under the terms of
144
+ Sections 1 and 2 above provided that you also do one of the following:
145
+
146
+ a) Accompany it with the complete corresponding machine-readable
147
+ source code, which must be distributed under the terms of Sections
148
+ 1 and 2 above on a medium customarily used for software interchange; or,
149
+
150
+ b) Accompany it with a written offer, valid for at least three
151
+ years, to give any third party, for a charge no more than your
152
+ cost of physically performing source distribution, a complete
153
+ machine-readable copy of the corresponding source code, to be
154
+ distributed under the terms of Sections 1 and 2 above on a medium
155
+ customarily used for software interchange; or,
156
+
157
+ c) Accompany it with the information you received as to the offer
158
+ to distribute corresponding source code. (This alternative is
159
+ allowed only for noncommercial distribution and only if you
160
+ received the program in object code or executable form with such
161
+ an offer, in accord with Subsection b above.)
162
+
163
+ The source code for a work means the preferred form of the work for
164
+ making modifications to it. For an executable work, complete source
165
+ code means all the source code for all modules it contains, plus any
166
+ associated interface definition files, plus the scripts used to
167
+ control compilation and installation of the executable. However, as a
168
+ special exception, the source code distributed need not include
169
+ anything that is normally distributed (in either source or binary
170
+ form) with the major components (compiler, kernel, and so on) of the
171
+ operating system on which the executable runs, unless that component
172
+ itself accompanies the executable.
173
+
174
+ If distribution of executable or object code is made by offering
175
+ access to copy from a designated place, then offering equivalent
176
+ access to copy the source code from the same place counts as
177
+ distribution of the source code, even though third parties are not
178
+ compelled to copy the source along with the object code.
179
+
180
+ 4. You may not copy, modify, sublicense, or distribute the Program
181
+ except as expressly provided under this License. Any attempt
182
+ otherwise to copy, modify, sublicense or distribute the Program is
183
+ void, and will automatically terminate your rights under this License.
184
+ However, parties who have received copies, or rights, from you under
185
+ this License will not have their licenses terminated so long as such
186
+ parties remain in full compliance.
187
+
188
+ 5. You are not required to accept this License, since you have not
189
+ signed it. However, nothing else grants you permission to modify or
190
+ distribute the Program or its derivative works. These actions are
191
+ prohibited by law if you do not accept this License. Therefore, by
192
+ modifying or distributing the Program (or any work based on the
193
+ Program), you indicate your acceptance of this License to do so, and
194
+ all its terms and conditions for copying, distributing or modifying
195
+ the Program or works based on it.
196
+
197
+ 6. Each time you redistribute the Program (or any work based on the
198
+ Program), the recipient automatically receives a license from the
199
+ original licensor to copy, distribute or modify the Program subject to
200
+ these terms and conditions. You may not impose any further
201
+ restrictions on the recipients' exercise of the rights granted herein.
202
+ You are not responsible for enforcing compliance by third parties to
203
+ this License.
204
+
205
+ 7. If, as a consequence of a court judgment or allegation of patent
206
+ infringement or for any other reason (not limited to patent issues),
207
+ conditions are imposed on you (whether by court order, agreement or
208
+ otherwise) that contradict the conditions of this License, they do not
209
+ excuse you from the conditions of this License. If you cannot
210
+ distribute so as to satisfy simultaneously your obligations under this
211
+ License and any other pertinent obligations, then as a consequence you
212
+ may not distribute the Program at all. For example, if a patent
213
+ license would not permit royalty-free redistribution of the Program by
214
+ all those who receive copies directly or indirectly through you, then
215
+ the only way you could satisfy both it and this License would be to
216
+ refrain entirely from distribution of the Program.
217
+
218
+ If any portion of this section is held invalid or unenforceable under
219
+ any particular circumstance, the balance of the section is intended to
220
+ apply and the section as a whole is intended to apply in other
221
+ circumstances.
222
+
223
+ It is not the purpose of this section to induce you to infringe any
224
+ patents or other property right claims or to contest validity of any
225
+ such claims; this section has the sole purpose of protecting the
226
+ integrity of the free software distribution system, which is
227
+ implemented by public license practices. Many people have made
228
+ generous contributions to the wide range of software distributed
229
+ through that system in reliance on consistent application of that
230
+ system; it is up to the author/donor to decide if he or she is willing
231
+ to distribute software through any other system and a licensee cannot
232
+ impose that choice.
233
+
234
+ This section is intended to make thoroughly clear what is believed to
235
+ be a consequence of the rest of this License.
236
+
237
+ 8. If the distribution and/or use of the Program is restricted in
238
+ certain countries either by patents or by copyrighted interfaces, the
239
+ original copyright holder who places the Program under this License
240
+ may add an explicit geographical distribution limitation excluding
241
+ those countries, so that distribution is permitted only in or among
242
+ countries not thus excluded. In such case, this License incorporates
243
+ the limitation as if written in the body of this License.
244
+
245
+ 9. The Free Software Foundation may publish revised and/or new versions
246
+ of the General Public License from time to time. Such new versions will
247
+ be similar in spirit to the present version, but may differ in detail to
248
+ address new problems or concerns.
249
+
250
+ Each version is given a distinguishing version number. If the Program
251
+ specifies a version number of this License which applies to it and "any
252
+ later version", you have the option of following the terms and conditions
253
+ either of that version or of any later version published by the Free
254
+ Software Foundation. If the Program does not specify a version number of
255
+ this License, you may choose any version ever published by the Free Software
256
+ Foundation.
257
+
258
+ 10. If you wish to incorporate parts of the Program into other free
259
+ programs whose distribution conditions are different, write to the author
260
+ to ask for permission. For software which is copyrighted by the Free
261
+ Software Foundation, write to the Free Software Foundation; we sometimes
262
+ make exceptions for this. Our decision will be guided by the two goals
263
+ of preserving the free status of all derivatives of our free software and
264
+ of promoting the sharing and reuse of software generally.
265
+
266
+ NO WARRANTY
267
+
268
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
269
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
270
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
271
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
272
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
273
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
274
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
275
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
276
+ REPAIR OR CORRECTION.
277
+
278
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
279
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
280
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
281
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
282
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
283
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
284
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
285
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
286
+ POSSIBILITY OF SUCH DAMAGES.
287
+
288
+ END OF TERMS AND CONDITIONS
289
+
290
+ How to Apply These Terms to Your New Programs
291
+
292
+ If you develop a new program, and you want it to be of the greatest
293
+ possible use to the public, the best way to achieve this is to make it
294
+ free software which everyone can redistribute and change under these terms.
295
+
296
+ To do so, attach the following notices to the program. It is safest
297
+ to attach them to the start of each source file to most effectively
298
+ convey the exclusion of warranty; and each file should have at least
299
+ the "copyright" line and a pointer to where the full notice is found.
300
+
301
+ <one line to give the program's name and a brief idea of what it does.>
302
+ Copyright (C) <year> <name of author>
303
+
304
+ This program is free software; you can redistribute it and/or modify
305
+ it under the terms of the GNU General Public License as published by
306
+ the Free Software Foundation; either version 2 of the License, or
307
+ (at your option) any later version.
308
+
309
+ This program is distributed in the hope that it will be useful,
310
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
311
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
312
+ GNU General Public License for more details.
313
+
314
+ You should have received a copy of the GNU General Public License along
315
+ with this program; if not, write to the Free Software Foundation, Inc.,
316
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
317
+
318
+ Also add information on how to contact you by electronic and paper mail.
319
+
320
+ If the program is interactive, make it output a short notice like this
321
+ when it starts in an interactive mode:
322
+
323
+ Gnomovision version 69, Copyright (C) year name of author
324
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
325
+ This is free software, and you are welcome to redistribute it
326
+ under certain conditions; type `show c' for details.
327
+
328
+ The hypothetical commands `show w' and `show c' should show the appropriate
329
+ parts of the General Public License. Of course, the commands you use may
330
+ be called something other than `show w' and `show c'; they could even be
331
+ mouse-clicks or menu items--whatever suits your program.
332
+
333
+ You should also get your employer (if you work as a programmer) or your
334
+ school, if any, to sign a "copyright disclaimer" for the program, if
335
+ necessary. Here is a sample; alter the names:
336
+
337
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
338
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
339
+
340
+ <signature of Ty Coon>, 1 April 1989
341
+ Ty Coon, President of Vice
342
+
343
+ This General Public License does not permit incorporating your program into
344
+ proprietary programs. If your program is a subroutine library, you may
345
+ consider it more useful to permit linking proprietary applications with the
346
+ library. If this is what you want to do, use the GNU Lesser General
347
+ Public License instead of this License.
348
+ License-File: LICENSE
349
+ Keywords: binary,php,static-php-cli,wrapper
350
+ Classifier: Development Status :: 3 - Alpha
351
+ Classifier: Intended Audience :: Developers
352
+ Classifier: License :: OSI Approved :: Apache Software License
353
+ Classifier: Programming Language :: Python :: 3
354
+ Classifier: Programming Language :: Python :: 3.9
355
+ Classifier: Programming Language :: Python :: 3.10
356
+ Classifier: Programming Language :: Python :: 3.11
357
+ Classifier: Programming Language :: Python :: 3.12
358
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
359
+ Requires-Python: >=3.9
360
+ Requires-Dist: platformdirs>=4.0.0
361
+ Description-Content-Type: text/markdown
362
+
363
+ # static-php-py
364
+
365
+ Python wrapper library for [static-php-cli](https://github.com/crazywhalecc/static-php-cli), inspired by the static-php-cli project with pre-built binary distribution support.
366
+
367
+ ## Features
368
+
369
+ - **Zero-configuration PHP execution**: Install and run PHP scripts immediately
370
+ - **Pre-built static binaries**: No compilation required, binaries from static-php-cli 2.7.10
371
+ - **Platform-specific wheels**: Automatic platform detection via pip
372
+ - **Flexible installation**: Choose between API-only or bundled binary
373
+ - **Remote binary support**: Download and cache PHP binaries from custom URLs
374
+ - **Type-safe API**: Full type hints for better IDE support
375
+
376
+ ## Installation
377
+
378
+ ### Light (API only)
379
+ ```bash
380
+ pip install static-php-py
381
+ ```
382
+
383
+ Requires PHP available in system PATH or explicit binary path.
384
+
385
+ ### Installation
386
+
387
+ ```bash
388
+ pip install static-php-py
389
+ ```
390
+
391
+ Pip automatically selects the appropriate wheel for your platform. Platform-specific wheels include pre-built PHP binaries.
392
+
393
+ Includes pre-built PHP 8.3 binary for your platform (Linux x86_64/aarch64, macOS x86_64/arm64, Windows x64).
394
+
395
+ ### Development
396
+ ```bash
397
+ # Clone repository
398
+ git clone https://github.com/samhsu-dev/static-php-py.git
399
+ cd static-php-py
400
+
401
+ # Create virtual environment with uv
402
+ uv venv
403
+ source .venv/bin/activate # or `.venv\Scripts\activate` on Windows
404
+
405
+ # Install with dev dependencies (includes Jupyter for demo notebook)
406
+ uv pip install -e ".[dev]"
407
+
408
+ # Register Jupyter kernel (optional, for running demo.ipynb)
409
+ python -m ipykernel install --user --name=static-php-py --display-name="static-php-py (.venv)"
410
+ ```
411
+
412
+ ## Quick Start
413
+
414
+ ### Basic Usage
415
+
416
+ ```python
417
+ from static_php_py import PHP
418
+
419
+ # Use built-in PHP binary (from platform-specific wheel)
420
+ php = PHP.builtin()
421
+
422
+ # Or use local PHP binary
423
+ php = PHP.local("/usr/bin/php")
424
+
425
+ # Or download from remote URL
426
+ php = PHP.remote("https://example.com/php-8.4.zip")
427
+
428
+ # Execute PHP script
429
+ result = php.run("script.php")
430
+ if result.success:
431
+ print(result.stdout)
432
+ else:
433
+ print(f"Error: {result.stderr}")
434
+
435
+ # Evaluate PHP code
436
+ result = php.eval("echo 'Hello from PHP!';")
437
+ print(result.stdout) # Hello from PHP!
438
+
439
+ # Get PHP version
440
+ print(php.version()) # 8.4.0
441
+
442
+ # Get PHP binary path
443
+ print(php.path()) # /path/to/php
444
+ ```
445
+
446
+ ## Usage
447
+
448
+ ### Load Local PHP Binary
449
+
450
+ ```python
451
+ from static_php_py import PHP
452
+
453
+ # Use local PHP binary with string path
454
+ php = PHP.local("/usr/local/bin/php")
455
+ result = php.run("script.php")
456
+
457
+ # Or use Path object
458
+ from pathlib import Path
459
+ php = PHP.local(Path("/usr/local/bin/php"))
460
+ ```
461
+
462
+ ### Download Remote PHP Binary
463
+
464
+ ```python
465
+ from static_php_py import PHP
466
+
467
+ # Download binary directly
468
+ php = PHP.remote("https://example.com/php-8.4-cli")
469
+
470
+ # Download and extract archive (tar.gz, tgz, or zip)
471
+ php = PHP.remote("https://example.com/php-8.4.tar.gz")
472
+ php = PHP.remote("https://example.com/php-8.4.zip")
473
+
474
+ # Force re-download (ignore cache)
475
+ php = PHP.remote("https://example.com/php.tar.gz", force=True)
476
+
477
+ # Custom timeout (default: 300 seconds)
478
+ php = PHP.remote("https://example.com/php.tar.gz", timeout=600.0)
479
+ ```
480
+
481
+ ### Execute PHP Scripts
482
+
483
+ ```python
484
+ from static_php_py import PHP
485
+
486
+ php = PHP.builtin()
487
+
488
+ # Run script with arguments
489
+ result = php.run("script.php", args=["--verbose", "--debug"])
490
+
491
+ # Run with timeout
492
+ result = php.run("long_script.php", timeout=30.0)
493
+
494
+ # Check result
495
+ if result.success:
496
+ print(f"Output: {result.stdout}")
497
+ else:
498
+ print(f"Error (code {result.return_code}): {result.stderr}")
499
+ ```
500
+
501
+ ### Evaluate PHP Code
502
+
503
+ ```python
504
+ from static_php_py import PHP
505
+
506
+ php = PHP.builtin()
507
+
508
+ # Evaluate PHP code string
509
+ result = php.eval("echo 2 + 2;") # Output: 4
510
+ print(result.stdout)
511
+
512
+ # With timeout
513
+ result = php.eval("sleep(5); echo 'Done';", timeout=10.0)
514
+ ```
515
+
516
+ ### Exception Handling
517
+
518
+ ```python
519
+ from static_php_py import PHP
520
+ from static_php_py.exceptions import (
521
+ BinaryNotFoundError,
522
+ DownloadError,
523
+ ExecutionError,
524
+ InvalidArchiveError,
525
+ )
526
+
527
+ # Handle binary not found
528
+ try:
529
+ php = PHP.builtin()
530
+ except BinaryNotFoundError:
531
+ print("PHP binary not found. Install platform-specific wheel or use PHP.local(path).")
532
+
533
+ # Handle download errors
534
+ try:
535
+ php = PHP.remote("https://example.com/php.zip")
536
+ except DownloadError as e:
537
+ print(f"Download failed: {e}")
538
+ except InvalidArchiveError as e:
539
+ print(f"Invalid archive: {e}")
540
+
541
+ # Handle execution errors
542
+ try:
543
+ result = php.run("script.php")
544
+ except ExecutionError as e:
545
+ print(f"Execution failed: {e}")
546
+ ```
547
+
548
+ ## API Reference
549
+
550
+ ### PHP Class
551
+
552
+ #### Static Methods
553
+
554
+ ##### `PHP.builtin() -> PHP`
555
+
556
+ Load built-in PHP binary from package resources.
557
+
558
+ **Returns:** `PHP` instance
559
+
560
+ **Raises:** `BinaryNotFoundError` if built-in binary not found (not installed via platform-specific wheel)
561
+
562
+ ##### `PHP.local(path: Path | str) -> PHP`
563
+
564
+ Load PHP binary from local file system path.
565
+
566
+ **Parameters:**
567
+ - `path`: Path to PHP binary (required, string or Path object)
568
+
569
+ **Returns:** `PHP` instance
570
+
571
+ **Raises:** `BinaryNotFoundError` if binary not found at specified path
572
+
573
+ ##### `PHP.remote(url: str, force: bool = False, timeout: float = 300.0) -> PHP`
574
+
575
+ Download PHP binary from remote URL and return PHP instance.
576
+
577
+ **Parameters:**
578
+ - `url`: Remote URL to PHP binary or archive (tar.gz, tgz, or zip)
579
+ - `force`: Force re-download ignoring cache (default: False)
580
+ - `timeout`: Download timeout in seconds (default: 300.0)
581
+
582
+ **Returns:** `PHP` instance
583
+
584
+ **Raises:** `DownloadError` on network failure, `InvalidArchiveError` on archive error
585
+
586
+ #### Instance Methods
587
+
588
+ - `run(script: Path | str, args: list[str] | None = None, timeout: float | None = None) -> ExecutionResult`
589
+ - `eval(code: str, timeout: float | None = None) -> ExecutionResult`
590
+ - `version() -> str`
591
+ - `path() -> Path`
592
+
593
+ #### `ExecutionResult`
594
+
595
+ Result of PHP script execution.
596
+
597
+ **Properties:**
598
+ - `success: bool` - True if exit code is 0
599
+ - `return_code: int` - Process exit code
600
+ - `stdout: str` - Standard output
601
+ - `stderr: str` - Standard error
602
+
603
+ ### Exceptions
604
+
605
+ - `PHPError` - Base exception for all static-php-py errors
606
+ - `BinaryNotFoundError` - PHP binary not found
607
+ - `ExecutionError` - PHP execution failure
608
+ - `DownloadError` - Network/download failure
609
+ - `InvalidArchiveError` - Invalid tar.gz archive
610
+
611
+ ## Project Structure
612
+
613
+ ```
614
+ static-php-py/
615
+ ├── static_php_py/ # Main package
616
+ │ ├── __init__.py # Public API exports
617
+ │ ├── exceptions.py # Exception classes
618
+ │ ├── php.py # PHP class (includes create, download, cache_dir)
619
+ │ ├── models.py # ExecutionResult model
620
+ │ └── providers.py # Internal providers
621
+ ├── resources/ # Resources package (PHP binaries)
622
+ │ ├── __init__.py
623
+ │ └── pyproject.toml
624
+ ├── scripts/ # Build scripts
625
+ │ └── build_binaries.py # Binary wheel builder
626
+ ├── tests/ # Test suite
627
+ │ ├── test_exceptions.py
628
+ │ ├── test_factory.py
629
+ │ ├── test_integration.py
630
+ │ ├── test_models.py
631
+ │ ├── test_php.py
632
+ │ └── test_providers.py
633
+ ├── docs/ # Documentation
634
+ │ ├── idea.md # Architecture concepts
635
+ │ ├── design.md # Detailed design specification
636
+ │ └── todo.md # Implementation tasks
637
+ ├── pyproject.toml # Project configuration
638
+ └── README.md # This file
639
+ ```
640
+
641
+ ## Development
642
+
643
+ ### Run Tests
644
+ ```bash
645
+ pytest tests/ -v
646
+ ```
647
+
648
+ ### Code Quality
649
+ ```bash
650
+ # Linting
651
+ ruff check static_php_py/
652
+
653
+ # Formatting
654
+ ruff format static_php_py/ tests/
655
+
656
+ # Type checking
657
+ mypy static_php_py/
658
+ ```
659
+
660
+ ### Interactive Demo
661
+ ```bash
662
+ # Open the demo notebook
663
+ jupyter notebook docs/demo.ipynb
664
+ # or
665
+ jupyter lab docs/demo.ipynb
666
+ ```
667
+
668
+ The demo notebook (`docs/demo.ipynb`) demonstrates all public APIs with interactive examples.
669
+
670
+ ## Troubleshooting
671
+
672
+ ### PHP Binary Not Found
673
+
674
+ If you get `BinaryNotFoundError`:
675
+
676
+ 1. **Ensure platform-specific wheel is installed:**
677
+ ```bash
678
+ pip install --force-reinstall static-php-py
679
+ ```
680
+
681
+ 2. **Or specify explicit path:**
682
+ ```python
683
+ php = PHP.create(path="/usr/bin/php")
684
+ ```
685
+
686
+ 3. **Or ensure PHP is in system PATH:**
687
+ ```bash
688
+ which php # Check if PHP is available
689
+ ```
690
+
691
+ ### Download Failures
692
+
693
+ If `download()` fails:
694
+
695
+ - Check network connectivity
696
+ - Verify URL is accessible
697
+ - Try with `force=True` to bypass cache
698
+ - Increase `timeout` for slow connections
699
+
700
+ ### Archive Extraction Errors
701
+
702
+ If `InvalidArchiveError` is raised:
703
+
704
+ - Verify URL points to valid tar.gz file
705
+ - Check archive contains `php` executable
706
+ - Ensure archive is not corrupted
707
+
708
+ ## Architecture
709
+
710
+ For detailed architecture and design information, see:
711
+ - [Architecture Concepts](docs/idea.md)
712
+ - [Design Specification](docs/design.md)
713
+ - [API Demo Notebook](docs/demo.ipynb) - Interactive examples of all APIs
714
+
715
+ ## Publishing
716
+
717
+ For information on publishing to PyPI, see:
718
+ - [Publishing Guide](docs/PUBLISHING.md) - Instructions for publishing to Test PyPI and production PyPI
719
+
720
+ ## Status
721
+
722
+ ✅ Phase 1-8: Complete
723
+ ⏳ Phase 9: CI/CD and Publishing (in progress)
724
+
725
+ ## License
726
+
727
+ Apache License 2.0 - See [LICENSE](LICENSE) file for details.
728
+
729
+ ## Acknowledgments
730
+
731
+ - [static-php-cli](https://github.com/crazywhalecc/static-php-cli) - Inspiration and pre-built PHP binaries source
732
+ - Project maintained by [samhsu-dev](https://github.com/samhsu-dev)