Skip to content
/ mkres Public

Database journalism tool for making pretty-printed PDF research reports from MySQL queries.

License

Notifications You must be signed in to change notification settings

espena/mkres

Repository files navigation

Make Research (mkres)

Database journalism tool for making pretty-printed PDF research reports from MySQL queries. The idea is to write structured LaTEX code in comment blocks in the SQL script that will format well along the tables output by each query.

This tool is inspired by the way common source code documentation tools work. Study the dummy source file research.sql and the generated research.pdf to get the idea.

Dependencies

This utility runs on Ubuntu 15.04 systems with the following packages installed:

  • texlive
  • texlive-fonts-extra
  • texlive-lang-norwegian (or whatever language you are using)
  • pcregrep
  • mysql-client

Docker container

You may also use my Docker image espena/latex which have the above dependencies preinstalled. You only need to mount a working volume and link mysql to the espena/latex container to get it going. There'a docker-compose.yml file for you to adapt to your needs.

Install

Run sudo make install. The script will be copied to your /usr/local/bin directory.

How to use

If you have a SQL file called research.sql, then run "makeres research". If all is good, the file research.pdf will be generated alongside the source SQL script.

About

Database journalism tool for making pretty-printed PDF research reports from MySQL queries.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published