vpseasy 0.0.1__tar.gz

vpseasy-0.0.1/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Skill(nbdev)",
+      "Bash(nbdev-export 2>&1)"
+    ]
+  }
+}

vpseasy-0.0.1/.github/workflows/deploy.yaml

@@ -0,0 +1,14 @@
+name: Deploy to GitHub Pages
+
+permissions:
+  contents: write
+  pages: write
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  workflow_dispatch:
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps: [uses: answerdotai/workflows/quarto-ghp3@master]

vpseasy-0.0.1/.github/workflows/test.yaml

@@ -0,0 +1,7 @@
+name: CI
+on:  [workflow_dispatch, pull_request, push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps: [uses: answerdotai/workflows/nbdev3-ci@master]

vpseasy-0.0.1/.gitignore

@@ -0,0 +1,152 @@
+_docs/
+_proc/
+
+*.bak
+.gitattributes
+.last_checked
+.gitconfig
+*.bak
+*.log
+*~
+~*
+_tmp*
+tmp*
+tags
+*.pkg
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+conda/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.vscode
+*.swp
+
+# osx generated files
+.DS_Store
+.DS_Store?
+.Trashes
+ehthumbs.db
+Thumbs.db
+.idea
+
+# pytest
+.pytest_cache
+
+# tools/trust-doc-nbs
+docs_src/.last_checked
+
+# symlinks to fastai
+docs_src/fastai
+tools/fastai
+
+# link checker
+checklink/cookies.txt
+
+# .gitconfig is now autogenerated
+.gitconfig
+
+# Quarto installer
+.deb
+.pkg
+
+# Quarto
+.quarto

vpseasy-0.0.1/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Release notes
+
+<!-- do not remove -->
+
+## 0.0.1
+vps provisioning with multipass and hetzner
+
+

vpseasy-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022, fastai
+
+   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.

vpseasy-0.0.1/MANIFEST.in

@@ -0,0 +1,5 @@
+include pyproject.toml
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

vpseasy-0.0.1/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: vpseasy
+Version: 0.0.1
+Summary: create resources, deploy code in prod and dev. supports hetzner and multipass
+Project-URL: Repository, https://github.com/vedicreader/vpseasy
+Project-URL: Documentation, https://vedicreader.github.io/vpseasy/
+Author-email: Karthik <karthik.rajgopal@hotmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: nbdev
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Requires-Dist: dockeasy>=0.0.3
+Requires-Dist: fastcloudinit>=0.0.5
+Requires-Dist: fastcore>=1.12.31
+Requires-Dist: hcloud>=2.17.0
+Description-Content-Type: text/markdown
+
+# vpseasy
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Cloud-init generation
+
+[`vps_init()`](https://vedicreader.github.io/vpseasy/core.html#vps_init)
+builds a hardened cloud-init YAML for production: UFW firewall,
+fail2ban, unattended upgrades, Docker, and your SSH keys — in one call.
+
+[`multi_init()`](https://vedicreader.github.io/vpseasy/core.html#multi_init)
+is the local equivalent for Multipass: same Docker setup, no UFW or
+fail2ban (faster VM boot).
+
+``` python
+# Load your local public keys (auto-detects ~/.ssh/id_*.pub)
+pub_keys = load_pub_keys()
+
+# Production-ready cloud-init: UFW, fail2ban, Docker, your SSH key
+yaml = vps_init('myserver', pub_keys)
+print(yaml)
+```
+
+Both functions accept `pkgs` and `cmds` for extra packages and run
+commands. `docker=False` skips the Docker install entirely.
+
+``` python
+# Add nginx, run a custom post-boot script
+yaml = vps_init('myserver', pub_keys,
+                pkgs=['nginx'],
+                cmds=['echo done > /tmp/setup.txt'])
+```
+
+## Local testing with Multipass
+
+Before spending money on a real VPS, test your cloud-init and deployment
+against a local Ubuntu VM using [Multipass](https://multipass.run).
+
+[`multi_init()`](https://vedicreader.github.io/vpseasy/core.html#multi_init)
+generates a Multipass-friendly cloud-init (no UFW, faster boot).
+[`Multipass`](https://vedicreader.github.io/vpseasy/core.html#multipass)
+wraps the CLI — launch, exec, transfer, delete.
+
+``` python
+mp = Multipass()
+pub_keys = load_pub_keys()
+
+# Write cloud-init to a temp file (Multipass requires a path)
+ci = Path(tempfile.mktemp(suffix='.yaml'))
+ci.write_text(multi_init('testvm', pub_keys, docker=True))
+
+# Launch a local Ubuntu 24.04 VM
+mp.launch('testvm', image='24.04', cpus=1, memory='1G', disk='10G', cloud_init=ci)
+ci.unlink()
+
+ip = mp.ip('testvm')
+print(f'VM running at {ip}')
+
+# Sync and run your Docker Compose app inside the VM
+deploy_mp('testvm', src='./myapp')
+
+# Clean up when done
+mp.rm('testvm')
+```
+
+## Provision on Hetzner
+
+[`Hetzner`](https://vedicreader.github.io/vpseasy/core.html#hetzner)
+wraps the [hcloud Python
+SDK](https://github.com/hetznercloud/hcloud-python) — no CLI binary or
+config files. Set `HCLOUD_TOKEN` in your environment and you’re ready.
+
+``` sh
+export HCLOUD_TOKEN=your_token_here
+```
+
+``` python
+hz = Hetzner()  # reads HCLOUD_TOKEN from env
+
+# See what SSH keys are registered in your Hetzner account
+print(hz.key_names())
+
+# List running servers
+print(hz.servers())
+```
+
+``` python
+pub_keys = load_pub_keys()
+cloud_init_yaml = vps_init('myapp-prod', pub_keys)
+
+# Create a cx23 server in Helsinki — returns {ip: response}
+result = hz.create(
+    name='myapp-prod',
+    image='ubuntu-24.04',
+    server_type='cx23',     # ~€4/month at time of writing
+    location='hel1',        # hel1, fsn1, nbg1, ash, hil, sin
+    cloud_init=cloud_init_yaml,
+    ssh_keys=hz.key_names(),
+)
+
+ip = next(iter(result))
+print(f'Server provisioning at {ip} — cloud-init running in background')
+```
+
+## Deploy your app
+
+After provisioning, cloud-init runs asynchronously. Use
+[`wait_ssh()`](https://vedicreader.github.io/vpseasy/core.html#wait_ssh)
+to block until the server is reachable,
+[`chk_cloud_init()`](https://vedicreader.github.io/vpseasy/core.html#chk_cloud_init)
+to confirm bootstrap completed, then
+[`deploy()`](https://vedicreader.github.io/vpseasy/core.html#deploy) to
+rsync your Compose stack and bring it up.
+
+``` python
+SSH_KEY = '~/.ssh/id_ed25519'   # private key matching the pub key you injected
+
+# Block until SSH is up (cloud-init takes 1-3 min on a fresh VPS)
+wait_ssh(ip, k=SSH_KEY, tout=300)
+print('SSH ready')
+
+# Confirm cloud-init finished successfully
+status = chk_cloud_init(ip, k=SSH_KEY)
+print(f'cloud-init: {status}')      # 'done' = all good
+
+# Confirm Docker is running and the deploy user can use it
+print(f'docker: {chk_docker(ip, k=SSH_KEY)}')   # True = ready
+
+# Rsync ./myapp → /srv/app on the server, then docker compose up -d --build
+deploy('./myapp', ip, key=SSH_KEY, path='/srv/app')
+```
+
+``` python
+# Run an arbitrary command, capture output
+out = run_ssh(ip, 'systemctl status nginx', key=SSH_KEY, capture=True)
+
+# Run multiple commands in one SSH session
+run_ssh(ip, 'cd /srv/app', 'git pull', 'docker compose restart', key=SSH_KEY)
+
+# Rsync a directory (trailing slash = send contents, not the dir itself)
+sync('./myapp/', '/srv/app', ip, key=SSH_KEY, exclude=['.git', '__pycache__'])
+```
+
+``` python
+SSH_KEY = os.path.expanduser('~/.ssh/id_ed25519')
+APP_DIR = './myapp'
+
+# 1. Load local SSH keys
+pub_keys = load_pub_keys()
+
+# 2. Generate production cloud-init
+ci_yaml = vps_init('myapp-prod', pub_keys)
+
+# 3. Provision on Hetzner
+hz = Hetzner()
+result = hz.create('myapp-prod', cloud_init=ci_yaml,
+                   ssh_keys=hz.key_names(), location='hel1')
+ip = next(iter(result))
+print(f'Provisioning {ip}...')
+
+# 4. Wait for SSH + verify bootstrap
+wait_ssh(ip, k=SSH_KEY, tout=300)
+assert chk_cloud_init(ip, k=SSH_KEY) == 'done', 'cloud-init failed!'
+assert chk_docker(ip, k=SSH_KEY), 'Docker not ready!'
+
+# 5. Deploy app
+deploy(APP_DIR, ip, key=SSH_KEY)
+print(f'App live at http://{ip}')
+```
+
+## SSH helpers
+
+[`run_ssh`](https://vedicreader.github.io/vpseasy/core.html#run_ssh) and
+[`sync`](https://vedicreader.github.io/vpseasy/core.html#sync) are the
+low-level primitives that
+[`deploy`](https://vedicreader.github.io/vpseasy/core.html#deploy)
+builds on — useful when you need finer control.
+
+## Full lifecycle in one script
+
+Here’s the complete flow — from zero to a running app:
+
+## API reference
+
+| Symbol | Description |
+|----|----|
+| `vps_init(hostname, pub_keys, ...)` | Production cloud-init YAML (UFW, fail2ban, Docker) |
+| `multi_init(hostname, pub_keys, ...)` | Local Multipass cloud-init YAML (no UFW) |
+| `load_pub_keys(paths=None)` | Read public keys from `~/.ssh/id_*.pub` |
+| [`Multipass`](https://vedicreader.github.io/vpseasy/core.html#multipass) | Launch/list/delete local Ubuntu VMs |
+| `deploy_mp(name, src, ...)` | Sync dir + `docker compose up` inside a Multipass VM |
+| [`Hetzner`](https://vedicreader.github.io/vpseasy/core.html#hetzner) | Create/list/delete Hetzner Cloud servers |
+| `wait_ssh(host, ...)` | Poll until SSH accepts connections |
+| `chk_cloud_init(host, ...)` | Return `cloud-init status` string |
+| `chk_docker(host, ...)` | Verify Docker daemon is running |
+| `run_ssh(host, *cmds, ...)` | Run commands on a remote host |
+| `sync(src, dst_path, host, ...)` | Rsync local path to remote host |
+| `deploy(src, host, ...)` | [`sync`](https://vedicreader.github.io/vpseasy/core.html#sync) + `docker compose up -d` |
+
+## Install
+
+``` sh
+# Latest release
+pip install vpseasy
+
+# Or from source
+pip install git+https://github.com/vedicreader/vpseasy.git
+```
+
+**Requirements:** Python 3.10+, `hcloud`, `fastcloudinit`, `dockeasy`,
+`fastcore`. Multipass and rsync only needed for local-VM and deploy
+workflows.