hlsync 1.20.1__tar.gz

hlsync-1.20.1/LICENSE

@@ -0,0 +1,106 @@
+Required Notice: Copyright (c) 2026 HLSync contributors (https://github.com/ediril/hlsync)
+
+# PolyForm Strict License 1.0.0
+
+<https://polyformproject.org/licenses/strict/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software
+to do everything you might do with the software that would
+otherwise infringe the licensor's copyright in it for any
+permitted purpose, other than distributing the software or
+making changes or new works based on the software.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization,
+or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else.  These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice.  Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization.  **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

hlsync-1.20.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include version.json
+include build_backend/*.py
+include src/hlsync/_version.py

hlsync-1.20.1/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: hlsync
+Version: 1.20.1
+Summary: Synchronize local files with remote servers over explicit FTPS
+Author: HLSync contributors
+License-Expression: LicenseRef-PolyForm-Strict-1.0.0
+Project-URL: Homepage, https://github.com/ediril/hlsync
+Project-URL: Changelog, https://github.com/ediril/hlsync/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/ediril/hlsync/issues
+Project-URL: Repository, https://github.com/ediril/hlsync.git
+Keywords: deployment,ftp,ftps,synchronization
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Archiving :: Backup
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pathspec<2,>=0.12.1
+Provides-Extra: dev
+Requires-Dist: build<2,>=1; extra == "dev"
+Requires-Dist: pyftpdlib[ssl]<3,>=2.0; extra == "dev"
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: ruff<1,>=0.12; extra == "dev"
+Requires-Dist: setuptools>=77; extra == "dev"
+Requires-Dist: twine<7,>=6; extra == "dev"
+Dynamic: license-file
+
+# HLSync
+
+HLSync (`hlsync`) is a command-line workflow for deploying local
+projects to shared hosting over explicit FTP over TLS (FTPS): map once, preview
+the diff, then push the intended files.
+
+HLSync is pre-alpha software. Commands and configuration may change before a
+stable release.
+
+## Who is it for?
+
+HLSync is for people who still deploy websites or small projects to shared hosting over FTP.
+
+If your current process is basically “figure out which files changed and upload them,” HLSync gives you a safer, more repeatable version of that workflow without requiring a full deployment system.
+
+It works best when your local project is the source of truth and the remote server is simply where the project gets deployed.
+
+## Installation
+
+HLSync requires Python 3.10 or newer. Install it from PyPI as an isolated
+command-line tool with uv:
+
+```console
+uv tool install hlsync
+```
+
+Upgrade later with:
+
+```console
+uv tool upgrade hlsync
+```
+
+The FTPS server must support explicit TLS with protected data connections
+(`AUTH TLS` and `PROT P`). HLSync prefers MLSD listings; servers without MLSD
+use Unix-style LIST listings with SIZE and MDTM for exact file metadata.
+LIST mode includes dotfiles and requires two extra requests per file. Push additionally
+requires MFMT (or writable MDTM on vsFTPd) and MDTM read-back to apply and verify
+uploaded-file timestamps.
+
+## Quick start
+
+HLSync reads credentials from environment variables. The defaults are:
+
+```text
+PROD_FTPS_USERNAME
+PROD_FTPS_PASSWORD
+```
+
+From the local project root:
+
+```console
+hlsync create prod --host ftp.example.com --remote-root /public_html/site
+hlsync connect
+hlsync exclude node_modules
+hlsync diff
+hlsync push
+```
+
+`create` proposes the current directory as the local root; pressing Enter accepts
+it. Declining prompts for another local folder. Use `--local-root PATH` to
+provide one directly. Both `diff` and `push` recurse by default. Use `-s` /
+`--shallow` to process only the selected folder's immediate contents.
+
+## Everyday commands
+
+```console
+hlsync profiles                  # list profiles; * marks the current one
+hlsync exclude node_modules      # keep a path out of deployments
+hlsync include 'static/*.webp'   # bring back Git-ignored files
+hlsync rules                     # show rules and applied .gitignore patterns
+hlsync list -r                   # local tree with exclusions marked
+hlsync diff                      # what push would change, read-only
+hlsync push --dry                # preview the exact push
+hlsync push                      # upload new and changed files
+hlsync pull index.html           # replace a local file from the server
+```
+
+HLSync honors `.gitignore` files automatically. Push never deletes remote files
+unless you pass `-p` / `--prune`, and it stops before overwriting a file that is
+newer on the server. Each upload is staged beside its destination and verified
+before it replaces the live file.
+
+## Documentation
+
+- [Profiles and mapping](https://github.com/ediril/hlsync/blob/main/docs/profiles.md):
+  profiles, credentials, local and remote roots, and running commands from
+  anywhere.
+- [Synchronization rules](https://github.com/ediril/hlsync/blob/main/docs/rules.md):
+  `.gitignore` handling, common and profile rules, wildcards, and remote
+  protection.
+- [Paths, traversal, and listing](https://github.com/ediril/hlsync/blob/main/docs/paths-and-listing.md):
+  how paths select files, recursion depth, and `list`.
+- [Diff](https://github.com/ediril/hlsync/blob/main/docs/diff.md):
+  status markers, pruning previews, and wider views.
+- [Push and pull](https://github.com/ediril/hlsync/blob/main/docs/push-and-pull.md):
+  conflicts, deletion, progress, and safe file replacement.
+- [Development and maintenance](https://github.com/ediril/hlsync/blob/main/docs/development.md):
+  testing local changes, switching installs, and releasing.
+
+## Command behavior
+
+Commands accept the shortest unique prefix. Exact names win. An ambiguous
+prefix prompts for a numbered choice on an interactive terminal and fails with
+the candidate list in noninteractive use.
+
+Use `hlsync help [command]`, `hlsync version`, and `hlsync --legend` for
+built-in reference. `hlsync v`, `hlsync -v`, and `hlsync --version` also print
+the installed version.
+
+## License
+
+HLSync is source-available under the [PolyForm Strict License 1.0.0](https://github.com/ediril/hlsync/blob/main/LICENSE).
+Use is free of charge for the purposes permitted by that license, including:
+
+- Any noncommercial purpose.
+- The personal uses listed in the license, such as personal study and hobby
+  projects, without any anticipated commercial application.
+- Use by charitable organizations, educational institutions, public research
+  organizations, public safety or health organizations, environmental protection
+  organizations, and government institutions, regardless of funding source or
+  obligations resulting from funding.
+
+This license grants no rights to modify or redistribute HLSync or create works
+based on it. The full license governs; this summary does not grant additional
+permissions.
+
+Commercial use outside those permissions requires a separate paid license.
+Contact [Emrah Diril](mailto:emrah@diril.org) for pricing and a commercial
+agreement before beginning such use.

hlsync-1.20.1/README.md

@@ -0,0 +1,129 @@
+# HLSync
+
+HLSync (`hlsync`) is a command-line workflow for deploying local
+projects to shared hosting over explicit FTP over TLS (FTPS): map once, preview
+the diff, then push the intended files.
+
+HLSync is pre-alpha software. Commands and configuration may change before a
+stable release.
+
+## Who is it for?
+
+HLSync is for people who still deploy websites or small projects to shared hosting over FTP.
+
+If your current process is basically “figure out which files changed and upload them,” HLSync gives you a safer, more repeatable version of that workflow without requiring a full deployment system.
+
+It works best when your local project is the source of truth and the remote server is simply where the project gets deployed.
+
+## Installation
+
+HLSync requires Python 3.10 or newer. Install it from PyPI as an isolated
+command-line tool with uv:
+
+```console
+uv tool install hlsync
+```
+
+Upgrade later with:
+
+```console
+uv tool upgrade hlsync
+```
+
+The FTPS server must support explicit TLS with protected data connections
+(`AUTH TLS` and `PROT P`). HLSync prefers MLSD listings; servers without MLSD
+use Unix-style LIST listings with SIZE and MDTM for exact file metadata.
+LIST mode includes dotfiles and requires two extra requests per file. Push additionally
+requires MFMT (or writable MDTM on vsFTPd) and MDTM read-back to apply and verify
+uploaded-file timestamps.
+
+## Quick start
+
+HLSync reads credentials from environment variables. The defaults are:
+
+```text
+PROD_FTPS_USERNAME
+PROD_FTPS_PASSWORD
+```
+
+From the local project root:
+
+```console
+hlsync create prod --host ftp.example.com --remote-root /public_html/site
+hlsync connect
+hlsync exclude node_modules
+hlsync diff
+hlsync push
+```
+
+`create` proposes the current directory as the local root; pressing Enter accepts
+it. Declining prompts for another local folder. Use `--local-root PATH` to
+provide one directly. Both `diff` and `push` recurse by default. Use `-s` /
+`--shallow` to process only the selected folder's immediate contents.
+
+## Everyday commands
+
+```console
+hlsync profiles                  # list profiles; * marks the current one
+hlsync exclude node_modules      # keep a path out of deployments
+hlsync include 'static/*.webp'   # bring back Git-ignored files
+hlsync rules                     # show rules and applied .gitignore patterns
+hlsync list -r                   # local tree with exclusions marked
+hlsync diff                      # what push would change, read-only
+hlsync push --dry                # preview the exact push
+hlsync push                      # upload new and changed files
+hlsync pull index.html           # replace a local file from the server
+```
+
+HLSync honors `.gitignore` files automatically. Push never deletes remote files
+unless you pass `-p` / `--prune`, and it stops before overwriting a file that is
+newer on the server. Each upload is staged beside its destination and verified
+before it replaces the live file.
+
+## Documentation
+
+- [Profiles and mapping](https://github.com/ediril/hlsync/blob/main/docs/profiles.md):
+  profiles, credentials, local and remote roots, and running commands from
+  anywhere.
+- [Synchronization rules](https://github.com/ediril/hlsync/blob/main/docs/rules.md):
+  `.gitignore` handling, common and profile rules, wildcards, and remote
+  protection.
+- [Paths, traversal, and listing](https://github.com/ediril/hlsync/blob/main/docs/paths-and-listing.md):
+  how paths select files, recursion depth, and `list`.
+- [Diff](https://github.com/ediril/hlsync/blob/main/docs/diff.md):
+  status markers, pruning previews, and wider views.
+- [Push and pull](https://github.com/ediril/hlsync/blob/main/docs/push-and-pull.md):
+  conflicts, deletion, progress, and safe file replacement.
+- [Development and maintenance](https://github.com/ediril/hlsync/blob/main/docs/development.md):
+  testing local changes, switching installs, and releasing.
+
+## Command behavior
+
+Commands accept the shortest unique prefix. Exact names win. An ambiguous
+prefix prompts for a numbered choice on an interactive terminal and fails with
+the candidate list in noninteractive use.
+
+Use `hlsync help [command]`, `hlsync version`, and `hlsync --legend` for
+built-in reference. `hlsync v`, `hlsync -v`, and `hlsync --version` also print
+the installed version.
+
+## License
+
+HLSync is source-available under the [PolyForm Strict License 1.0.0](https://github.com/ediril/hlsync/blob/main/LICENSE).
+Use is free of charge for the purposes permitted by that license, including:
+
+- Any noncommercial purpose.
+- The personal uses listed in the license, such as personal study and hobby
+  projects, without any anticipated commercial application.
+- Use by charitable organizations, educational institutions, public research
+  organizations, public safety or health organizations, environmental protection
+  organizations, and government institutions, regardless of funding source or
+  obligations resulting from funding.
+
+This license grants no rights to modify or redistribute HLSync or create works
+based on it. The full license governs; this summary does not grant additional
+permissions.
+
+Commercial use outside those permissions requires a separate paid license.
+Contact [Emrah Diril](mailto:emrah@diril.org) for pricing and a commercial
+agreement before beginning such use.

hlsync-1.20.1/build_backend/hlsync_build.py

@@ -0,0 +1,32 @@
+"""Setuptools build hooks that freeze the Git version into every artifact."""
+
+from functools import wraps
+from pathlib import Path
+
+from setuptools import build_meta
+from versioning import write_version
+
+ROOT = Path(__file__).resolve().parents[1]
+
+
+def versioned(hook):
+    @wraps(hook)
+    def run(*args, **kwargs):
+        write_version(ROOT)
+        return hook(*args, **kwargs)
+
+    return run
+
+
+get_requires_for_build_wheel = versioned(build_meta.get_requires_for_build_wheel)
+get_requires_for_build_sdist = versioned(build_meta.get_requires_for_build_sdist)
+get_requires_for_build_editable = versioned(build_meta.get_requires_for_build_editable)
+prepare_metadata_for_build_wheel = versioned(
+    build_meta.prepare_metadata_for_build_wheel
+)
+prepare_metadata_for_build_editable = versioned(
+    build_meta.prepare_metadata_for_build_editable
+)
+build_wheel = versioned(build_meta.build_wheel)
+build_sdist = versioned(build_meta.build_sdist)
+build_editable = versioned(build_meta.build_editable)

hlsync-1.20.1/build_backend/versioning.py

@@ -0,0 +1,75 @@
+"""Advance a starting release version along its baseline's first-parent history."""
+
+from __future__ import annotations
+
+import json
+import re
+import subprocess
+from datetime import datetime
+from email.parser import Parser
+from pathlib import Path
+
+VERSION_PATTERN = re.compile(r"[1-9][0-9]*\.(?:0|[1-9][0-9]*)\.[1-9][0-9]*")
+
+
+def git_version(root: Path) -> str:
+    baseline = json.loads((root / "version.json").read_text())
+    version, commit = baseline["version"], baseline["commit"]
+    if (
+        not isinstance(version, str)
+        or VERSION_PATTERN.fullmatch(version) is None
+        or not isinstance(commit, str)
+        or re.fullmatch(r"[0-9a-f]{40}", commit) is None
+    ):
+        raise ValueError(
+            "version.json requires a valid starting version and a full commit SHA"
+        )
+    major, work_day, increment = map(int, version.split("."))
+    result = subprocess.run(
+        ["git", "log", "--first-parent", "--format=%H %cI", "HEAD"],
+        cwd=root,
+        capture_output=True,
+        text=True,
+        check=True,
+    )
+    dates = []
+    for line in result.stdout.splitlines():
+        sha, timestamp = line.split()
+        dates.append(datetime.fromisoformat(timestamp).date())
+        if sha == commit:
+            break
+    else:
+        raise ValueError(
+            "version baseline is missing from first-parent history; "
+            "fetch the full history or correct version.json"
+        )
+    if dates != sorted(dates, reverse=True):
+        raise ValueError("commit dates go backwards in the version baseline's history")
+    work_day += len(set(dates)) - 1
+    daily_commits = dates.count(dates[0])
+    if dates[0] == dates[-1]:
+        daily_commits += increment - 1
+    return f"{major}.{work_day}.{daily_commits}"
+
+
+def release_version(root: Path) -> str:
+    if (root / ".git").exists():
+        return git_version(root)
+
+    # An sdist carries the version fixed when it was built, without needing Git.
+    metadata = root / "PKG-INFO"
+    if not metadata.is_file():
+        raise ValueError("version requires a Git checkout or a built source archive")
+    version = Parser().parsestr(metadata.read_text())["Version"]
+    if version is None or VERSION_PATTERN.fullmatch(version) is None:
+        raise ValueError("source archive has an invalid release version")
+    return version
+
+
+def write_version(root: Path) -> str:
+    version = release_version(root)
+    path = root / "src" / "hlsync" / "_version.py"
+    content = f'# Generated at build time; do not edit.\n__version__ = "{version}"\n'
+    if not path.exists() or path.read_text() != content:
+        path.write_text(content)
+    return version

hlsync-1.20.1/pyproject.toml

@@ -0,0 +1,71 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "hlsync_build"
+backend-path = ["build_backend"]
+
+[project]
+name = "hlsync"
+dynamic = ["version"]
+description = "Synchronize local files with remote servers over explicit FTPS"
+readme = "README.md"
+license = "LicenseRef-PolyForm-Strict-1.0.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+dependencies = ["pathspec>=0.12.1,<2"]
+authors = [{ name = "HLSync contributors" }]
+keywords = ["deployment", "ftp", "ftps", "synchronization"]
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Environment :: Console",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: System :: Archiving :: Backup",
+]
+[project.urls]
+Homepage = "https://github.com/ediril/hlsync"
+Changelog = "https://github.com/ediril/hlsync/blob/main/CHANGELOG.md"
+Issues = "https://github.com/ediril/hlsync/issues"
+Repository = "https://github.com/ediril/hlsync.git"
+
+[project.optional-dependencies]
+dev = [
+  "build>=1,<2",
+  "pyftpdlib[ssl]>=2.0,<3",
+  "pytest>=8,<10",
+  "ruff>=0.12,<1",
+  "setuptools>=77",
+  "twine>=6,<7",
+]
+
+[project.scripts]
+hlsync = "hlsync.cli:main"
+
+[tool.setuptools.dynamic]
+version = { attr = "hlsync._version.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.uv]
+cache-keys = [
+  { file = "pyproject.toml" },
+  { file = "version.json" },
+  { file = "build_backend/*.py" },
+  { git = { commit = true } },
+]
+
+[tool.pytest.ini_options]
+addopts = "-ra"
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]

hlsync-1.20.1/setup.cfg

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

hlsync-1.20.1/src/hlsync/__init__.py

@@ -0,0 +1,5 @@
+"""HLSync."""
+
+from ._version import __version__
+
+__all__ = ["__version__"]

hlsync-1.20.1/src/hlsync/__main__.py

@@ -0,0 +1,4 @@
+from hlsync.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())

hlsync-1.20.1/src/hlsync/_version.py

@@ -0,0 +1,2 @@
+# Generated at build time; do not edit.
+__version__ = "1.20.1"