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
- 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 throughgit pull upstream master
afterward. - Check out a branch for your new feature
git checkout -b [YOUR FEATURE]
- Work on your new feature
- Run
inv test.cov
to check the test coverage and see where you can add test cases - Run
inv test
and make sure all tests pass. - Run
inv style
and make sure your coding style passes the linter checks - [Optional] Run
inv style.pylint
to check your coding style throughpylint
. Note that you do not have to fix all the issues warned bypylint
. - Run
inv style.reformat
to format your code throughblack
. - Run
inv secure
to ensure the packages installed are secure - [Optional] Run
inv secure.bandit
to check whether there is common security issue in the code. Note that you do not have to fix all the issues warned bybandit
- Run
inv build.test-cli
to ensure that the command is runable - Create a Pull Request
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
Hashes for pycontw-report-generator-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed09c6d69f40baaa65038f07f93641b0869cad69da6f16bf462b0be73f7dfd01 |
|
MD5 | 42158b6df58efc8817e87525cadb576f |
|
BLAKE2b-256 | 6c862c6b227eb2ecec5311df09b42db03062dfcae8aea79d4945715e2da89003 |