git-ftp 2.0.0.dev0__py3-none-any.whl

git_ftp-2.0.0.dev0.dist-info/METADATA

@@ -0,0 +1,243 @@
+Metadata-Version: 2.5
+Name: git-ftp
+Version: 2.0.0.dev0
+Summary: Git powered FTP/FTPS/FTPES/SFTP client: deploy a Git repository by uploading only the files that changed since the last deployment. Native Python port of git-ftp.
+Project-URL: Homepage, https://github.com/resmo/git-ftp
+Project-URL: Documentation, https://github.com/resmo/git-ftp/blob/main/docs/git-ftp.1.md
+Project-URL: Changelog, https://github.com/resmo/git-ftp/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/resmo/git-ftp/issues
+Project-URL: Upstream, https://github.com/git-ftp/git-ftp
+Author-email: René Moser <mail@renemoser.net>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Keywords: deploy,deployment,ftp,ftps,git,git-ftp,sftp
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Internet :: File Transfer Protocol (FTP)
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: System :: Software Distribution
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: click<9,>=8.2
+Requires-Dist: paramiko<6,>=3.4
+Requires-Dist: pycurl<8,>=7.46
+Description-Content-Type: text/markdown
+
+# git-ftp (Python)
+
+This is a native Python port of the Bash [git-ftp](https://github.com/git-ftp/git-ftp): deploy a
+Git repository to a server over **FTP, FTPS, FTPES or SFTP**, uploading only the
+files that changed since the last deployment.
+
+git-ftp records the deployed commit in a file on the remote (`.git-ftp.log`).
+On the next push it diffs that commit against `HEAD` and transfers exactly the
+files that were added, modified or deleted, in parallel. No server-side
+software is needed.
+
+If your server forbids writing dot-files (some hardened FTP servers reject any
+name starting with a `.`), set a non-dot-file name with
+`git config git-ftp.deployedsha1file gitftp.log`.
+
+This port reads the same configuration and the same remote files as the Bash
+original, so an existing deployment carries over unchanged. It needs Python 3.10
+or newer and `git`; libcurl comes bundled with the `pycurl` wheel and SFTP is
+spoken by `paramiko`. See [COMPATIBILITY.md](COMPATIBILITY.md) for what was
+kept, fixed and added.
+
+## Install
+
+```sh
+uv tool install git-ftp      # or: pipx install git-ftp, pip install git-ftp
+git ftp --version
+```
+
+Git runs the `git-ftp` script as `git ftp` when it is on your `PATH`.
+
+## Usage
+
+```sh
+# First deployment: upload everything and record the commit.
+git ftp init -u alice -P ftp://example.com/public_html
+
+# Every deployment after that: only what changed.
+git ftp push -u alice -P ftp://example.com/public_html
+
+# The remote already has the current files? Just record the commit.
+git ftp catchup ftp://example.com/public_html
+
+# What is deployed?
+git ftp show
+git ftp log
+```
+
+`-P` prompts for the password. Better than typing it every time:
+
+```sh
+git config git-ftp.url ftp://example.com/public_html
+git config git-ftp.user alice
+git config git-ftp.password s3cret                    # or:
+git config git-ftp.password-command "pass show example.com/ftp"
+git ftp push
+```
+
+In CI, `GIT_FTP_URL`, `GIT_FTP_USER` and `GIT_FTP_PASSWORD` do the same without
+touching any file.
+
+### Scopes
+
+Several targets in one repository:
+
+```sh
+git ftp add-scope production ftp://alice:s3cret@live.example.com/htdocs
+git ftp add-scope staging   ftp://alice:s3cret@staging.example.com/htdocs
+git ftp push -s production
+git ftp push -s             # bare -s: the current branch name is the scope
+```
+
+Scope keys (`git-ftp.<scope>.<key>`) override the plain keys; an explicit empty
+scope value masks the default.
+
+### Protocols
+
+| URL | Transport | Encryption |
+|---|---|---|
+| `ftp://host/path` | libcurl | none |
+| `ftpes://host/path` | libcurl | explicit TLS (`AUTH TLS`), data channel too |
+| `ftps://host/path` | libcurl | implicit TLS (port 990) |
+| `sftp://host/path` | paramiko | SSH |
+
+TLS certificates are verified; use `--cacert FILE` for a private CA or
+`--insecure` to skip verification. SFTP host keys are checked against
+`~/.ssh/known_hosts` (`ssh-keyscan host >> ~/.ssh/known_hosts` to add one).
+SFTP authenticates with `--key FILE` (`--key-passphrase` for encrypted keys),
+a running `ssh-agent`, or a password. `sftp://host/~/dir` and
+`sftp://host//absolute/dir` work as in curl.
+
+### Choosing what to deploy
+
+- `--syncroot DIR` deploys only `DIR`, with `DIR` as the remote root.
+- `.git-ftp-ignore` lists shell globs of Git paths never to upload (`*` also
+  matches `/`, and a pattern must match the whole path).
+- `.git-ftp-include` uploads untracked files: `!VERSION.txt` always, or
+  `css/style.css:scss/style.scss` whenever the tracked source changed. A
+  directory target (`vendor/:composer.lock`) uploads everything below it.
+- `--dry-run` shows the plan; `-a` uploads everything; `-c SHA` diffs against
+  a specific commit; `-b BRANCH` deploys another branch.
+
+### Parallel transfers
+
+Files are transferred over up to four connections. `--jobs N` or
+`git config git-ftp.jobs N` changes that; `--jobs 1` is sequential. Uploads
+happen first, then deletes, and the commit log is written last, only when every
+upload succeeded, so an interrupted deploy never claims a commit it did not
+finish. Ctrl-C stops promptly.
+
+### Consistent uploads while editing
+
+`--worktree`, or `git config git-ftp.worktree true`, reads the files to upload
+from a throwaway Git worktree checked out at the commit being deployed. Editing
+the working tree while a long upload runs then cannot change what is sent. The
+worktree is removed when the deploy finishes.
+
+### Hooks and locking
+
+`.git/hooks/pre-ftp-push` (veto with a non-zero exit; skipped by `--no-verify`)
+and `post-ftp-push` (`--enable-post-errors` makes its failure fatal) receive
+`<scope-or-host> <url> <local-commit> <deployed-commit>`; the pre hook also gets
+the NUL-separated `A path` / `D path` change list on stdin.
+
+`--lock` writes `git-ftp.lck` on the remote for the duration of the deploy;
+another deploy of a different commit is refused with exit 7. `git ftp unlock`
+removes a stale lock.
+
+### download, pull, snapshot
+
+These mirror the remote into the working tree:
+
+```sh
+git ftp download   # remote -> working tree (refuses to run with untracked files)
+git ftp pull       # download into a commit on the deployed revision, then merge
+git ftp snapshot ftp://example.com/htdocs [dir]   # new repository from a remote
+```
+
+`--changed-only` limits `pull` to files that changed locally as well;
+`--no-commit` (or `git-ftp.no-commit`) leaves the merge uncommitted.
+
+### Exit codes
+
+| Code | Meaning |
+|---|---|
+| 0 | success |
+| 1 | unexpected error |
+| 2 | wrong usage |
+| 3 | missing argument |
+| 4 | error while uploading (also: remote unreachable, login failed) |
+| 5 | error while downloading (also: `push` before `init`) |
+| 6 | unknown protocol |
+| 7 | remote locked |
+| 8 | git error (not a repository, dirty working tree, bad branch) |
+| 9 | hook failed |
+| 10 | local filesystem error |
+| 130 | interrupted |
+
+### Shell completion
+
+```sh
+eval "$(_GIT_FTP_COMPLETE=bash_source git-ftp)"   # zsh: zsh_source, fish: fish_source
+```
+
+## Development
+
+```sh
+uv sync --all-groups
+make lint typecheck test          # ruff, mypy, pytest (in-process FTP/FTPS/SFTP servers)
+make test-docker                  # pure-ftpd containers, Linux only
+```
+
+The manual page source is `docs/git-ftp.1.md` (`make man` renders it with
+pandoc).
+
+## Releasing
+
+The version is derived from the Git tag by `hatch-vcs`; there is no version
+string to edit. Pushing a `v*` tag runs `.github/workflows/publish.yml`, which
+builds the sdist and wheel and publishes them to PyPI via Trusted Publishing (no
+API token), then creates a GitHub release whose notes are the matching
+`CHANGELOG.md` section.
+
+One-time setup: on PyPI (and TestPyPI) add a Trusted Publisher for this
+repository with workflow `publish.yml` and environment `pypi` (`testpypi`), and
+create those two environments in the GitHub repository settings.
+
+To cut a release:
+
+```sh
+# 1. Move the entries under "## [Unreleased]" into a new "## [X.Y.Z]" section
+#    in CHANGELOG.md, then commit.
+$EDITOR CHANGELOG.md
+git add CHANGELOG.md
+git commit -m "Release X.Y.Z"
+
+# 2. Tag and push. The tag must be v<version>; the workflow checks that it
+#    matches the version hatch-vcs computes.
+git tag -a -m "Release X.Y.Z" vX.Y.Z
+git push origin main vX.Y.Z
+```
+
+Between tags, builds report a development version such as `X.Y.Z.devN+g<hash>`.
+To rehearse against TestPyPI without tagging, run the `publish` workflow manually
+(`workflow_dispatch`) with the TestPyPI option enabled.
+
+## License
+
+GPL-3.0-or-later

git_ftp-2.0.0.dev0.dist-info/RECORD

@@ -0,0 +1,47 @@
+gitftp/__init__.py,sha256=Ikw0WeYNfTvwao29aUjTv0Wii-3VQTk2OqEHBmYZjBs,152
+gitftp/__main__.py,sha256=R2mdiIGhhKqV_9HFeTZCHMraINwGoQECM5Vl6KhTMoY,93
+gitftp/_version.py,sha256=5cx8xbyFQHkRrcxRTV41be3RVchbQnxXn__oF3JNCek,533
+gitftp/auth.py,sha256=2-yLfqlXAxd3j1e0JPWw4BJDFjyLyGNA8pBHG7TD1TE,7133
+gitftp/changeset.py,sha256=zws4uFJkjkWIbpib7n31y_55lvOpMnOFduxmnVXVKBs,3012
+gitftp/config.py,sha256=7aRIOnWttITxg2CwYS7t0u50oHuIuDetTOJNnQYzP_g,5521
+gitftp/deploy.py,sha256=-fmAw41irkoaq2rm2IdVB6G60rb64K6xKRi-i1pQ0ek,13096
+gitftp/errors.py,sha256=A002wjwhKYl6iiHAPf9G_fSWij3BK79l10pXOirmwy8,1786
+gitftp/gitrepo.py,sha256=CAQoeYSJsG2IkjRbFfx1ynRyByXQwoygGyepe2767g0,11113
+gitftp/hooks.py,sha256=sbFKGN_Sb7laoQRyQPkHrpydt4-yWxqFuDm3n_fUDTw,809
+gitftp/ignore.py,sha256=4BuXrNJA8KfVZOJOM0HUqf0D8TYK6MU05nCGTOxdxxw,2566
+gitftp/include.py,sha256=d4MNvpGr2a3BWtDt9jdiv8Cd6sp7u4Ng6K0U4Jc6V4A,2822
+gitftp/lock.py,sha256=Z47EvYZnsbdqhz5EN4jGYZITLW8-z5Wxe1iPtUJxf9A,2838
+gitftp/mirror.py,sha256=pPJRSur9lRdWnO8KekGSRkipCcU2V3Ewey6zGrZSFKA,15703
+gitftp/options.py,sha256=S3jAPr_S4SoSqb456TldyADX-kV4TvU8-MXeyAAdvqU,2031
+gitftp/output.py,sha256=-RbYwddbix744xgvhhFDn74zuKHdfmEYJgCPOy-wfBA,4231
+gitftp/session.py,sha256=GNvqgipIweHuz76DyIfv8L1LeTBItKSgDeoVOQts4vM,6742
+gitftp/transfer.py,sha256=z6H_yegxNydAhTA-xDxGGAbdSRmpUq5RULbN7QcjQsk,8662
+gitftp/url.py,sha256=r8QG8nDK7aVl5HCmXAMVdTUW208-G5MjVqLT6vC4NM8,6696
+gitftp/version.py,sha256=8lmoEMp5HNbUFO7m8W08iX8_mpbSJ9chvoKZNGOWfJg,1094
+gitftp/cli/__init__.py,sha256=p4TZt-ssH_DQ1hnw1I1IXMHo7565h2FyBIbj_YTx5JA,3553
+gitftp/cli/cmd_add_scope.py,sha256=YSvScKeBaqj7j9WWPaKbmoubJx_jvHHTbV0e5rMCCME,665
+gitftp/cli/cmd_catchup.py,sha256=al1DPGQmKiOWy0g1SxIYG4MIsbrY5RvPArF1kTrxXUU,551
+gitftp/cli/cmd_download.py,sha256=MwTU43m76-fsthKWuNcNyYIbCtPysEt1Q66Z5ZBFUXg,560
+gitftp/cli/cmd_help.py,sha256=ENybtGgrezRYnEgZE9dYxGIdwFkP7Nu1rBdD4auWRBk,1012
+gitftp/cli/cmd_init.py,sha256=xz8oDypFRencBt6dNzL-ferUn_eQ1PAmhSPboZHF1C4,544
+gitftp/cli/cmd_log.py,sha256=h3DlFrZoCTHgsKfylTexEehGcQVqIoleIHOPx_60GlQ,1055
+gitftp/cli/cmd_pull.py,sha256=AhtrTVuHzPFjT5jgCUp2rgZcygNK2f-wzo-0gIsjOe8,551
+gitftp/cli/cmd_push.py,sha256=KyArvPAPkEGET51Su_H96ZU8n4MweYLRVAPloZxmdFA,558
+gitftp/cli/cmd_remove_scope.py,sha256=ZhRhI-jn9C74fl7hLU_8oW-5JwLNz2ff1dxFpjqEAm0,663
+gitftp/cli/cmd_show.py,sha256=6_GA3k_PctxhXYy3JGgrOWdQ_RmFpEsmUs3or2DYMXg,1060
+gitftp/cli/cmd_snapshot.py,sha256=-L99ZFY6jaz4o8G0FM4EwxsxnKPEMISaUjYNiRSCM34,639
+gitftp/cli/cmd_unlock.py,sha256=DdwkDBx1dE5LbBNZQZ8Qpi4w1xniW32S2shT9m7bi9g,553
+gitftp/cli/cmd_version.py,sha256=pReQfVTcqfBFu-wVAySOiGhNsIfA3TBOwtmCz9vLFtA,445
+gitftp/cli/group.py,sha256=sNOPb3h9Yq_1u6jPlSrgztJovpROyc1aLulwVHAV-Kw,1676
+gitftp/cli/options.py,sha256=756ZKpYFGXsxpOmrfW0I68d9Jk3uF03kLzZB5N0GLEA,6706
+gitftp/transport/__init__.py,sha256=bQ_mu6vtmO3tsXoler2LFZLVkkb8BK7dDpuz6_lcVhs,69
+gitftp/transport/base.py,sha256=6uZZYmwUl3EMPMeemTX7FIXcj44RmmFxydNlq9QwYIA,2641
+gitftp/transport/curlftp.py,sha256=xparXlXDwSrclHgT4SHoZAZYOr6guB8TwMywKrheTCY,14536
+gitftp/transport/listing.py,sha256=mH5K6lpaL-BRLIEod49r2j7HljsKkGJrnO9phiTV6rY,5301
+gitftp/transport/registry.py,sha256=eJdDxNeQPaKsgVGtEISmeB6egXpoCAXSxHjpcY5yNqM,2148
+gitftp/transport/sftp.py,sha256=nvoImAPR5iPYPZLNYlsNT3b4Kn5Q0Tp6OguLW8QVzpU,16459
+git_ftp-2.0.0.dev0.dist-info/METADATA,sha256=XfsCaxbV96QT_h4vXLIlVT8Cbvu5ltUzUIkkfw__3Bk,9108
+git_ftp-2.0.0.dev0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+git_ftp-2.0.0.dev0.dist-info/entry_points.txt,sha256=yWycBANI7-mO7zVD1tAsN6vDz6KaVD5gBB69-G1ooDA,44
+git_ftp-2.0.0.dev0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+git_ftp-2.0.0.dev0.dist-info/RECORD,,

git_ftp-2.0.0.dev0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

git_ftp-2.0.0.dev0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+git-ftp = gitftp.cli:main