Git Product home page Git Product logo

tinydocgen's Introduction

Tiny Document Generator

Useful when you need to generate a bunch of documents following a similar template.

I use this to generate the Memorandum Of Understanding for my customers when I deliver private training.

This is how I use it:

  1. cp sample.yaml my-customer-name.yaml
  2. vim my-customer-name.yaml
  3. Edit YAML
  4. make
  5. After file my-customer-name.pdf is generated, review it, print/send it as necessary
  6. PROFIT!

How it works

The file mou.j2 is basically Markdown with Jinja2 tags in it. We use j2cli to render that template to "pure" Markdown. Then we use markdown2 to render that markdown to HTML. Finally we use weasyprint to render that HTML to PDF. Voilà!

Using it for your own stuff

It's using a few Python dependencies. I recommend that you have Python and pip installed, then install the dependencies with pip install --user -r requirements.txt. If you want to manage the dependencies in a different way or use a container or whatever, you absolutely can!

You will probably want to customize mou.j2 to suit your needs.

tinydocgen's People

Contributors

jpetazzo 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.