Giter Club home page Giter Club logo

lettermaker's Introduction

lettermaker

Write a letter with a minimal TOML file (save as your_letter.toml).

[meta]
template = 'standard'

[fields]
date = '2023-01-01'
address = '''
Toast Corporation\\
The Ol'Stonepath 42\\
23123 New York
'''
subject = 'Application for a Fish License'
opening = 'Dear Sir/Madam at the Ministry of Housinge,'
content = '''
I wrote to explain
I'm your biggest fan
I just wanted to ask ...
'''
closing = 'Best Wishes,'
name = 'Marie Curie'
signaturepath = '../example/signature.png'

Run the command

lettermaker -t your_letter.toml -o my_letter.pdf

and receive a formatted letter as PDF (as my_letter.pdf).

Example output

dependencies

Uses pdflatex and python3.

to-dos.

  • implement prefills (with option -p, --prefill) to prefill empty fields with defaults before the default files.
    • provide prefill for french_formal
    • provide prefill for french_informal
    • provide prefill for english_formal
    • provide prefill for english_informal
    • provide prefill for german_formal
    • provide prefill for german_informal
    • provide prefill for chinese_formal
    • provide prefill for chinese_informal
  • look for prefills at ~/.config/lettermaker/prefills/ then at $PROJECT_ROOT/prefills
  • for empty signature do not include image.
  • look for defaults at ~/.config/lettermaker/defaults/ then at $PROJECT_ROOT/defaults
  • implement list function (with option -l, --list) to show all prefill and default options.
  • implement setup function (with option -s, --setup) for ~/.config/lettermaker/prefills/
  • implement setup function (with option -s, --setup) for ~/.config/lettermaker/templates/
  • allow TOML arrays and create a PDF output letter for each permutation.
  • have flag to toggle visibility of page numbers (define in meta section of toml file).
  • have flag to toggle visibility of folding guide lines at left margin (define in meta section of toml file).
  • provide a functionality that does not insert a signature, but instead draws a box where can be signed by hand.
  • make lettermaker conform to din5008.

done

good reads

lettermaker's People

Contributors

kraasch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.