proxy2vpn 0.2.0__tar.gz

proxy2vpn-0.2.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Serhii Khalymon
+
+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.
+

proxy2vpn-0.2.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: proxy2vpn
+Version: 0.2.0
+Summary: Proxy2VPN Python utilities
+Author-email: Serhii Khalymon <serhii.khalymon@pm.me>
+License-Expression: MIT
+Keywords: vpn,proxy,utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Requires-Dist: ruamel.yaml
+Requires-Dist: docker
+Requires-Dist: requests
+Provides-Extra: dev
+Requires-Dist: towncrier; extra == "dev"
+Dynamic: license-file
+
+# Proxy2VPN
+
+Python command-line interface for managing multiple VPN containers with Docker.
+
+## Features
+- Manage VPN credentials as reusable profiles
+- Create and control VPN services
+- Bulk start/stop operations
+- Query and validate provider server locations
+- Apply predefined presets for common setups
+
+## Installation
+
+Install `proxy2vpn` from [PyPI](https://pypi.org/project/proxy2vpn/) using your
+preferred Python tool:
+
+### pip
+```bash
+pip install proxy2vpn
+proxy2vpn --help
+```
+
+### uv
+```bash
+uv tool install proxy2vpn
+proxy2vpn --help
+```
+
+### uvx
+Run the CLI without installing it:
+```bash
+uvx proxy2vpn --help
+```
+
+### pipx
+```bash
+pipx install proxy2vpn
+proxy2vpn --help
+```
+
+## Quick Start
+1. Initialize the compose file:
+   ```bash
+   proxy2vpn init
+   ```
+
+2. Create a profile file with your VPN credentials:
+   ```bash
+   mkdir -p profiles
+   cat <<'EOF' > profiles/myprofile.env
+   OPENVPN_USER=your_username
+   OPENVPN_PASSWORD=your_password
+   EOF
+   ```
+
+3. Register the profile:
+   ```bash
+   proxy2vpn profile create myprofile profiles/myprofile.env
+   ```
+
+4. Create and start a VPN service:
+   ```bash
+   proxy2vpn vpn create vpn1 myprofile --port 8888 --provider protonvpn --location "New York"
+   proxy2vpn vpn start vpn1
+   ```
+
+5. View status and test connectivity:
+   ```bash
+   proxy2vpn vpn list
+   proxy2vpn test vpn1
+   ```
+
+## Command overview
+
+### Initialization
+- `proxy2vpn init [--force]`
+
+### Profiles
+- `proxy2vpn profile create NAME ENV_FILE`
+- `proxy2vpn profile list`
+- `proxy2vpn profile delete NAME`
+
+### VPN services
+- `proxy2vpn vpn create NAME PROFILE [--port PORT] [--provider PROVIDER] [--location LOCATION]`
+- `proxy2vpn vpn list`
+- `proxy2vpn vpn start NAME`
+- `proxy2vpn vpn stop NAME`
+- `proxy2vpn vpn restart NAME`
+- `proxy2vpn vpn logs NAME [--lines N] [--follow]`
+- `proxy2vpn vpn delete NAME`
+
+### Bulk operations
+- `proxy2vpn bulk up`
+- `proxy2vpn bulk down`
+- `proxy2vpn bulk status`
+- `proxy2vpn bulk ips`
+
+### Server database
+- `proxy2vpn servers update`
+- `proxy2vpn servers list-providers`
+- `proxy2vpn servers list-countries PROVIDER`
+- `proxy2vpn servers list-cities PROVIDER COUNTRY`
+- `proxy2vpn servers validate-location PROVIDER LOCATION`
+
+### Presets
+- `proxy2vpn preset list`
+- `proxy2vpn preset apply PRESET SERVICE [--port PORT]`
+
+### Testing
+- `proxy2vpn test SERVICE` – verify that a proxy container is reachable
+
+## Development
+
+### Setup
+```bash
+# Install with development dependencies
+uv sync
+# or
+pip install -e ".[dev]"
+```
+
+### Testing
+```bash
+# Run tests (if available)
+pytest
+```
+
+### Changelog Management
+This project uses [Towncrier](https://towncrier.readthedocs.io/) for changelog management:
+
+```bash
+# Add a news fragment for your changes
+echo "Your feature description" > news/<PR_NUMBER>.feature.md
+
+# Preview the changelog
+make changelog-draft
+
+# Build the changelog (maintainers)
+make changelog VERSION=x.y.z
+```
+
+## License
+MIT

proxy2vpn-0.2.0/README.md

@@ -0,0 +1,143 @@
+# Proxy2VPN
+
+Python command-line interface for managing multiple VPN containers with Docker.
+
+## Features
+- Manage VPN credentials as reusable profiles
+- Create and control VPN services
+- Bulk start/stop operations
+- Query and validate provider server locations
+- Apply predefined presets for common setups
+
+## Installation
+
+Install `proxy2vpn` from [PyPI](https://pypi.org/project/proxy2vpn/) using your
+preferred Python tool:
+
+### pip
+```bash
+pip install proxy2vpn
+proxy2vpn --help
+```
+
+### uv
+```bash
+uv tool install proxy2vpn
+proxy2vpn --help
+```
+
+### uvx
+Run the CLI without installing it:
+```bash
+uvx proxy2vpn --help
+```
+
+### pipx
+```bash
+pipx install proxy2vpn
+proxy2vpn --help
+```
+
+## Quick Start
+1. Initialize the compose file:
+   ```bash
+   proxy2vpn init
+   ```
+
+2. Create a profile file with your VPN credentials:
+   ```bash
+   mkdir -p profiles
+   cat <<'EOF' > profiles/myprofile.env
+   OPENVPN_USER=your_username
+   OPENVPN_PASSWORD=your_password
+   EOF
+   ```
+
+3. Register the profile:
+   ```bash
+   proxy2vpn profile create myprofile profiles/myprofile.env
+   ```
+
+4. Create and start a VPN service:
+   ```bash
+   proxy2vpn vpn create vpn1 myprofile --port 8888 --provider protonvpn --location "New York"
+   proxy2vpn vpn start vpn1
+   ```
+
+5. View status and test connectivity:
+   ```bash
+   proxy2vpn vpn list
+   proxy2vpn test vpn1
+   ```
+
+## Command overview
+
+### Initialization
+- `proxy2vpn init [--force]`
+
+### Profiles
+- `proxy2vpn profile create NAME ENV_FILE`
+- `proxy2vpn profile list`
+- `proxy2vpn profile delete NAME`
+
+### VPN services
+- `proxy2vpn vpn create NAME PROFILE [--port PORT] [--provider PROVIDER] [--location LOCATION]`
+- `proxy2vpn vpn list`
+- `proxy2vpn vpn start NAME`
+- `proxy2vpn vpn stop NAME`
+- `proxy2vpn vpn restart NAME`
+- `proxy2vpn vpn logs NAME [--lines N] [--follow]`
+- `proxy2vpn vpn delete NAME`
+
+### Bulk operations
+- `proxy2vpn bulk up`
+- `proxy2vpn bulk down`
+- `proxy2vpn bulk status`
+- `proxy2vpn bulk ips`
+
+### Server database
+- `proxy2vpn servers update`
+- `proxy2vpn servers list-providers`
+- `proxy2vpn servers list-countries PROVIDER`
+- `proxy2vpn servers list-cities PROVIDER COUNTRY`
+- `proxy2vpn servers validate-location PROVIDER LOCATION`
+
+### Presets
+- `proxy2vpn preset list`
+- `proxy2vpn preset apply PRESET SERVICE [--port PORT]`
+
+### Testing
+- `proxy2vpn test SERVICE` – verify that a proxy container is reachable
+
+## Development
+
+### Setup
+```bash
+# Install with development dependencies
+uv sync
+# or
+pip install -e ".[dev]"
+```
+
+### Testing
+```bash
+# Run tests (if available)
+pytest
+```
+
+### Changelog Management
+This project uses [Towncrier](https://towncrier.readthedocs.io/) for changelog management:
+
+```bash
+# Add a news fragment for your changes
+echo "Your feature description" > news/<PR_NUMBER>.feature.md
+
+# Preview the changelog
+make changelog-draft
+
+# Build the changelog (maintainers)
+make changelog VERSION=x.y.z
+```
+
+## License
+MIT

proxy2vpn-0.2.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "proxy2vpn"
+version = "0.2.0"
+description = "Proxy2VPN Python utilities"
+authors = [{ name = "Serhii Khalymon", email = "serhii.khalymon@pm.me" }]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+keywords = ["vpn", "proxy", "utilities"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "typer",
+    "ruamel.yaml",
+    "docker",
+    "requests",
+]
+
+[project.optional-dependencies]
+dev = ["towncrier"]
+
+[tool.towncrier]
+package = "proxy2vpn"
+package_dir = "src"
+filename = "CHANGELOG.md"
+directory = "news"
+start_string = "<!-- towncrier release notes start -->"
+template = "towncrier:default.md"
+title_format = "## [{version}]"
+underlines = ["-", "~"]
+
+[tool.towncrier.fragment.feature]
+name = "Features"
+showcontent = true
+
+[tool.towncrier.fragment.bugfix]
+name = "Bug fixes"
+showcontent = true
+
+[tool.towncrier.fragment.doc]
+name = "Documentation"
+showcontent = true
+
+[tool.towncrier.fragment.removal]
+name = "Removals"
+showcontent = true
+
+[tool.towncrier.fragment.misc]
+name = "Miscellaneous"
+showcontent = true
+
+[project.scripts]
+proxy2vpn = "proxy2vpn.cli:app"
+
+[tool.setuptools.packages.find]
+where = ["src"]

proxy2vpn-0.2.0/setup.cfg

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

proxy2vpn-0.2.0/src/proxy2vpn/__init__.py

@@ -0,0 +1,20 @@
+"""proxy2vpn Python package."""
+
+try:
+    from importlib.metadata import version
+
+    __version__ = version("proxy2vpn")
+except Exception:
+    # Fallback when package is not installed (development mode)
+    __version__ = "dev"
+
+__all__ = [
+    "cli",
+    "compose_utils",
+    "docker_ops",
+    "compose_manager",
+    "models",
+    "config",
+    "server_manager",
+    "__version__",
+]

proxy2vpn-0.2.0/src/proxy2vpn/__main__.py

@@ -0,0 +1,12 @@
+"""Module entry point for proxy2vpn CLI."""
+
+from .cli import app
+
+
+def main() -> None:
+    """Run the proxy2vpn CLI."""
+    raise SystemExit(app())
+
+
+if __name__ == "__main__":  # pragma: no cover - CLI entry point
+    main()