pullup 0.0.7__tar.gz → 0.0.9__tar.gz

{pullup-0.0.7 → pullup-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pullup
-Version: 0.0.7
+Version: 0.0.9
 Summary: build, release, and deploy projects
 Project-URL: Repository, https://github.com/vedicreader/pullup
 Project-URL: Documentation, https://vedicreader.github.io/pullup
@@ -14,15 +14,15 @@ Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.11
-Requires-Dist: cfeasy>=0.0.4
-Requires-Dist: dockeasy>=0.0.5
+Requires-Dist: cfeasy>=0.0.6
+Requires-Dist: dockeasy>=0.0.10
 Requires-Dist: fastcore>=1.8.17
 Requires-Dist: gheasy>=0.0.10
 Requires-Dist: keyring>=25.0.0
 Requires-Dist: ptymini>=0.0.5
 Requires-Dist: python-dotenv>=1.0.0
 Requires-Dist: pyyaml>=6.0
-Requires-Dist: vpseasy>=0.0.18
+Requires-Dist: vpseasy>=0.0.24
 Description-Content-Type: text/markdown
 
 # pullup
@@ -44,7 +44,7 @@ This also installs gheasy, dockeasy, vpseasy and cfeasy. None of them is importe
 
 ## What kind of project is this
 
-A release flow is the ordered list of commands that publishes one kind of project. An nbdev library is released with `nbdev_prepare`, `nbdev_bump_version`, `nbdev_release_gh` and `nbdev_pypi`. A plain Python package and a Rust crate each have a different list. [`Project`](https://vedicreader.github.io/pullup/project.html#project) looks at the files in a folder, picks the flow that fits, and returns its steps. The folder here holds only a `pyproject.toml` with a `[tool.nbdev]` table, so it is an nbdev project:
+A release flow is the ordered list of commands that publishes one kind of project. An nbdev library is released with `nbdev-prepare`, `nbdev-bump-version`, `nbdev-release-gh` and `nbdev-pypi`. A plain Python package and a Rust crate each have a different list. [`Project`](https://vedicreader.github.io/pullup/project.html#project) looks at the files in a folder, picks the flow that fits, and returns its steps. The folder here holds only a `pyproject.toml` with a `[tool.nbdev]` table, so it is an nbdev project:
 
 ``` python
 project = Project(root)

{pullup-0.0.7 → pullup-0.0.9}/README.md

@@ -17,7 +17,7 @@ This also installs gheasy, dockeasy, vpseasy and cfeasy. None of them is importe
 
 ## What kind of project is this
 
-A release flow is the ordered list of commands that publishes one kind of project. An nbdev library is released with `nbdev_prepare`, `nbdev_bump_version`, `nbdev_release_gh` and `nbdev_pypi`. A plain Python package and a Rust crate each have a different list. [`Project`](https://vedicreader.github.io/pullup/project.html#project) looks at the files in a folder, picks the flow that fits, and returns its steps. The folder here holds only a `pyproject.toml` with a `[tool.nbdev]` table, so it is an nbdev project:
+A release flow is the ordered list of commands that publishes one kind of project. An nbdev library is released with `nbdev-prepare`, `nbdev-bump-version`, `nbdev-release-gh` and `nbdev-pypi`. A plain Python package and a Rust crate each have a different list. [`Project`](https://vedicreader.github.io/pullup/project.html#project) looks at the files in a folder, picks the flow that fits, and returns its steps. The folder here holds only a `pyproject.toml` with a `[tool.nbdev]` table, so it is an nbdev project:
 
 ``` python
 project = Project(root)

{pullup-0.0.7 → pullup-0.0.9}/pullup/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.7"
+__version__ = "0.0.9"
 
 # The names a caller reaches for. The modules stay importable for everything else.
 from .env import EnvError, EnvStore, venv_env

{pullup-0.0.7 → pullup-0.0.9}/pullup/_modidx.py

@@ -179,7 +179,6 @@ d = { 'settings': { 'branch': 'main',
                                   'pullup.workflows._fastship': ('workflows.html#_fastship', 'pullup/workflows.py'),
                                   'pullup.workflows._from_line': ('workflows.html#_from_line', 'pullup/workflows.py'),
                                   'pullup.workflows._gh_authed': ('workflows.html#_gh_authed', 'pullup/workflows.py'),
-                                  'pullup.workflows._gheasy': ('workflows.html#_gheasy', 'pullup/workflows.py'),
                                   'pullup.workflows._opened': ('workflows.html#_opened', 'pullup/workflows.py'),
                                   'pullup.workflows._read': ('workflows.html#_read', 'pullup/workflows.py'),
                                   'pullup.workflows._run_row': ('workflows.html#_run_row', 'pullup/workflows.py'),
@@ -187,4 +186,5 @@ d = { 'settings': { 'branch': 'main',
                                   'pullup.workflows._wf_file': ('workflows.html#_wf_file', 'pullup/workflows.py'),
                                   'pullup.workflows._wf_name': ('workflows.html#_wf_name', 'pullup/workflows.py'),
                                   'pullup.workflows._yaml': ('workflows.html#_yaml', 'pullup/workflows.py'),
+                                  'pullup.workflows.gheasy_core': ('workflows.html#gheasy_core', 'pullup/workflows.py'),
                                   'pullup.workflows.levels': ('workflows.html#levels', 'pullup/workflows.py')}}}

{pullup-0.0.7 → pullup-0.0.9}/pullup/deploy.py

@@ -88,8 +88,8 @@ def _load_env():
     return dict(os.environ) | (parse_env(fn=str(envf)) if envf.exists() else {{}})
 
 def env2push():
-    'Schema defaults overlaid with whatever is actually set locally.'
-    return ENV_KEYS | filter_keys(_load_env(), in_(ENV_KEYS))
+    'Schema defaults overlaid with the local values, leaving out keys with no value so GitHub never stores "None".'
+    return {{k: v for k, v in (ENV_KEYS | filter_keys(_load_env(), in_(ENV_KEYS))).items() if v not in (None, 'None', '')}}
 
 def init_gheasy():
     cfg = GheasyConfig.load(ROOT)
@@ -181,13 +181,14 @@ runs whatever this file says.
     python deploy.py compose
     python deploy.py deploy
     python deploy.py status
-    python deploy.py nuke
+    python deploy.py rollback [tag]
+    python deploy.py nuke [--tunnel]
 """
 import os, sys, secrets
 from fastcore.all import Path
 from dockeasy import detect_app, env_set, env_get
 from cfeasy import CF
-from vpseasy import caddy_stack, hetzner_deploy, Hetzner
+from vpseasy import caddy_stack, hetzner_deploy, Hetzner, wait_http, rollback as vps_rollback
 
 root = Path(__file__).resolve().parent
 app, domain, subdomain = {app!r}, {domain!r}, {subdomain!r}
@@ -269,6 +270,22 @@ def deploy(force=None):
     env_set('HETZNER_IP', r.ip, path=root/'.env')
     if r.key: env_set('HETZNER_KEY', r.key, path=root/'.env')
     print(f'deployed: https://{{host}} at {{r.ip}}')
+    after_deploy(cf)
+
+def after_deploy(cf):
+    \'\'\'Wait until the site answers, then purge Cloudflare's cache for the host so visitors get the new pages.
+    vpseasy's deploy already keeps the replaced image for `rollback` and prunes dangling images.
+    Empty this function to skip both steps.\'\'\'
+    if not wait_http(f'https://{{host}}/', ua=f'{{app}}-deploy', tries=20): return print('site not answering yet; cache not purged')
+    try: cf.purge(cf.zone_id(domain), prefixes=[f'{{host}}/'], fallback_all=False); print('cache purged:', host)
+    except Exception as e: print(f'cache not purged: {{e}}')
+
+def rollback(to=None):
+    "Run the image before the last deploy, or the kept image tagged `to`."
+    ip = env_get('HETZNER_IP', path=root/'.env')
+    if not ip: return print('no server yet')
+    vps_rollback(ip, to, path=srv, user=env_get('SERVER_USER', path=root/'.env', default='deploy'),
+                 key=env_get('HETZNER_KEY', path=root/'.env', default=None))
 
 def status():
     "Which servers exist on this token, and which tunnels."
@@ -278,14 +295,17 @@ def status():
     for t in cf.tunnels(): print(f'tunnel {{t.get("name","")!r:22}} {{t.get("id","")}}')
     print(f'this project deploys as {{name}} -> {{host}}')
 
-def nuke():
-    "Delete the server and the tunnel. Irreversible, so it asks for a token you have to read."
+def nuke(tunnel=False):
+    \'\'\'Delete the server, and with `tunnel` the tunnel too. Irreversible, so it asks for a token you have to read.
+    The tunnel serves the site from whichever box runs its connector, so after a move to a new server keep it.\'\'\'
     typ = secrets.token_urlsafe(8)
-    if input(f'This deletes the server and the tunnel. Type {{typ}} to proceed: ') != typ:
+    what = 'the server and the tunnel' if tunnel else 'the server'
+    if input(f'This deletes {{what}}. Type {{typ}} to proceed: ') != typ:
         return print('aborted')
     name = env_get('SERVER_NAME', path=root/'.env', default=app)
     Hetzner().delete(name)
     print(f'server {{name}} deleted')
+    if not tunnel: return print('tunnel kept (python deploy.py nuke --tunnel deletes it)')
     try:
         cf = CF(token=env_get('CLOUDFLARE_API_TOKEN', path=root/'.env'))
         cf.delete_tunnel(cf.tunnel_id(tunnel_name))
@@ -299,8 +319,9 @@ if __name__ == '__main__':
     elif cmd == 'env': mk_env()
     elif cmd == 'deploy': deploy(force=args[1] if len(args) > 1 else None)
     elif cmd == 'status': status()
-    elif cmd == 'nuke': nuke()
-    else: print('usage: deploy.py env | compose | deploy | status | nuke')
+    elif cmd == 'rollback': rollback(args[1] if len(args) > 1 else None)
+    elif cmd == 'nuke': nuke(tunnel='--tunnel' in args)
+    else: print('usage: deploy.py env | compose | deploy | status | rollback [tag] | nuke [--tunnel]')
 '''
 
 # %% ../nbs/03_deploy.ipynb #d11ca8b9
@@ -313,9 +334,9 @@ class Deploy(Pipeline):
     def target(self):
         "Where this deploy goes, which secrets are still unset, and which generated files exist."
         store = self.env if isinstance(self.env, EnvStore) else EnvStore()
-        def value(key, default=''): return env_value(store, key, default)
+        def value(key, default=''): return env_value(store, key) or env_value(store, key.lower(), default)
         missing = [k for k, v in DEPLOY_KEYS.items()
-                   if v is None and not env_value(store, k, secret=True)]
+                   if v is None and not (env_value(store, k, secret=True) or env_value(store, k.lower(), secret=True))]
         return {'app': value('APP') or self.root.name, 'domain': value('DOMAIN'),
             'server': value('SERVER_NAME'), 'user': value('SERVER_USER', 'deploy'),
             'port': value('PORT', '5001'), 'missing': missing,

{pullup-0.0.7 → pullup-0.0.9}/pullup/env.py

@@ -99,7 +99,7 @@ class EnvStore:
         return {'key': key, 'secret': bool(secret)}
     def unset(self, key):
         "Remove a value from the keychain, the env file and `os.environ`, and say which of the first two held it."
-        from dockeasy.core import _FASTOPS_ENV
+        from dockeasy.core import FASTOPS_ENV
         from dotenv import unset_key
         key, gone = str(key), []
         try:
@@ -108,7 +108,7 @@ class EnvStore:
                 keyring.delete_password(self.service, key)
                 gone.append('keychain')
         except Exception: pass
-        path = str(self.path or _FASTOPS_ENV)
+        path = str(self.path or FASTOPS_ENV)
         try:
             removed, _ = unset_key(path, key)
             if removed: gone.append('env file')

{pullup-0.0.7 → pullup-0.0.9}/pullup/project.py

@@ -64,13 +64,13 @@ def app_project(root):
 
 # %% ../nbs/01_project.ipynb #3b3306e1
 NBDEV_STEPS = [
-    Step('prepare', 'nbdev_prepare', 'nbdev_prepare',
+    Step('prepare', 'nbdev-prepare', 'nbdev-prepare',
         'Export the notebooks, run the tests, clean the metadata, rebuild the README.'),
-    Step('bump', 'bump version', 'nbdev_bump_version',
+    Step('bump', 'bump version', 'nbdev-bump-version',
         'Raise the version in settings.ini and commit it.'),
-    Step('gh', 'GitHub release', 'nbdev_release_gh',
+    Step('gh', 'GitHub release', 'nbdev-release-gh',
         'Tag the version and create the GitHub release from CHANGELOG.', ['GITHUB_TOKEN']),
-    Step('pypi', 'PyPI release', 'nbdev_pypi',
+    Step('pypi', 'PyPI release', 'nbdev-pypi',
         'Build the wheel and upload it to PyPI.', ['TWINE_USERNAME', 'TWINE_PASSWORD']),
 ]
 

{pullup-0.0.7 → pullup-0.0.9}/pullup/wfbuild.py

@@ -72,9 +72,9 @@ PRESETS = [
             'doc': 'Defaults to the project name.'}]},
     {'id': 'node', 'job': 'frontend', 'name': 'Node build', 'doc': 'npm ci, build, test.',
         'options': []},
-    {'id': 'rust', 'job': 'build', 'name': 'Rust build', 'doc': 'cargo build, test, clippy.',
+    {'id': 'rust', 'job': 'rust', 'name': 'Rust build', 'doc': 'cargo build, test, clippy.',
         'options': []},
-    {'id': 'go', 'job': 'build', 'name': 'Go build', 'doc': 'go build, test, vet.', 'options': []},
+    {'id': 'go', 'job': 'go', 'name': 'Go build', 'doc': 'go build, test, vet.', 'options': []},
     {'id': 'deploy', 'job': 'deploy', 'name': 'Deploy to a VPS',
         'doc': 'Every key in env_schema as a secret or a variable, the deploy key, then your '
         'deploy command. The shape lego uses.',

{pullup-0.0.7 → pullup-0.0.9}/pullup/workflows.py

@@ -4,7 +4,7 @@
 from __future__ import annotations
 
 # %% auto #0
-__all__ = ['WORKFLOW_DIR', 'WorkflowError', 'levels', 'Workflows']
+__all__ = ['WORKFLOW_DIR', 'WorkflowError', 'gheasy_core', 'levels', 'Workflows']
 
 # %% ../nbs/05_workflows.ipynb #13d36d32
 import re
@@ -29,13 +29,16 @@ class WorkflowError(RuntimeError):
     pass
 
 # %% ../nbs/05_workflows.ipynb #21f04074
-def _gheasy():
+def gheasy_core():
+    'Return the `gheasy.core` module, raising `WorkflowError` with the install hint when gheasy is missing.'
     try:
         import gheasy.core as core
         return core
     except ImportError as e:
         raise WorkflowError(needs_extra('this needs gheasy')) from e
 
+_gheasy = gheasy_core
+
 def _opened(core, name, was=None):
     "gheasy's helper under whichever spelling it has: public from 0.0.10, underscored before it."
     for n in (name, was or f'_{name}'):
@@ -46,8 +49,8 @@ def _opened(core, name, was=None):
 def _yaml():
     "gheasy's ruamel instance for reading a workflow, or plain pyyaml where gheasy is not installed."
     try:
-        import gheasy.workflow as w
-        if (mk := getattr(w, 'yaml_instance', None) or getattr(w, '_yaml_instance', None)): return mk()
+        from gheasy.workflow import yaml_instance
+        return yaml_instance()
     except ImportError: pass
     import yaml
     class _Plain:
@@ -146,12 +149,12 @@ class Workflows:
     def repo(self):
         "`owner/name` from the origin remote, or `''` when there is no GitHub remote."
         try:
-            core = _gheasy()
+            core = gheasy_core()
             owner, name = _opened(core, 'repo_slug', '_get_repo_slug')(str(self.root))
             return f'{owner}/{name}'
         except Exception: return ''
     def _api(self):
-        core = _gheasy()
+        core = gheasy_core()
         token = _opened(core, 'gh_token', '_resolve_gh_token')()
         if not token:
             raise WorkflowError('set GITHUB_TOKEN — add it in Environment below, or export it before starting Leela')
@@ -161,7 +164,7 @@ class Workflows:
         "Whether the GitHub features can be used, and if not, whether gheasy, a remote or a token is missing."
         row = {'gheasy': True, 'dockeasy': installed('dockeasy'), 'repo': '', 'token': False,
             'gh_cli': bool(which('gh')), 'gh_auth': _gh_authed(), 'why': ''}
-        try: core = _gheasy()
+        try: core = gheasy_core()
         except WorkflowError as e: return row | {'gheasy': False, 'why': str(e)}
         row['repo'] = self.repo()
         row['token'] = bool(_opened(core, 'gh_token', '_resolve_gh_token')())
@@ -190,7 +193,7 @@ class Workflows:
         "Start a run of a workflow that declares `workflow_dispatch`."
         owner, name, api = self._api()
         if not str(workflow).strip(): raise WorkflowError('choose a workflow to run')
-        ref = str(ref or '').strip() or _gheasy()._git_branch(str(self.root))
+        ref = str(ref or '').strip() or gheasy_core()._git_branch(str(self.root))
         api.actions.create_workflow_dispatch(workflow_id=str(workflow), ref=ref, inputs=dict(inputs or {}))
         return {'workflow': str(workflow), 'ref': ref}
     def cancel(self, run_id):
@@ -200,19 +203,19 @@ class Workflows:
         return {'cancelled': int(run_id)}
     def config(self):
         "The project's `.gheasy/config.json`, or None when gheasy has not been set up here."
-        try: core = _gheasy()
+        try: core = gheasy_core()
         except WorkflowError: return None
         if not core.cfg_path(str(self.root)).exists(): return None
         return core.GheasyConfig.load(str(self.root)).to_dict()
     def generate(self):
         "The workflow gheasy would write for this project, as text, without writing it."
-        core = _gheasy()
+        core = gheasy_core()
         if not core.cfg_path(str(self.root)).exists():
             raise WorkflowError('this project has no .gheasy/config.json to generate from')
         return core.mk_workflow(core.GheasyConfig.load(str(self.root)))
     def write_generated(self):
         "Write gheasy's generated workflow with `gh_workflow`, as the gheasy CLI does; nothing is committed."
-        core = _gheasy()
+        core = gheasy_core()
         if not core.cfg_path(str(self.root)).exists():
             raise WorkflowError('this project has no .gheasy/config.json to generate from')
         core.gh_workflow(path=str(self.root))
@@ -307,13 +310,13 @@ class Workflows:
         return wfb.build()
     def build(self, spec):
         "The YAML for a workflow-builder spec, composed with gheasy."
-        _gheasy()
+        gheasy_core()
         from .wfbuild import compose
         cfg = self.config() or {}
         return compose(spec, schema=self.schema(), app=str(cfg.get('app') or self.root.name))
     def write_spec(self, spec, file=''):
         "Write the YAML for a spec into `.github/workflows` and save the spec beside it."
-        _gheasy()
+        gheasy_core()
         from .wfbuild import save_spec
         name = _wf_name(str(file or spec.get('file') or f"{spec.get('name') or 'ci'}.yml"))
         text = self.build(spec)
@@ -334,11 +337,11 @@ class Workflows:
         return {'spec': spec, 'stale': stale}
     def preview(self, choice):
         "The YAML a catalogue entry would write, without writing it."
-        _gheasy()
+        gheasy_core()
         return self._build(str(choice)).to_yaml()
     def add(self, choice, file=''):
         "Write one catalogue entry into `.github/workflows`; raises if the file exists."
-        _gheasy()
+        gheasy_core()
         rows = {r['id']: r for r in self.catalogue()['workflows']}
         row = rows.get(str(choice))
         if row is None: raise WorkflowError(f'unknown workflow: {choice}')
@@ -381,7 +384,7 @@ class Workflows:
         return {'secrets': secrets, 'variables': variables}
     def push_env(self, values, keys=(), dry_run=False):
         "Push values for the declared keys to GitHub through gheasy, one result row per key."
-        core = _gheasy()
+        core = gheasy_core()
         if not which('gh'):
             raise WorkflowError('pushing secrets uses the GitHub CLI: install `gh` and run `gh auth login`')
         schema = self.schema()

{pullup-0.0.7 → pullup-0.0.9}/pyproject.toml

@@ -12,8 +12,8 @@ license = {text = "Apache-2.0"}
 authors = [{name = "Karthik Rajgopal", email = "karthik.rajgopal@hotmail.com"}]
 keywords = ['nbdev', 'jupyter', 'notebook', 'python']
 classifiers = ["Natural Language :: English", "Intended Audience :: Developers", "Development Status :: 3 - Alpha", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only"]
-dependencies = ['fastcore>=1.8.17', 'ptymini>=0.0.5', 'pyyaml>=6.0', 'dockeasy>=0.0.5',
-                'gheasy>=0.0.10', 'vpseasy>=0.0.18', 'cfeasy>=0.0.4', 'python-dotenv>=1.0.0',
+dependencies = ['fastcore>=1.8.17', 'ptymini>=0.0.5', 'pyyaml>=6.0', 'dockeasy>=0.0.10',
+                'gheasy>=0.0.10', 'vpseasy>=0.0.24', 'cfeasy>=0.0.6', 'python-dotenv>=1.0.0',
                 'keyring>=25.0.0']
 
 [project.urls]