Skip to content

Commit 8ca7768

Browse files
omaralalwiomaralalwi
committed
first commit
0 parents  commit 8ca7768

17 files changed

+955
-0
lines changed

‎CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to `php-py` will be documented in this file
4+
5+
## 1.0.0 - 201X-XX-XX
6+
7+
- initial release

‎CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Etiquette
8+
9+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11+
extremely unfair for them to suffer abuse or anger for their hard work.
12+
13+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14+
world that developers are civilized and selfless people.
15+
16+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17+
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
18+
19+
## Viability
20+
21+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23+
whether or not your feature is likely to be used by other users of the project.
24+
25+
## Procedure
26+
27+
Before filing an issue:
28+
29+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30+
- Check to make sure your feature suggestion isn't already present within the project.
31+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33+
34+
Before submitting a pull request:
35+
36+
- Check the codebase to ensure that your feature doesn't already exist.
37+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38+
39+
## Requirements
40+
41+
If the project maintainer has any additional requirements, you will find them listed here.
42+
43+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
44+
45+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46+
47+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48+
49+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
50+
51+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52+
53+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54+
55+
**Happy coding**!

‎LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) omar alalwi
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
# PhpPy - PHP Python 🚀🐍
2+
Seamlessly enabling secure and efficient execution of Python scripts within PHP applications.
3+
4+
## 📌 Table of Contents
5+
6+
- [📖 Overview](#-overview)
7+
- [✨ Features Summary](#-features-summary)
8+
- [⚙️ Configuration](#-configuration)
9+
- [🔧 ConfigManager](#-configmanager)
10+
- [📜 PhpPy](#-phppy)
11+
- [💻 CommandExecutor](#-commandexecutor)
12+
- [🚀 Quick Start](#-quick-start)
13+
- [🔑 Core Components](#-core-components)
14+
- [🛠 Framework Integration](#-framework-integration)
15+
- [📋 Changelog](#-changelog)
16+
- [🧪 Testing](#-testing)
17+
- [🔒 Security](#-security)
18+
- [🤝 Contributors](#-contributors)
19+
- [📄 License](#-license)
20+
21+
---
22+
23+
## 📖 Overview
24+
25+
The `PhpPy` package provides seamless integration between PHP and Python without API, enabling secure and efficient execution of Python scripts within PHP applications. It ensures structured script execution while managing configurations, arguments, environment variables, and error handling.
26+
27+
---
28+
29+
## ✨ Features Summary
30+
31+
### 🔐 Secure Execution
32+
- **Path Validation** ✅ Ensures scripts are within allowed directories.
33+
- **Argument & Environment Validation** 🔍 Restricts unauthorized input.
34+
- **Timeout Control** ⏳ Prevents long-running scripts.
35+
- **Uses `proc_close` as an alternative to `shell_exec`**.
36+
37+
### 🔧 Flexible Configuration
38+
- Centralized settings via `ConfigManager`.
39+
- Customizable execution parameters.
40+
41+
### 📤 Output Handling
42+
- Supports JSON parsing.
43+
- Captures and reports script errors.
44+
45+
### 🚨 Error Management
46+
- Detailed exception handling for debugging.
47+
- Standardized error reporting.
48+
49+
### 🔌 Extensibility
50+
- Modular execution through `CommandExecutor`.
51+
- Customizable for advanced use cases.
52+
53+
---
54+
55+
## 🚀 Quick Start
56+
57+
1. 📂 Create a folder for scripts, e.g., `phpPyScripts` in your project root directory.
58+
2. 📝 Create a Python script file (`.py` extension) and write Python code. [See this script example](https://github.com/omaralalwi/php-py/example-scripts/sum_calculator.py).
59+
3. 🔧 make script file executable, `chmod +x script_file_path` .
60+
61+
### ⚡ Easy Usage
62+
63+
```php
64+
<?php
65+
require_once 'vendor/autoload.php';
66+
67+
use Omaralalwi\PhpPy\PhpPy;
68+
use Omaralalwi\PhpPy\Managers\ConfigManager;
69+
70+
$configManager = new ConfigManager([
71+
'scripts_directory' => 'phpPyScripts',
72+
'python_executable' => '/usr/bin/python3',
73+
'max_timeout' => 120,
74+
]);
75+
76+
try {
77+
$result = PhpPy::build()
78+
->setConfig($configManager)
79+
->loadScript('sum_calculator.py')
80+
->withArguments([10, 20, 30])
81+
->run();
82+
83+
print_r($result); // 60.0
84+
} catch (Exception $e) {
85+
echo "Error: " . $e->getMessage();
86+
}
87+
```
88+
89+
### 🔥 Advanced Usage
90+
91+
```php
92+
<?php
93+
require_once 'vendor/autoload.php';
94+
95+
use Omaralalwi\PhpPy\PhpPy;
96+
use Omaralalwi\PhpPy\Managers\ConfigManager;
97+
98+
$configManager = new ConfigManager([
99+
'scripts_directory' => 'phpPyScripts',
100+
'python_executable' => '/usr/bin/python3',
101+
'max_timeout' => 120,
102+
]);
103+
104+
$result = PhpPy::build()
105+
->setConfig($configManager)
106+
->loadScript('advanced_example.py')
107+
->withArguments([10, 20, 30])
108+
->withEnvironment(['FIRST_ENV_VAR' => 'some value', 'SECOND_ENV_VAR' => 'some value'])
109+
->timeout(30)
110+
->asJson()
111+
->run();
112+
113+
try {
114+
print_r(json_decode($result));
115+
} catch (Exception $e) {
116+
echo "Error: " . $e->getMessage();
117+
}
118+
```
119+
120+
### 🌍 Real-World Example
121+
122+
Example: Running **DeepSeek AI** on your server while handling API requests using PHP.
123+
124+
```php
125+
<?php
126+
require_once 'vendor/autoload.php';
127+
128+
use Omaralalwi\PhpPy\PhpPy;
129+
use Omaralalwi\PhpPy\Managers\ConfigManager;
130+
131+
$configManager = new ConfigManager([
132+
'scripts_directory' => 'deepSeekScripts',
133+
'python_executable' => '/usr/bin/python3',
134+
'max_timeout' => 120,
135+
]);
136+
137+
header('Content-Type: application/json');
138+
$valid_tokens = ['USER1' => 'abcd1234', 'USER2' => 'efgh5678'];
139+
$token = $_POST['token'] ?? '';
140+
if (!isset($valid_tokens[$token])) {
141+
echo json_encode(['error' => 'Invalid token']);
142+
exit;
143+
}
144+
$prompt = $_POST['prompt'] ?? '';
145+
if (!empty($prompt)) {
146+
$clean_prompt = escapeshellarg($prompt);
147+
$response = PhpPy::build()
148+
->setConfig($configManager)
149+
->loadScript('model_worker.py')
150+
->withArguments($clean_prompt)
151+
->timeout(30)
152+
->asJson()
153+
->run();
154+
echo json_encode(['response' => trim($response)]);
155+
} else {
156+
echo json_encode(['error' => 'No prompt provided']);
157+
}
158+
```
159+
160+
---
161+
162+
## 🛠 Framework Integration
163+
164+
### [Laravel php-py](https://github.com/omaralalwi/laravel-php-py)
165+
166+
---
167+
168+
## 📋 Changelog
169+
170+
See detailed release notes in [CHANGELOG.md](CHANGELOG.md) 📜
171+
172+
---
173+
174+
## 🧪 Testing
175+
176+
```bash
177+
composer test
178+
OR
179+
./vendor/bin/pest
180+
```
181+
182+
Test coverage is coming in future versions. 🚀
183+
184+
---
185+
186+
## 🔒 Security
187+
188+
**Report Vulnerabilities**: Contact [omaralwi2010@gmail.com](mailto:omaralwi2010@gmail.com) 📩
189+
190+
---
191+
192+
## 🤝 Contributors
193+
194+
A huge thank you to these amazing people who have contributed to this project! 🎉💖
195+
196+
<table>
197+
<tr>
198+
<td align="center">
199+
<a href="https://github.com/omaralalwi">
200+
<img src="https://avatars.githubusercontent.com/u/25439498?v=4" width="60px;" style="border-radius:50%;" alt="Omar AlAlwi"/>
201+
<br />
202+
<b>Omar AlAlwi</b>
203+
</a>
204+
<br />
205+
🏆 Creator
206+
</td>
207+
</tr>
208+
</table>
209+
210+
**Want to contribute?** Check out the [contributing guidelines](./CONTRIBUTING.md) and submit a pull request! 🚀
211+
212+
---
213+
214+
## 📄 License
215+
216+
This package is open-source software licensed under the [MIT License](LICENSE.md). 📜
217+

‎composer.json

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"name": "omaralalwi/php-py",
3+
"description": "play with python in PHP applications",
4+
"keywords": [
5+
"php-py",
6+
"python",
7+
"python-php",
8+
"php-pytho",
9+
"php python integration",
10+
"run python in php",
11+
"omaralalwi",
12+
"execute python from php",
13+
"php shell execution",
14+
"secure python execution",
15+
"php python bridge",
16+
"python subprocess in php",
17+
"php exec python script"
18+
],
19+
"homepage": "https://github.com/omaralalwi/php-py",
20+
"license": "MIT",
21+
"type": "library",
22+
"authors": [
23+
{
24+
"name": "omar alalwi",
25+
"email": "omaralwi2010@gmail.com",
26+
"role": "Developer"
27+
}
28+
],
29+
"version": "1.0.0",
30+
"require": {
31+
"php": "^8.1",
32+
"omaralalwi/php-builders": "^1.0"
33+
},
34+
"autoload": {
35+
"psr-4": {
36+
"Omaralalwi\\PhpPy\\": "src"
37+
}
38+
},
39+
"autoload-dev": {
40+
"psr-4": {
41+
"Omaralalwi\\PhpPy\\Tests\\": "tests"
42+
}
43+
},
44+
"scripts": {
45+
"test": "vendor/bin/phpunit",
46+
"test-coverage": "vendor/bin/phpunit --coverage-html coverage"
47+
48+
},
49+
"config": {
50+
"sort-packages": true,
51+
"allow-plugins": {
52+
"pestphp/pest-plugin": true
53+
}
54+
},
55+
"require-dev": {
56+
"pestphp/pest": "^3.7"
57+
}
58+
}

‎config/config.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<?php
2+
3+
return [
4+
'scripts_directory' => '/path/to/scripts',
5+
'python_executable' => '/usr/bin/python3',
6+
'max_timeout' => 360,
7+
];

0 commit comments

Comments
 (0)