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.
- Python 3.7
- for dependency management
pip install pipenv
- for task management
pip install invoke
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.
Create Your Own Python Virtual Environment and Install package
Install Attendees Analyzer
If you want to develop it, please run:
If you just want to install it in your virtual environment lib, please run:
Now you should be ready to go.
Test The Installation
Run Test Cases
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
- Fork this repository to your GitHub
- Clone the repository from your GitHub
git clone https://github.com/[YOUR GITHUB ACCOUNT]/pycontw-postevent-report-generator.git
- Add this repository to the remote in your local repository
git remote add upstream "https://github.com/pycontw/pycontw-postevent-report-generator"You can pull the latest code in master branch through
git pull upstream masterafterward.
- Check out a branch for your new feature
git checkout -b [YOUR FEATURE]
- Work on your new feature
inv test.covto check the test coverage and see where you can add test cases
inv testand make sure all tests pass.
inv styleand make sure your coding style passes the linter checks
- [Optional] Run
inv style.pylintto check your coding style through
pylint. Note that you do not have to fix all the issues warned by
inv style.reformatto format your code through
inv secureto ensure the packages installed are secure
- [Optional] Run
inv secure.banditto check whether there is common security issue in the code. Note that you do not have to fix all the issues warned by
inv build.test-clito ensure that the command is runable
- Create a Pull Request
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size pycontw-report-generator-1.0.2.tar.gz (158.6 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for pycontw-report-generator-1.0.2.tar.gz