retunnel 0.1.0__tar.gz

retunnel-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Farshid Ashouri
+
+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.

retunnel-0.1.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include README.md
+include LICENSE
+include VERSION
+include pyproject.toml
+include setup.py
+recursive-include retunnel *.py
+recursive-include tests *.py
+recursive-include docs *.md
+prune tests/__pycache__
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude __pycache__
+global-exclude .DS_Store

retunnel-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: retunnel
+Version: 0.1.0
+Summary: A placeholder package for ReTunnel services
+Home-page: https://retunnel.com
+Author: ReTunnel Team
+Author-email: ReTunnel Team <support@retunnel.com>
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+# ReTunnel Python Client
+
+[![PyPI Version](https://badge.fury.io/py/retunnel.svg)](https://pypi.org/project/retunnel/)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**Placeholder package for ReTunnel - Securely expose local servers to the internet**
+
+ReTunnel is a free platform that allows developers to securely expose local servers to the internet through powerful tunneling capabilities. This Python package serves as a placeholder for the upcoming official ReTunnel client.
+
+## Features (Placeholder)
+
+This is currently a placeholder package. The full ReTunnel client will include:
+
+* Secure tunnel creation and management
+* Multiple protocol support (HTTP, HTTPS, TCP)
+* Custom domain configuration
+* Authentication and API key management
+* Automatic reconnection and failover
+* Webhook forwarding
+* Request inspection and replay
+
+For now, this package provides a simple hello-world implementation to reserve the package name on PyPI.
+
+
+## Installation
+
+You can install `retunnel` from PyPI using pip:
+
+```bash
+pip install retunnel
+```
+
+## Usage
+
+Here's a simple example demonstrating the placeholder functionality:
+
+```python
+from retunnel import ReTunnelClient, hello
+
+# Simple hello message
+print(hello())
+
+# Create a client instance
+client = ReTunnelClient()
+
+# Connect to the service (placeholder)
+if client.connect():
+    print("Connected to ReTunnel service")
+    
+    # Create a tunnel (placeholder)
+    tunnel_url = client.create_tunnel(port=8080)
+    print(f"Tunnel created: {tunnel_url}")
+    
+    # Close the connection
+    client.close()
+
+# Or use context manager
+with ReTunnelClient(api_key="your-api-key") as client:
+    tunnel_url = client.create_tunnel(port=3000)
+    print(f"Tunnel URL: {tunnel_url}")
+```
+
+## Running Tests
+
+To run the unit tests, install pytest and run:
+
+```bash
+pip install pytest
+```
+
+To run the tests:
+
+```bash
+pytest tests/
+```
+
+## Documentation
+
+Full documentation for ReTunnel is available at [https://retunnel.com](https://retunnel.com)
+
+## Contributing
+
+This is a placeholder package. The actual ReTunnel client development is happening at the main ReTunnel repository.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Links
+
+* Website: [https://retunnel.com](https://retunnel.com)
+* PyPI: [https://pypi.org/project/retunnel/](https://pypi.org/project/retunnel/)
+
+---
+
+**Note:** This is a placeholder package. The full-featured ReTunnel client is under development.

retunnel-0.1.0/README.md

@@ -0,0 +1,96 @@
+# ReTunnel Python Client
+
+[![PyPI Version](https://badge.fury.io/py/retunnel.svg)](https://pypi.org/project/retunnel/)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**Placeholder package for ReTunnel - Securely expose local servers to the internet**
+
+ReTunnel is a free platform that allows developers to securely expose local servers to the internet through powerful tunneling capabilities. This Python package serves as a placeholder for the upcoming official ReTunnel client.
+
+## Features (Placeholder)
+
+This is currently a placeholder package. The full ReTunnel client will include:
+
+* Secure tunnel creation and management
+* Multiple protocol support (HTTP, HTTPS, TCP)
+* Custom domain configuration
+* Authentication and API key management
+* Automatic reconnection and failover
+* Webhook forwarding
+* Request inspection and replay
+
+For now, this package provides a simple hello-world implementation to reserve the package name on PyPI.
+
+
+## Installation
+
+You can install `retunnel` from PyPI using pip:
+
+```bash
+pip install retunnel
+```
+
+## Usage
+
+Here's a simple example demonstrating the placeholder functionality:
+
+```python
+from retunnel import ReTunnelClient, hello
+
+# Simple hello message
+print(hello())
+
+# Create a client instance
+client = ReTunnelClient()
+
+# Connect to the service (placeholder)
+if client.connect():
+    print("Connected to ReTunnel service")
+    
+    # Create a tunnel (placeholder)
+    tunnel_url = client.create_tunnel(port=8080)
+    print(f"Tunnel created: {tunnel_url}")
+    
+    # Close the connection
+    client.close()
+
+# Or use context manager
+with ReTunnelClient(api_key="your-api-key") as client:
+    tunnel_url = client.create_tunnel(port=3000)
+    print(f"Tunnel URL: {tunnel_url}")
+```
+
+## Running Tests
+
+To run the unit tests, install pytest and run:
+
+```bash
+pip install pytest
+```
+
+To run the tests:
+
+```bash
+pytest tests/
+```
+
+## Documentation
+
+Full documentation for ReTunnel is available at [https://retunnel.com](https://retunnel.com)
+
+## Contributing
+
+This is a placeholder package. The actual ReTunnel client development is happening at the main ReTunnel repository.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Links
+
+* Website: [https://retunnel.com](https://retunnel.com)
+* PyPI: [https://pypi.org/project/retunnel/](https://pypi.org/project/retunnel/)
+
+---
+
+**Note:** This is a placeholder package. The full-featured ReTunnel client is under development.

retunnel-0.1.0/VERSION

@@ -0,0 +1 @@
+0.1.0

retunnel-0.1.0/docs/README.md

@@ -0,0 +1,56 @@
+# ReTunnel Python Client Documentation
+
+## Overview
+
+ReTunnel is a platform for securely exposing local servers to the internet. This Python package is currently a placeholder for the upcoming official ReTunnel client.
+
+## Installation
+
+```bash
+pip install retunnel
+```
+
+## Quick Start
+
+```python
+from retunnel import ReTunnelClient, hello
+
+# Print hello message
+print(hello())
+
+# Create a tunnel (placeholder)
+with ReTunnelClient() as client:
+    tunnel_url = client.create_tunnel(port=8080)
+    print(f"Tunnel URL: {tunnel_url}")
+```
+
+## API Reference
+
+### ReTunnelClient
+
+The main client class for interacting with ReTunnel services.
+
+#### Methods
+
+- `__init__(api_key=None)`: Initialize the client with an optional API key
+- `connect()`: Connect to the ReTunnel service
+- `create_tunnel(port=8080)`: Create a tunnel for the specified port
+- `close()`: Close the connection
+
+#### Context Manager
+
+The client supports Python's context manager protocol:
+
+```python
+with ReTunnelClient() as client:
+    # Use client here
+    pass
+```
+
+### hello()
+
+Returns a welcome message from ReTunnel.
+
+## More Information
+
+Visit [https://retunnel.com](https://retunnel.com) for more information about ReTunnel.

retunnel-0.1.0/docs/index.md

@@ -0,0 +1,56 @@
+# ReTunnel Python Client Documentation
+
+## Overview
+
+ReTunnel is a platform for securely exposing local servers to the internet. This Python package is currently a placeholder for the upcoming official ReTunnel client.
+
+## Installation
+
+```bash
+pip install retunnel
+```
+
+## Quick Start
+
+```python
+from retunnel import ReTunnelClient, hello
+
+# Print hello message
+print(hello())
+
+# Create a tunnel (placeholder)
+with ReTunnelClient() as client:
+    tunnel_url = client.create_tunnel(port=8080)
+    print(f"Tunnel URL: {tunnel_url}")
+```
+
+## API Reference
+
+### ReTunnelClient
+
+The main client class for interacting with ReTunnel services.
+
+#### Methods
+
+- `__init__(api_key=None)`: Initialize the client with an optional API key
+- `connect()`: Connect to the ReTunnel service
+- `create_tunnel(port=8080)`: Create a tunnel for the specified port
+- `close()`: Close the connection
+
+#### Context Manager
+
+The client supports Python's context manager protocol:
+
+```python
+with ReTunnelClient() as client:
+    # Use client here
+    pass
+```
+
+### hello()
+
+Returns a welcome message from ReTunnel.
+
+## More Information
+
+Visit [https://retunnel.com](https://retunnel.com) for more information about ReTunnel.

retunnel-0.1.0/pyproject.toml

@@ -0,0 +1,93 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "retunnel"
+version = "0.1.0"
+description = "A placeholder package for ReTunnel services"
+authors = [{name = "ReTunnel Team", email = "support@retunnel.com"}]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = [
+    "-ra",
+    "-q",
+    "--strict-markers",
+    "--strict-config",
+    "--cov=retunnel",
+    "--cov-report=term-missing",
+    "--cov-report=xml",
+    "--cov-fail-under=80"
+]
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+pythonpath = ["."]
+markers = [
+    "slow: marks tests as slow",
+    "integration: marks tests as integration tests",
+    "unit: marks tests as unit tests"
+]
+
+[tool.black]
+line-length = 79
+target-version = ["py38", "py39", "py310", "py311", "py312"]
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+line_length = 79
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+src_paths = ["retunnel", "tests"]
+
+[tool.coverage.run]
+source = ["retunnel"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]

retunnel-0.1.0/retunnel/__init__.py

@@ -0,0 +1,15 @@
+"""
+ReTunnel - A placeholder package for ReTunnel services.
+
+ReTunnel is a platform for securely exposing local servers to the internet.
+This package serves as a placeholder for future ReTunnel client functionality.
+"""
+
+__version__ = "0.1.0"
+__author__ = "ReTunnel Team"
+__email__ = "support@retunnel.com"
+__url__ = "https://retunnel.com"
+
+from .client import start_client
+
+__all__ = ["start_client", "__version__"]

retunnel-0.1.0/retunnel/client.py

@@ -0,0 +1,12 @@
+"""
+ReTunnel Client - Placeholder implementation for ReTunnel services.
+"""
+
+
+def start_client():
+    """
+    Start the ReTunnel client service.
+    This function is a placeholder and should be implemented with actual client logic.
+    """
+    print("Starting ReTunnel client...")
+    return True

retunnel-0.1.0/retunnel.egg-info/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: retunnel
+Version: 0.1.0
+Summary: A placeholder package for ReTunnel services
+Home-page: https://retunnel.com
+Author: ReTunnel Team
+Author-email: ReTunnel Team <support@retunnel.com>
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+# ReTunnel Python Client
+
+[![PyPI Version](https://badge.fury.io/py/retunnel.svg)](https://pypi.org/project/retunnel/)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**Placeholder package for ReTunnel - Securely expose local servers to the internet**
+
+ReTunnel is a free platform that allows developers to securely expose local servers to the internet through powerful tunneling capabilities. This Python package serves as a placeholder for the upcoming official ReTunnel client.
+
+## Features (Placeholder)
+
+This is currently a placeholder package. The full ReTunnel client will include:
+
+* Secure tunnel creation and management
+* Multiple protocol support (HTTP, HTTPS, TCP)
+* Custom domain configuration
+* Authentication and API key management
+* Automatic reconnection and failover
+* Webhook forwarding
+* Request inspection and replay
+
+For now, this package provides a simple hello-world implementation to reserve the package name on PyPI.
+
+
+## Installation
+
+You can install `retunnel` from PyPI using pip:
+
+```bash
+pip install retunnel
+```
+
+## Usage
+
+Here's a simple example demonstrating the placeholder functionality:
+
+```python
+from retunnel import ReTunnelClient, hello
+
+# Simple hello message
+print(hello())
+
+# Create a client instance
+client = ReTunnelClient()
+
+# Connect to the service (placeholder)
+if client.connect():
+    print("Connected to ReTunnel service")
+    
+    # Create a tunnel (placeholder)
+    tunnel_url = client.create_tunnel(port=8080)
+    print(f"Tunnel created: {tunnel_url}")
+    
+    # Close the connection
+    client.close()
+
+# Or use context manager
+with ReTunnelClient(api_key="your-api-key") as client:
+    tunnel_url = client.create_tunnel(port=3000)
+    print(f"Tunnel URL: {tunnel_url}")
+```
+
+## Running Tests
+
+To run the unit tests, install pytest and run:
+
+```bash
+pip install pytest
+```
+
+To run the tests:
+
+```bash
+pytest tests/
+```
+
+## Documentation
+
+Full documentation for ReTunnel is available at [https://retunnel.com](https://retunnel.com)
+
+## Contributing
+
+This is a placeholder package. The actual ReTunnel client development is happening at the main ReTunnel repository.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Links
+
+* Website: [https://retunnel.com](https://retunnel.com)
+* PyPI: [https://pypi.org/project/retunnel/](https://pypi.org/project/retunnel/)
+
+---
+
+**Note:** This is a placeholder package. The full-featured ReTunnel client is under development.

retunnel-0.1.0/retunnel.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+MANIFEST.in
+README.md
+VERSION
+pyproject.toml
+setup.py
+docs/README.md
+docs/index.md
+retunnel/__init__.py
+retunnel/client.py
+retunnel.egg-info/PKG-INFO
+retunnel.egg-info/SOURCES.txt
+retunnel.egg-info/dependency_links.txt
+retunnel.egg-info/top_level.txt
+tests/test_retunnel.py

retunnel-0.1.0/retunnel.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

retunnel-0.1.0/retunnel.egg-info/top_level.txt

@@ -0,0 +1 @@
+retunnel

retunnel-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

retunnel-0.1.0/setup.py

@@ -0,0 +1,38 @@
+from setuptools import find_packages, setup
+
+with open("VERSION", "r") as version_file:
+    version = version_file.read().strip()
+
+setup(
+    name="retunnel",
+    version=version,
+    packages=find_packages(
+        include=["retunnel"]
+    ),  # Find packages under retunnel/
+    install_requires=[],  # No dependencies for now
+    description="ReTunnel - Securely expose local servers to the internet",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    url="https://retunnel.com",
+    author="ReTunnel Team",
+    author_email="retunnel-support@rodmena.co.uk",
+    license="MIT",
+    license_files=(
+        "LICENSE",
+    ),  # Explicitly include the LICENSE file - KEEP THIS!
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Topic :: Software Development :: Libraries :: Application Frameworks",
+        "Topic :: System :: Networking",
+        "Topic :: Internet :: WWW/HTTP",
+    ],
+)

retunnel-0.1.0/tests/test_retunnel.py

@@ -0,0 +1,9 @@
+"""
+Tests for the ReTunnel package.
+"""
+
+from retunnel import start_client
+
+
+def test_re_tunnel():
+    assert start_client() is True, "ReTunnel client did not start successfully"