Metadata-Version: 2.4
Name: uk-invitation-letter
Version: 0.7.2
Summary: UK visa invitation letter generator.
License: LGPL-3.0-or-later
License-File: LICENSE.md
Author: Timur Iskhakov
Author-email: me@timur.is
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Legal Industry
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Natural Language :: English
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 :: Text Processing :: Markup :: LaTeX
Requires-Dist: Jinja2 (>=3.1.6,<4.0.0)
Requires-Dist: phonenumbers (>=9.0.21,<10.0.0)
Requires-Dist: pydantic (>=2.12.5,<3.0.0)
Requires-Dist: pydantic-yaml (>=1.6.0,<2.0.0)
Project-URL: Repository, https://github.com/iskhakovt/uk-invitation-letter
Description-Content-Type: text/markdown

UK visa invitation letter generator [![PyPI](https://img.shields.io/pypi/v/uk-invitation-letter?style=flat-square)](https://pypi.org/project/uk-invitation-letter/)
===

Writes a [UK Standard Visitor](https://www.gov.uk/standard-visitor) visa invitation letter for you.


---

### Requirements

* Python 3 with pip
* LaTeX with OpenType font support, e.g. XeLaTeX, and latexmk

### Usage

1. Install the package:
```bash
pip3 install uk-invitation-letter
```

2. Configure latexmk:

You can use your default setup or clone `.latexmkrc`.

3. Create `data.yml` config file:

Example:

```yaml
inviter:
  name: Kayleigh H Welch
  address:
    - 75 Hertingfordbury Road
    - Newton NG13 8QY
  phone: "07758888305"
  email: noreply@temporary-mail.net
  residence: share code  # optional: `permit` / `share code` / `passport` / custom
  proof_of_address: council tax bill  # optional

employer:
  name: Jstory UK Ltd
  address:
    - 89 Well Lane
    - Patterdale CA11 0LQ

embassy:
  name: British Consulate General New York
  address:
    - 885 2nd Ave
    - New York
    - NY 10017
    - United States

invitee:
  name:  # <first name> [<other names>]+ <last name>, use `~` for a non-breaking space
    - Joseph Brodsky
    - Maria Sozzani
  pronoun: they/them/their  # optional, they/them/their by default
  relationship: friends

trip:
  arrival_date: 2026-01-01
  departure_date: 2026-01-31
  reason: a short trip  # optional
  return_reason: to circumnavigate the globe  # optional
  return_country: the US  # optional
  financial_support: false

docs:  # optional extra documents
  - table tennis match result sheet
```

4. Run the generator:

```bash
uk-invitation-letter --data data.yml --output invitation.pdf
```
The output will be saved to `invitation.pdf`.

