Code of Conduct¶
Popper adheres to the code of conduct posted in this repository. By participating or contributing to Popper, you’re expected to uphold this code. If you encounter unacceptable behavior, please immediately email us.
Install from source¶
To install Popper in “development mode”, we suggest the following approach:
cd $HOME/ # create virtualenv python -m virtualenv $HOME/virtualenvs/popper # load virtualenv source $HOME/virtualenvs/popper/bin/activate # clone popper git clone email@example.com:systemslab/popper cd popper # install popper from source pip install -e cli[dev]
-e flag passed to
pip tells it to install the package from the
source folder, and if you modify the logic in the popper source code
you will see the effects when you invoke the
popper command. So with
the above approach you have both (1) popper installed in your machine
and (2) an environment where you can modify popper and test the
results of such modifications.
NOTE: The virtual environment created above needs to be reloaded every time you open a new terminal window (
sourcecommmand), otherwise the
poppercommand will not be found by your shell.
Contributing CLI features¶
To contribute new CLI features:
- Add a new issue describing the feature.
- Fork the official repo and implement the issue on a new branch.
- Add tests for the new feature. We test the
popperCLI command using Popper itself. The Popper pipeline for testing the
poppercommand is available here.
- Open a pull request against the