Skip to main content

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

Project description

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

Python Check PyPI Package latest release

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.



python -m pip install pycontw-report-generator


$ python -m rg-cli --help

Usage: rg-cli [OPTIONS]

  --csv TEXT                      Read csv format data  [required]
  --talks-csv TEXT                CSV file for talks  [required]
  --proposed-talks-csv TEXT       CSV file for proposed talks  [required]
  --booth-csv TEXT                CSV file for booth checking  [required]
  --interactive / --no-interactive
                                  Quiet mode. Useful for automation. True for
                                  no prompt.  [default: False]
  --cjk-support / --no-cjk-support
                                  Enable CJK support in the plot or not.
                                  [default: False]
  --conf TEXT                     Configuration file of how to analyze
  --yaml TEXT                     Report yaml file to describe how a report
                                  would be  [required]
  --package-yaml TEXT             Package yaml file to describe how a package
                                  is defined  [required]
  --sponsor-yaml TEXT             Sponsor yaml file to describe how a sponsor
                                  is defined  [required]
  --output-path TEXT              Where the reports exported  [default: /tmp]
  --help                          Show this message and exit.

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


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.


Please see the Contributing for further details.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycontw-report-generator-1.5.2.tar.gz (162.3 kB view hashes)

Uploaded Source

Built Distribution

pycontw_report_generator-1.5.2-py3-none-any.whl (174.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page