https://github.com/groovytron/markplot

Simple script capable of generating plots and csv files from projects' journal files containing a Markdown table.
https://github.com/groovytron/markplot

markdown project-management

Last synced: 27 days ago
JSON representation

Simple script capable of generating plots and csv files from projects' journal files containing a Markdown table.

• Host: GitHub
• URL: https://github.com/groovytron/markplot
• Owner: groovytron
• License: gpl-3.0
• Created: 2016-09-30T11:02:08.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-09-11T21:23:09.000Z (over 7 years ago)
• Last Synced: 2024-12-10T13:40:59.305Z (about 2 months ago)
• Topics: markdown, project-management
• Language: Python
• Homepage:
• Size: 28.3 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
.. image:: https://travis-ci.org/groovytron/markplot.svg?branch=master

    :target: https://travis-ci.org/groovytron/markplot

Simple script capable of generating plots and csv files from projects'

journal files containing a :code:`Markdown` table. The journals must have

the same format as the example `journal-sample.md `_ file.

Install

-------

Markplot is a python package, so it can be installed like this:

.. code-block:: console

    pip install markplot

CLI

---

Markplot includes a simple CLI. It only takes files as arguments. For examples:

.. code-block:: console

    $ markplot journal-sample.md

    Projects' information has been written in 'generated' directory.

The above example uses the sample file and generates files named

:code:`generated/journal-sample/hours_journal-sample.csv` and

:code:`generated/journal-sample/time_histogram_journal-sample.png`.

Docs

----

The :code:`--help` arg will make it show a usage page:

.. code-block:: console

    $ markplot --help

    Usage: markplot [OPTIONS] [JOURNALS]...

      This script simply generates feedbacks from projects' journals. Output is

      generated in a directory called «generated».

      Generate one feedback from a journal:

          feedbackgenerator journal.md

      Generate two feedbacks from two journals:

          feedbackgenerator journal1.md journal2.md

    Options:

      --help  Show this message and exit.