uk-invitation-letter


Nameuk-invitation-letter JSON
Version 0.4.0 PyPI version JSON
download
home_pagehttps://github.com/iskhakovt/uk-invitation-letter
SummaryUK visa invitation letter generator.
upload_time2023-10-02 15:26:46
maintainer
docs_urlNone
authorTimur Iskhakov
requires_python>=3.8,<4.0
licenseLGPL-3.0-or-later
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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

### Usage

1. Install the package.

```bash
pip3 install uk-invitation-letter
```

2. Create `data.yml` config file.

Example:

```yaml
inviter: !entity
  name: Kayleigh H Welch
  address: !address
    lines:
      - 75 Hertingfordbury Road
      - Newton NG13 8QY
      # UK auto-added
  phone: "07758888305"
  email: noreply@temporary-mail.net

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

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

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

trip: !trip
  arrival_date: 2020-01-01
  departure_date: 2020-01-31
  reason: a short trip
  return_reason: null
  return_country: the US
  financial_support: false
```

3. Run the generator.

```bash
LATEX_BINARY=<path to latex binary> uk-invitation-letter
```

The output will be saved to `build/invitation.pdf`.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/iskhakovt/uk-invitation-letter",
    "name": "uk-invitation-letter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Timur Iskhakov",
    "author_email": "me@timur.is",
    "download_url": "https://files.pythonhosted.org/packages/6a/00/29da63236d560738ae6ca549ff8a2beae1eed425275877d6f54c1c244d75/uk_invitation_letter-0.4.0.tar.gz",
    "platform": null,
    "description": "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/)\n===\n\nWrites a [UK Standard Visitor](https://www.gov.uk/standard-visitor) visa invitation letter for you.\n\n\n---\n\n### Requirements\n\n* Python 3 with pip\n* LaTeX with OpenType font support, e.g. XeLaTeX\n\n### Usage\n\n1. Install the package.\n\n```bash\npip3 install uk-invitation-letter\n```\n\n2. Create `data.yml` config file.\n\nExample:\n\n```yaml\ninviter: !entity\n  name: Kayleigh H Welch\n  address: !address\n    lines:\n      - 75 Hertingfordbury Road\n      - Newton NG13 8QY\n      # UK auto-added\n  phone: \"07758888305\"\n  email: noreply@temporary-mail.net\n\nemployer: !entity\n  name: Jstory UK Ltd\n  address: !address\n    lines:\n      - 89 Well Lane\n      - Patterdale CA11 0LQ\n\nembassy: !entity\n  name: British Consulate General New York\n  address: !address\n    lines:\n      - 885 2nd Ave\n      - New York\n      - NY 10017\n      - United States\n\ninvitee: !entity\n  name: # <first name> [<other names>]+ <last name>, use `~` for a non-breaking space\n    - Joseph Brodsky\n    - Maria Sozzani\n  pronoun: null # they/them/their by default\n  relationship: friends\n\ntrip: !trip\n  arrival_date: 2020-01-01\n  departure_date: 2020-01-31\n  reason: a short trip\n  return_reason: null\n  return_country: the US\n  financial_support: false\n```\n\n3. Run the generator.\n\n```bash\nLATEX_BINARY=<path to latex binary> uk-invitation-letter\n```\n\nThe output will be saved to `build/invitation.pdf`.\n",
    "bugtrack_url": null,
    "license": "LGPL-3.0-or-later",
    "summary": "UK visa invitation letter generator.",
    "version": "0.4.0",
    "project_urls": {
        "Homepage": "https://github.com/iskhakovt/uk-invitation-letter",
        "Repository": "https://github.com/iskhakovt/uk-invitation-letter"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "22454d0b32dad5e53b695d7f465ad4b3f72308ca9f045eb4ad140aa69e1c1c3c",
                "md5": "46e53ac8a9651ef4f6deeedf16c8af29",
                "sha256": "e5fbf216b94d96a6ef0d94b9a9ee7c0f0ecf497dfae8751c6aacafe3bcf74822"
            },
            "downloads": -1,
            "filename": "uk_invitation_letter-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "46e53ac8a9651ef4f6deeedf16c8af29",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 8495,
            "upload_time": "2023-10-02T15:26:44",
            "upload_time_iso_8601": "2023-10-02T15:26:44.881823Z",
            "url": "https://files.pythonhosted.org/packages/22/45/4d0b32dad5e53b695d7f465ad4b3f72308ca9f045eb4ad140aa69e1c1c3c/uk_invitation_letter-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6a0029da63236d560738ae6ca549ff8a2beae1eed425275877d6f54c1c244d75",
                "md5": "051fde340e8140434ea2a7de0ce6c660",
                "sha256": "ea59a67093657d8e9ffd0aabfbd97830d4a39a504456dc78ee4dae8c40bff9c9"
            },
            "downloads": -1,
            "filename": "uk_invitation_letter-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "051fde340e8140434ea2a7de0ce6c660",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 6786,
            "upload_time": "2023-10-02T15:26:46",
            "upload_time_iso_8601": "2023-10-02T15:26:46.567065Z",
            "url": "https://files.pythonhosted.org/packages/6a/00/29da63236d560738ae6ca549ff8a2beae1eed425275877d6f54c1c244d75/uk_invitation_letter-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-02 15:26:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "iskhakovt",
    "github_project": "uk-invitation-letter",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "tox": true,
    "lcname": "uk-invitation-letter"
}
        
Elapsed time: 0.13847s