pycontw-report-generator 1.1.0

PyCon TW post-event report generator.A cli command to generate PyCon TW post-event reports.

PyCon TW post-event report generator (rg-cli)

PyCon TW post-event report generator.A cli command, rg-cli, to generate PyCon TW post-event reports. Previously known as attendee-analyzer.

rg-cli is a command line tool for you to generate a basic report of attendees, e.g. a pie chart of fields according to job titles. Currently it only supports a csv file as raw data input.

Prerequsite

• Python 3.7
• pipenv
  • for dependency management
  • pip install pipenv
• invoke
  • for task management
  • pip install invoke

Installation

Fetch The Source

Fetch the source

git clone https://github.com/pycontw/pycontw-postevent-report-generator.git

Create a working folder to place your attendee raw data outside of the source folder so you won't commit your raw data accidentally.

mkdir pycontw-postevent-report-generator-working

Create Your Own Python Virtual Environment and Install package

inv env.init-dev

Install Attendees Analyzer

If you want to develop it, please run:

inv build.develop

If you just want to install it in your virtual environment lib, please run:

inv build.install

Now you should be ready to go.

Test The Installation

inv build.test-cli

Run Test Cases

inv test

Example

After launching your virtual environment, issue the following command:

rg-cli --csv ./a.csv --csv ./b.csv --csv ./c.csv --yaml ./report_generator/data/generic.yaml --package-yaml ./examples/packages.yaml --sponsor-yaml ./examples/sponsors.yaml

Follow the prompt instruction and you will get jpg images. So far it is well tested with the data of year 2017.

How to contribute

Please see the Contribute for further details.