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)
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pycontw-report-generator-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7910f5440194cded42c668c1e5b640f40fa6fd93602ab915e039a1ff6d2bd92 |
|
MD5 | 464dc7d2dae96907cc299ee2e07c9b9b |
|
BLAKE2b-256 | 665e7618972f45143d247fba5e09a98183590cce1b15a8d16d46c5beb1dd50e4 |
Hashes for pycontw_report_generator-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bcf87764ca9c67200b61cf14f8085481b5be73db9c16be33f4ae4b61fcb4936c |
|
MD5 | dad45edd7d8e5453fb1c3580b6c1bf00 |
|
BLAKE2b-256 | 9fe660c001eb9b2cf24262afaa6f56d2d9cfdf5fed419770e49dc789a197d7ad |