fillmate 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. fillmate-0.1.1/.github/workflows/ci.yml +28 -0
  2. fillmate-0.1.1/.github/workflows/release.yml +144 -0
  3. fillmate-0.1.1/.gitignore +16 -0
  4. fillmate-0.1.1/CHANGELOG.md +52 -0
  5. fillmate-0.1.1/LICENSE +21 -0
  6. fillmate-0.1.1/PKG-INFO +178 -0
  7. fillmate-0.1.1/README.md +138 -0
  8. fillmate-0.1.1/docs/images/drawer.png +0 -0
  9. fillmate-0.1.1/docs/images/main.png +0 -0
  10. fillmate-0.1.1/docs/images/send-check.png +0 -0
  11. fillmate-0.1.1/docs/pack-format.md +183 -0
  12. fillmate-0.1.1/packaging/icons/fillmate-128.png +0 -0
  13. fillmate-0.1.1/packaging/icons/fillmate-16.png +0 -0
  14. fillmate-0.1.1/packaging/icons/fillmate-256.png +0 -0
  15. fillmate-0.1.1/packaging/icons/fillmate-32.png +0 -0
  16. fillmate-0.1.1/packaging/icons/fillmate-512.png +0 -0
  17. fillmate-0.1.1/packaging/icons/fillmate-64.png +0 -0
  18. fillmate-0.1.1/packaging/icons/fillmate.icns +0 -0
  19. fillmate-0.1.1/packaging/icons/fillmate.ico +0 -0
  20. fillmate-0.1.1/packaging/linux/build-linux.sh +190 -0
  21. fillmate-0.1.1/packaging/linux/io.github.leonardonels.fillmate.metainfo.xml +40 -0
  22. fillmate-0.1.1/packaging/linux/prune_qt.py +87 -0
  23. fillmate-0.1.1/packaging/linux/system_libs.py +42 -0
  24. fillmate-0.1.1/packaging/linux/test-linux.sh +71 -0
  25. fillmate-0.1.1/packaging/macos/dmg-background.png +0 -0
  26. fillmate-0.1.1/packaging/macos/dmg-background@2x.png +0 -0
  27. fillmate-0.1.1/packaging/macos/dmg_settings.py +29 -0
  28. fillmate-0.1.1/pyproject.toml +144 -0
  29. fillmate-0.1.1/src/fillmate/__init__.py +19 -0
  30. fillmate-0.1.1/src/fillmate/__main__.py +3 -0
  31. fillmate-0.1.1/src/fillmate/authoring.py +403 -0
  32. fillmate-0.1.1/src/fillmate/cli.py +179 -0
  33. fillmate-0.1.1/src/fillmate/engine.py +188 -0
  34. fillmate-0.1.1/src/fillmate/examples/travel-request/pack.yaml +92 -0
  35. fillmate-0.1.1/src/fillmate/examples/travel-request/travel_notice.docx +0 -0
  36. fillmate-0.1.1/src/fillmate/examples/travel-request/travel_request.pdf +0 -0
  37. fillmate-0.1.1/src/fillmate/fill_docx.py +100 -0
  38. fillmate-0.1.1/src/fillmate/fill_pdf.py +81 -0
  39. fillmate-0.1.1/src/fillmate/gui/__init__.py +0 -0
  40. fillmate-0.1.1/src/fillmate/gui/app.py +1001 -0
  41. fillmate-0.1.1/src/fillmate/gui/calibrate.py +738 -0
  42. fillmate-0.1.1/src/fillmate/gui/common.py +232 -0
  43. fillmate-0.1.1/src/fillmate/gui/fields.py +212 -0
  44. fillmate-0.1.1/src/fillmate/gui/frame.py +558 -0
  45. fillmate-0.1.1/src/fillmate/gui/ink.py +1867 -0
  46. fillmate-0.1.1/src/fillmate/gui/settings.py +779 -0
  47. fillmate-0.1.1/src/fillmate/mail/__init__.py +67 -0
  48. fillmate-0.1.1/src/fillmate/mail/gmail.py +179 -0
  49. fillmate-0.1.1/src/fillmate/mail/mailapp.py +30 -0
  50. fillmate-0.1.1/src/fillmate/mail/senders.py +12 -0
  51. fillmate-0.1.1/src/fillmate/mail/smtp.py +106 -0
  52. fillmate-0.1.1/src/fillmate/pack.py +388 -0
  53. fillmate-0.1.1/src/fillmate/paths.py +55 -0
  54. fillmate-0.1.1/src/fillmate/resources/fillmate.svg +35 -0
  55. fillmate-0.1.1/src/fillmate/resources/fonts/Archivo-Variable.ttf +0 -0
  56. fillmate-0.1.1/src/fillmate/resources/fonts/Caveat-Variable.ttf +0 -0
  57. fillmate-0.1.1/src/fillmate/resources/fonts/CourierPrime-Regular.ttf +0 -0
  58. fillmate-0.1.1/src/fillmate/resources/fonts/Inter-Variable.ttf +0 -0
  59. fillmate-0.1.1/src/fillmate/resources/fonts/OFL-Archivo.txt +93 -0
  60. fillmate-0.1.1/src/fillmate/resources/fonts/OFL-Caveat.txt +93 -0
  61. fillmate-0.1.1/src/fillmate/resources/fonts/OFL-CourierPrime.txt +93 -0
  62. fillmate-0.1.1/src/fillmate/resources/fonts/OFL-Inter.txt +93 -0
  63. fillmate-0.1.1/src/fillmate/resources/fonts/README.md +9 -0
  64. fillmate-0.1.1/src/fillmate/store.py +94 -0
  65. fillmate-0.1.1/src/fillmate/templating.py +81 -0
  66. fillmate-0.1.1/tests/conftest.py +55 -0
  67. fillmate-0.1.1/tests/test_authoring.py +80 -0
  68. fillmate-0.1.1/tests/test_authoring_more.py +87 -0
  69. fillmate-0.1.1/tests/test_fill.py +133 -0
  70. fillmate-0.1.1/tests/test_mail.py +69 -0
  71. fillmate-0.1.1/tests/test_pack.py +81 -0
  72. fillmate-0.1.1/tools/demo.py +50 -0
  73. fillmate-0.1.1/tools/make_dmg_background.py +71 -0
  74. fillmate-0.1.1/tools/make_example_pack.py +101 -0
  75. fillmate-0.1.1/tools/make_icons.py +47 -0
@@ -0,0 +1,28 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ test:
10
+ name: Tests (${{ matrix.os }}, Python ${{ matrix.python }})
11
+ runs-on: ${{ matrix.os }}
12
+ strategy:
13
+ fail-fast: false
14
+ matrix:
15
+ include:
16
+ - {os: ubuntu-latest, python: "3.10"}
17
+ - {os: ubuntu-latest, python: "3.13"}
18
+ - {os: macos-latest, python: "3.13"}
19
+ - {os: windows-latest, python: "3.13"}
20
+ steps:
21
+ - uses: actions/checkout@v4
22
+ - uses: actions/setup-python@v5
23
+ with:
24
+ python-version: ${{ matrix.python }}
25
+ cache: pip
26
+ - run: python -m pip install -e ".[dev]"
27
+ - run: python -m pyflakes src tests tools
28
+ - run: python -m pytest -v
@@ -0,0 +1,144 @@
1
+ # Push a tag like v0.2.0 to build every installer (and publish to PyPI, when enabled below):
2
+ # git tag v0.2.0 && git push origin v0.2.0
3
+ # The installers are attached to a draft GitHub Release: check them, then publish it.
4
+ name: Release
5
+
6
+ on:
7
+ push:
8
+ tags: ["v*"]
9
+ workflow_dispatch: # manual run: builds the installers as artifacts, no release or PyPI upload
10
+
11
+ permissions:
12
+ contents: read
13
+
14
+ jobs:
15
+ python-package:
16
+ name: Wheel and sdist
17
+ runs-on: ubuntu-latest
18
+ steps:
19
+ - uses: actions/checkout@v4
20
+ - uses: actions/setup-python@v5
21
+ with:
22
+ python-version: "3.13"
23
+ - run: python -m pip install build
24
+ - run: python -m build
25
+ - uses: actions/upload-artifact@v4
26
+ with:
27
+ name: python-package
28
+ path: dist/*
29
+
30
+ installers:
31
+ name: ${{ matrix.name }}
32
+ runs-on: ${{ matrix.os }}
33
+ strategy:
34
+ fail-fast: false
35
+ matrix:
36
+ include:
37
+ - {name: "Windows .msi", id: msi, os: windows-latest, platform: windows, files: "dist/*.msi"}
38
+ steps:
39
+ - uses: actions/checkout@v4
40
+ - uses: actions/setup-python@v5
41
+ with:
42
+ python-version: "3.13"
43
+ - run: python -m pip install briefcase
44
+ - name: Build (unsigned)
45
+ run: |
46
+ briefcase create ${{ matrix.platform }} app --no-input
47
+ briefcase build ${{ matrix.platform }} app --no-input
48
+ briefcase package ${{ matrix.platform }} app --adhoc-sign --no-input
49
+ - uses: actions/upload-artifact@v4
50
+ with:
51
+ name: installer-${{ matrix.id }}
52
+ path: ${{ matrix.files }}
53
+ if-no-files-found: error
54
+
55
+ macos:
56
+ # Briefcase builds and ad-hoc signs the app; the .dmg is made here with dmgbuild instead of
57
+ # Briefcase's DMG step (see packaging/macos/dmg_settings.py for why). Left unsigned on purpose:
58
+ # Gatekeeper then asks about the app once, not about the disk image as well.
59
+ name: macOS .dmg
60
+ runs-on: macos-latest
61
+ steps:
62
+ - uses: actions/checkout@v4
63
+ - uses: actions/setup-python@v5
64
+ with:
65
+ python-version: "3.13"
66
+ - run: python -m pip install briefcase dmgbuild
67
+ - name: Build the app (ad-hoc signed)
68
+ run: |
69
+ briefcase create macOS app --no-input
70
+ briefcase build macOS app --no-input
71
+ briefcase package macOS app --adhoc-sign -p zip --no-input
72
+ - name: Build the .dmg
73
+ run: |
74
+ version=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['tool']['briefcase']['version'])")
75
+ app=$(ls -d build/fillmate/macos/app/*.app)
76
+ codesign --verify --deep --strict "$app"
77
+ tiffutil -cathidpicheck packaging/macos/dmg-background.png packaging/macos/dmg-background@2x.png \
78
+ -out "$RUNNER_TEMP/dmg-background.tiff"
79
+ rm -f dist/*.dmg
80
+ dmgbuild -s packaging/macos/dmg_settings.py -D app="$app" -D background="$RUNNER_TEMP/dmg-background.tiff" \
81
+ "fillmate $version" "dist/fillmate-$version.dmg"
82
+ - uses: actions/upload-artifact@v4
83
+ with:
84
+ name: installer-dmg
85
+ path: dist/*.dmg
86
+ if-no-files-found: error
87
+
88
+ linux:
89
+ # One self-contained bundle (it carries its own Python), packaged as a .deb for
90
+ # Ubuntu 22.04+ and an .rpm for Fedora / RHEL 9+, then installed and tested on each.
91
+ name: Linux .deb and .rpm
92
+ runs-on: ubuntu-24.04
93
+ steps:
94
+ - uses: actions/checkout@v4
95
+ - uses: astral-sh/setup-uv@v6
96
+ - run: packaging/linux/build-linux.sh
97
+ - run: packaging/linux/test-linux.sh
98
+ - uses: actions/upload-artifact@v4
99
+ with:
100
+ name: installer-deb
101
+ path: dist/*.deb
102
+ if-no-files-found: error
103
+ - uses: actions/upload-artifact@v4
104
+ with:
105
+ name: installer-rpm
106
+ path: dist/*.rpm
107
+ if-no-files-found: error
108
+
109
+ github-release:
110
+ name: Draft GitHub release
111
+ if: startsWith(github.ref, 'refs/tags/v')
112
+ needs: [python-package, installers, macos, linux]
113
+ runs-on: ubuntu-latest
114
+ permissions:
115
+ contents: write
116
+ steps:
117
+ - uses: actions/download-artifact@v4
118
+ with:
119
+ path: artifacts
120
+ merge-multiple: true
121
+ - uses: softprops/action-gh-release@v2
122
+ with:
123
+ draft: true
124
+ generate_release_notes: true
125
+ files: artifacts/*
126
+
127
+ pypi:
128
+ name: Publish to PyPI
129
+ # Off until the repository variable PUBLISH_PYPI is set to "true"
130
+ # (Settings → Secrets and variables → Actions → Variables). It also needs a
131
+ # "trusted publisher" set up once on pypi.org for this repo and workflow,
132
+ # and a GitHub environment named "pypi".
133
+ if: startsWith(github.ref, 'refs/tags/v') && vars.PUBLISH_PYPI == 'true'
134
+ needs: [python-package, installers, macos, linux]
135
+ runs-on: ubuntu-latest
136
+ environment: pypi
137
+ permissions:
138
+ id-token: write
139
+ steps:
140
+ - uses: actions/download-artifact@v4
141
+ with:
142
+ name: python-package
143
+ path: dist
144
+ - uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,16 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.pyc
4
+ *.egg-info/
5
+ dist/
6
+ build/
7
+ .pytest_cache/
8
+ # Never commit personal data or credentials
9
+ client_secret*.json
10
+ *token*.json
11
+ profile.yaml
12
+ settings.yaml
13
+ output/
14
+ demo-home/
15
+ build/
16
+ logs/
@@ -0,0 +1,52 @@
1
+ # Changelog
2
+
3
+ ## 0.1.1 (2026-11-22)
4
+
5
+ - Dark theme: the drawer button's icon turns light with the rest of the toolbar.
6
+ - README screenshots, taken from the demo with made-up data.
7
+ - Published on PyPI: `pipx install fillmate`.
8
+
9
+ ## 0.1.0 (2026-11-22)
10
+
11
+ - First version: form packs (`pack.yaml`), fills flat and fillable PDFs and DOCX (placeholders or table cells).
12
+ - Desktop app with previews, presets, rules and warnings, test mode.
13
+ - Email via Gmail (Google sign-in), SMTP, or a draft in your mail app.
14
+ - Calibration tool: create a pack from a PDF and place values by drawing on the page.
15
+ - Command line: `fillmate fill / import / export / fields / profile`.
16
+ - New look, "Ink and hand": dot-grid paper, what you typed in ink, fillmate's notes in red pen, and Liquid Glass
17
+ toolbar, sidebar and send check. Yes/no fields are circled, short choices are tick boxes, settings use switches.
18
+ - Test mode is on for new users. Settings save as you change them.
19
+ - Zoom the preview (Ctrl + wheel, Ctrl +/−, or the zoom controls).
20
+ - New pack from a Word document: its {{ placeholders }} become fields, and new ones are picked up after editing.
21
+ - Positions editor: no modes (drag or double-click to add a box, right-click for check marks), values picked by
22
+ name, no sample text. Fields made there are only saved with the positions; unused fields can be removed.
23
+ - Add or remove documents in a pack (Settings → Form packs); remove a pack from there or by right-clicking it.
24
+ - The positions editor has the new look too: dot-grid paper, glass toolbar and values panel, hints in red pen,
25
+ glass right-click menu. A pack's ⋮ menu opens each of its documents directly.
26
+ - Questions, notices and name prompts are drawn on the app's own paper instead of the system's message box. Removing a
27
+ pack's only document offers to remove the pack. "Add a line below" is gone from the positions editor.
28
+ - No system title bar: round corners, and window buttons per platform (macOS traffic lights inside the sidebar,
29
+ a glass minimize/maximize/close capsule on Windows, round glass buttons on Linux following the desktop's
30
+ button layout). Drag empty toolbar space to move, double-click it to maximize, resize from any edge.
31
+ - Buttons are animated: hover light fades in and out, glass buttons brighten and swell when pressed, switch
32
+ knobs slide, and the selection pill glides between options and fades in on the sidebar.
33
+ - The output tabs stay between the title and the buttons: long document names are shortened (whole name on
34
+ hover) instead of sliding under the toolbar buttons.
35
+ - Dark theme: smoky glass that stays dark over the white page of a preview, fainter rims and selection pills,
36
+ a yellow highlighter with dark text, and visible edges around grouped settings.
37
+ - The dot grid is replaced by a print room: the open pack's name in huge faint Archivo Expanded over the previews,
38
+ a rubber stamp for where the request stands (draft, filled, sent), a registration mark, a ruler, a test-mode
39
+ label along the edge and a colour bar (label, ink, red pen). Other windows get plain paper. The dark theme's ground and paper are warmer.
40
+ - New app icon in Liquid Glass layers: a tilted frosted sheet filled in by hand under the highlighter, and the
41
+ fountain pen that wrote it, on a paper tile.
42
+ - Create documents is a glass capsule floating over the form (it stays in view when a long form scrolls under it).
43
+ Glass lying on the window has a faint contact edge instead of a drop shadow; only popovers cast a soft one.
44
+ The send check's Send is a flat ink button, switches turn ink blue when on, and focus rings show for keyboard
45
+ focus only.
46
+ - Two columns: the previews on the left, the form (with its title) on the right, scrolling as one. Packs, presets
47
+ and settings moved to a glass drawer (the top-left button or Ctrl+B; Esc closes it). New previews open with the
48
+ page's top already under the tab bar's glass.
49
+ - macOS: the traffic lights sit on the toolbar row, before the drawer button.
50
+ - macOS installer: a "drag to install" window drawn in the app's ink, with the standard disk icon. The .dmg is
51
+ no longer signed, so Gatekeeper asks about the app once instead of the disk image as well.
52
+ - Requires PySide6 below 6.12: 6.12 releases Python's None once too often on Python 3.10–3.11 and the app aborts.
fillmate-0.1.1/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Leonardo Nels
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,178 @@
1
+ Metadata-Version: 2.5
2
+ Name: fillmate
3
+ Version: 0.1.1
4
+ Summary: Fill recurring paperwork from reusable form packs and send it by email.
5
+ Project-URL: Homepage, https://github.com/leonardonels/fillmate
6
+ Project-URL: Documentation, https://github.com/leonardonels/fillmate/blob/main/docs/pack-format.md
7
+ Project-URL: Issues, https://github.com/leonardonels/fillmate/issues
8
+ Project-URL: Changelog, https://github.com/leonardonels/fillmate/blob/main/CHANGELOG.md
9
+ Author: Leonardo Nels
10
+ License-Expression: MIT
11
+ License-File: LICENSE
12
+ Keywords: automation,docx,email,forms,paperwork,pdf
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Environment :: X11 Applications :: Qt
15
+ Classifier: Intended Audience :: End Users/Desktop
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Topic :: Office/Business
19
+ Requires-Python: >=3.10
20
+ Requires-Dist: docxtpl>=0.18
21
+ Requires-Dist: google-auth-oauthlib>=1.2
22
+ Requires-Dist: google-auth>=2.30
23
+ Requires-Dist: holidays>=0.50
24
+ Requires-Dist: jinja2>=3.1
25
+ Requires-Dist: keyring>=25
26
+ Requires-Dist: numpy>=1.24
27
+ Requires-Dist: platformdirs>=4
28
+ Requires-Dist: pymupdf<2,>=1.24
29
+ Requires-Dist: pyside6-essentials<6.12,>=6.7
30
+ Requires-Dist: python-docx>=1.1
31
+ Requires-Dist: pyyaml>=6
32
+ Requires-Dist: requests>=2.31
33
+ Requires-Dist: ruamel-yaml>=0.18
34
+ Provides-Extra: dev
35
+ Requires-Dist: briefcase>=0.3.20; extra == 'dev'
36
+ Requires-Dist: pillow>=10; extra == 'dev'
37
+ Requires-Dist: pyflakes>=3; extra == 'dev'
38
+ Requires-Dist: pytest>=8; extra == 'dev'
39
+ Description-Content-Type: text/markdown
40
+
41
+ # fillmate
42
+
43
+ Fill in the same paperwork again and again? fillmate turns the forms you keep filling in
44
+ (travel requests, internship forms, expense claims, leave requests…) into a small form.
45
+ Type in what changes each time, check the preview, and send the filled PDF and Word
46
+ documents by email.
47
+
48
+ ![fillmate: the filled travel request on the left, the form on the right](https://raw.githubusercontent.com/leonardonels/fillmate/main/docs/images/main.png)
49
+
50
+ - **Form packs**: one folder with your templates and a `pack.yaml` that says what goes
51
+ where. Share a pack as a `.zip` and a colleague with the same paperwork is ready in a
52
+ minute. Your personal details are never part of it.
53
+ - **Any PDF**: fillable PDF forms, and flat PDFs too. Text is placed at fixed positions,
54
+ wrapped across lines, and shrunk to fit.
55
+ - **Word documents**: `{{ placeholders }}`, or writing into table cells while the
56
+ template's formatting stays as it is.
57
+ - **Email**: Gmail (sign in with Google, no password stored), any SMTP server, or a draft
58
+ opened in your own mail app.
59
+ - **Safety**: a test mode sends only to your own addresses, and a confirmation before
60
+ each send shows exactly who gets the email.
61
+ - **Rules**: required fields, and warnings such as "less than 2 working days' notice"
62
+ that take public holidays into account.
63
+
64
+ | Packs, presets and settings in a drawer | The check before each email goes out |
65
+ |---|---|
66
+ | ![The drawer open over the preview](https://raw.githubusercontent.com/leonardonels/fillmate/main/docs/images/drawer.png) | ![The send check in test mode](https://raw.githubusercontent.com/leonardonels/fillmate/main/docs/images/send-check.png) |
67
+
68
+ <sub>Screenshots from the demo (`tools/demo.py`), with made-up data.</sub>
69
+
70
+ ## Install
71
+
72
+ ```bash
73
+ pipx install fillmate # or: pip install fillmate
74
+ fillmate # opens the app
75
+ ```
76
+
77
+ Or download an installer (`.deb`, `.rpm`, `.dmg`, `.msi`) from the
78
+ [Releases](https://github.com/leonardonels/fillmate/releases) page. The `.deb` works on
79
+ Ubuntu 22.04 and later (`sudo apt install ./fillmate_*_amd64.deb`), the `.rpm` on Fedora
80
+ and RHEL 9 or later (`sudo dnf install ./fillmate-*.x86_64.rpm`). If apt ends with
81
+ "N: Download is performed unsandboxed as root…", that's only apt noting it couldn't read
82
+ your home folder as its `_apt` user; the install went through. The `.dmg` is for
83
+ Apple Silicon Macs (M1 and later); Intel Macs aren't supported. The macOS and Windows
84
+ builds aren't signed yet. On macOS, drag fillmate to Applications and open it; when macOS
85
+ says it can't check it, go to **System Settings → Privacy & Security** and choose **Open
86
+ Anyway** (once). On Windows, choose **More info → Run anyway**.
87
+
88
+ ## First steps
89
+
90
+ 1. **Settings → Form packs → Install example** gives you a demo pack. Or import a pack
91
+ someone shared with you.
92
+ 2. **Settings → Profile**: your name and the other details packs reuse.
93
+ 3. **Settings → Email**: choose how to send. For Gmail, the tab has a short guide to
94
+ create your own OAuth client (about 5 minutes, done once).
95
+ 4. Pick the pack, fill in the form, press **Create documents**, check the preview and
96
+ the email, then send.
97
+
98
+ Turn on **test mode** (Settings → General) while you try things out. Every email then
99
+ goes only to the test addresses you list.
100
+
101
+ ## Make a pack for your own forms
102
+
103
+ In **Settings → Form packs → New pack from PDF…**, pick your PDF:
104
+
105
+ - If it has fillable fields, they become pack fields right away.
106
+ - If it's a flat PDF, draw a box over each blank line and click the boxes that should
107
+ get a check mark.
108
+
109
+ For everything else (Word templates, rules, email, presets) see
110
+ [docs/pack-format.md](https://github.com/leonardonels/fillmate/blob/main/docs/pack-format.md). A pack is a folder like this:
111
+
112
+ ```
113
+ my-pack/
114
+ pack.yaml
115
+ request.pdf
116
+ notice.docx
117
+ ```
118
+
119
+ The bundled [example pack](https://github.com/leonardonels/fillmate/blob/main/src/fillmate/examples/travel-request/pack.yaml) uses every
120
+ feature.
121
+
122
+ ## Command line
123
+
124
+ ```bash
125
+ fillmate packs # list installed packs
126
+ fillmate fields travel-request # fields, profile and presets of a pack
127
+ fillmate profile --set full_name="Jane Doe"
128
+ fillmate fill travel-request --preset head-office --set dates=2026-12-01,2026-12-02 --no-mail
129
+ fillmate fill travel-request --set dates=2026-12-01 --set destination="Leeds" --open-draft
130
+ fillmate import shared-pack.zip
131
+ fillmate export travel-request travel-request.zip
132
+ ```
133
+
134
+ ## Where things are stored
135
+
136
+ | What | Where (Linux; macOS/Windows use their usual folders) |
137
+ |---|---|
138
+ | Settings, profile, Google sign-in | `~/.config/fillmate/` (files readable only by you) |
139
+ | SMTP password | system keyring, otherwise `~/.config/fillmate/` |
140
+ | Installed packs, saved presets | `~/.local/share/fillmate/` |
141
+ | Filled documents | `~/Documents/Fillmate/<date>_<destination>/` |
142
+
143
+ `FILLMATE_HOME=/some/folder` keeps everything in a single folder instead.
144
+
145
+ DOCX previews, and attaching DOCX files as PDF, need
146
+ [LibreOffice](https://www.libreoffice.org/).
147
+
148
+ ## Development
149
+
150
+ ```bash
151
+ git clone https://github.com/leonardonels/fillmate && cd fillmate
152
+ python -m venv .venv && .venv/bin/pip install -e ".[dev]"
153
+ .venv/bin/pytest
154
+ .venv/bin/python tools/make_example_pack.py # regenerate the example templates
155
+ .venv/bin/python tools/make_icons.py # regenerate installer icons from the SVG
156
+ .venv/bin/python tools/demo.py # open the app with made-up data
157
+ ```
158
+
159
+ ### Installers
160
+
161
+ The `.deb` and `.rpm` are made from one bundle that carries its own Python, so one file
162
+ installs on every supported release. It is built in an Ubuntu 22.04 container (needs
163
+ Docker and uv):
164
+
165
+ ```bash
166
+ packaging/linux/build-linux.sh # writes dist/fillmate_<version>_amd64.deb and .x86_64.rpm
167
+ packaging/linux/test-linux.sh # installs them on clean Ubuntu, Fedora and AlmaLinux
168
+ ```
169
+
170
+ The `.dmg` and `.msi` are built with [Briefcase](https://briefcase.beeware.org) (config
171
+ in `pyproject.toml`); the `.dmg` itself is made with dmgbuild from `packaging/macos/` (its background
172
+ comes from `tools/make_dmg_background.py`). Pushing a `v*` tag runs `.github/workflows/release.yml`, which
173
+ builds all of them plus the PyPI package and attaches them to a draft GitHub release.
174
+ Uploading to PyPI is off until the repository variable `PUBLISH_PYPI` is set to `true`.
175
+
176
+ ## License
177
+
178
+ MIT
@@ -0,0 +1,138 @@
1
+ # fillmate
2
+
3
+ Fill in the same paperwork again and again? fillmate turns the forms you keep filling in
4
+ (travel requests, internship forms, expense claims, leave requests…) into a small form.
5
+ Type in what changes each time, check the preview, and send the filled PDF and Word
6
+ documents by email.
7
+
8
+ ![fillmate: the filled travel request on the left, the form on the right](https://raw.githubusercontent.com/leonardonels/fillmate/main/docs/images/main.png)
9
+
10
+ - **Form packs**: one folder with your templates and a `pack.yaml` that says what goes
11
+ where. Share a pack as a `.zip` and a colleague with the same paperwork is ready in a
12
+ minute. Your personal details are never part of it.
13
+ - **Any PDF**: fillable PDF forms, and flat PDFs too. Text is placed at fixed positions,
14
+ wrapped across lines, and shrunk to fit.
15
+ - **Word documents**: `{{ placeholders }}`, or writing into table cells while the
16
+ template's formatting stays as it is.
17
+ - **Email**: Gmail (sign in with Google, no password stored), any SMTP server, or a draft
18
+ opened in your own mail app.
19
+ - **Safety**: a test mode sends only to your own addresses, and a confirmation before
20
+ each send shows exactly who gets the email.
21
+ - **Rules**: required fields, and warnings such as "less than 2 working days' notice"
22
+ that take public holidays into account.
23
+
24
+ | Packs, presets and settings in a drawer | The check before each email goes out |
25
+ |---|---|
26
+ | ![The drawer open over the preview](https://raw.githubusercontent.com/leonardonels/fillmate/main/docs/images/drawer.png) | ![The send check in test mode](https://raw.githubusercontent.com/leonardonels/fillmate/main/docs/images/send-check.png) |
27
+
28
+ <sub>Screenshots from the demo (`tools/demo.py`), with made-up data.</sub>
29
+
30
+ ## Install
31
+
32
+ ```bash
33
+ pipx install fillmate # or: pip install fillmate
34
+ fillmate # opens the app
35
+ ```
36
+
37
+ Or download an installer (`.deb`, `.rpm`, `.dmg`, `.msi`) from the
38
+ [Releases](https://github.com/leonardonels/fillmate/releases) page. The `.deb` works on
39
+ Ubuntu 22.04 and later (`sudo apt install ./fillmate_*_amd64.deb`), the `.rpm` on Fedora
40
+ and RHEL 9 or later (`sudo dnf install ./fillmate-*.x86_64.rpm`). If apt ends with
41
+ "N: Download is performed unsandboxed as root…", that's only apt noting it couldn't read
42
+ your home folder as its `_apt` user; the install went through. The `.dmg` is for
43
+ Apple Silicon Macs (M1 and later); Intel Macs aren't supported. The macOS and Windows
44
+ builds aren't signed yet. On macOS, drag fillmate to Applications and open it; when macOS
45
+ says it can't check it, go to **System Settings → Privacy & Security** and choose **Open
46
+ Anyway** (once). On Windows, choose **More info → Run anyway**.
47
+
48
+ ## First steps
49
+
50
+ 1. **Settings → Form packs → Install example** gives you a demo pack. Or import a pack
51
+ someone shared with you.
52
+ 2. **Settings → Profile**: your name and the other details packs reuse.
53
+ 3. **Settings → Email**: choose how to send. For Gmail, the tab has a short guide to
54
+ create your own OAuth client (about 5 minutes, done once).
55
+ 4. Pick the pack, fill in the form, press **Create documents**, check the preview and
56
+ the email, then send.
57
+
58
+ Turn on **test mode** (Settings → General) while you try things out. Every email then
59
+ goes only to the test addresses you list.
60
+
61
+ ## Make a pack for your own forms
62
+
63
+ In **Settings → Form packs → New pack from PDF…**, pick your PDF:
64
+
65
+ - If it has fillable fields, they become pack fields right away.
66
+ - If it's a flat PDF, draw a box over each blank line and click the boxes that should
67
+ get a check mark.
68
+
69
+ For everything else (Word templates, rules, email, presets) see
70
+ [docs/pack-format.md](https://github.com/leonardonels/fillmate/blob/main/docs/pack-format.md). A pack is a folder like this:
71
+
72
+ ```
73
+ my-pack/
74
+ pack.yaml
75
+ request.pdf
76
+ notice.docx
77
+ ```
78
+
79
+ The bundled [example pack](https://github.com/leonardonels/fillmate/blob/main/src/fillmate/examples/travel-request/pack.yaml) uses every
80
+ feature.
81
+
82
+ ## Command line
83
+
84
+ ```bash
85
+ fillmate packs # list installed packs
86
+ fillmate fields travel-request # fields, profile and presets of a pack
87
+ fillmate profile --set full_name="Jane Doe"
88
+ fillmate fill travel-request --preset head-office --set dates=2026-12-01,2026-12-02 --no-mail
89
+ fillmate fill travel-request --set dates=2026-12-01 --set destination="Leeds" --open-draft
90
+ fillmate import shared-pack.zip
91
+ fillmate export travel-request travel-request.zip
92
+ ```
93
+
94
+ ## Where things are stored
95
+
96
+ | What | Where (Linux; macOS/Windows use their usual folders) |
97
+ |---|---|
98
+ | Settings, profile, Google sign-in | `~/.config/fillmate/` (files readable only by you) |
99
+ | SMTP password | system keyring, otherwise `~/.config/fillmate/` |
100
+ | Installed packs, saved presets | `~/.local/share/fillmate/` |
101
+ | Filled documents | `~/Documents/Fillmate/<date>_<destination>/` |
102
+
103
+ `FILLMATE_HOME=/some/folder` keeps everything in a single folder instead.
104
+
105
+ DOCX previews, and attaching DOCX files as PDF, need
106
+ [LibreOffice](https://www.libreoffice.org/).
107
+
108
+ ## Development
109
+
110
+ ```bash
111
+ git clone https://github.com/leonardonels/fillmate && cd fillmate
112
+ python -m venv .venv && .venv/bin/pip install -e ".[dev]"
113
+ .venv/bin/pytest
114
+ .venv/bin/python tools/make_example_pack.py # regenerate the example templates
115
+ .venv/bin/python tools/make_icons.py # regenerate installer icons from the SVG
116
+ .venv/bin/python tools/demo.py # open the app with made-up data
117
+ ```
118
+
119
+ ### Installers
120
+
121
+ The `.deb` and `.rpm` are made from one bundle that carries its own Python, so one file
122
+ installs on every supported release. It is built in an Ubuntu 22.04 container (needs
123
+ Docker and uv):
124
+
125
+ ```bash
126
+ packaging/linux/build-linux.sh # writes dist/fillmate_<version>_amd64.deb and .x86_64.rpm
127
+ packaging/linux/test-linux.sh # installs them on clean Ubuntu, Fedora and AlmaLinux
128
+ ```
129
+
130
+ The `.dmg` and `.msi` are built with [Briefcase](https://briefcase.beeware.org) (config
131
+ in `pyproject.toml`); the `.dmg` itself is made with dmgbuild from `packaging/macos/` (its background
132
+ comes from `tools/make_dmg_background.py`). Pushing a `v*` tag runs `.github/workflows/release.yml`, which
133
+ builds all of them plus the PyPI package and attaches them to a draft GitHub release.
134
+ Uploading to PyPI is off until the repository variable `PUBLISH_PYPI` is set to `true`.
135
+
136
+ ## License
137
+
138
+ MIT
Binary file
Binary file