https://github.com/zkan/si360feedback
Small Improvements - 360 Feedback
https://github.com/zkan/si360feedback
feedback improvement
Last synced: 3 months ago
JSON representation
Small Improvements - 360 Feedback
- Host: GitHub
- URL: https://github.com/zkan/si360feedback
- Owner: zkan
- License: mit
- Created: 2019-09-05T10:39:49.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T06:07:30.000Z (about 3 years ago)
- Last Synced: 2025-04-05T21:30:29.588Z (9 months ago)
- Topics: feedback, improvement
- Language: Python
- Size: 32.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Small Improvements - 360 Feedback
> Sharing the 360 feedback to your reviewee will not be the same again. This script will retrieve the 360 feedback data from Small Improvements.
[](https://circleci.com/gh/prontotools/si360feedback)
## Installation
### Using `venv`
1. Create a virtual environemtn, run
```sh
python3 -m venv ENV
```
1. Install the dependencies used in this project, run
```sh
ENV/bin/pip install -r requirements.txt
```
1. Copy `env.example` to `.env` and put your credentials.
### Using `pipenv`
1. Install the package manager for macOS `brew` from [Homebrew](https://brew.sh/) first.
1. Install `pipenv`, run
```sh
brew install pipenv
```
1. Install the dependencies used in this project, run
```sh
pipenv install
```
1. Copy `env.example` to `.env` and put your credentials.
## Usage Example
### Using `venv`
```sh
ENV/bin/python program.py > your_reviewee.html
```
### Using `pipenv`
```sh
pipenv run python program.py > your_reviewee.html
```
**Note:** To generate output in `requirements.txt`, run
```sh
pipenv lock --requirements > requirements.txt
```
## Development Setup
### Using `venv`
```sh
pipenv lock --dev --requirements > requirements-dev.txt
ENV/bin/pip install requirements-dev.txt
ENV/bin/flake8
ENV/bin/pytest
```
### Using `pipenv`
```sh
pipenv install --dev
pipenv run flake8
pipenv run pytest
```
## Contributing
1. Fork it ()
1. Create your feature branch (`git checkout -b feature/fooBar`)
1. Commit your changes (`git commit -am 'Add some fooBar'`)
1. Push to the branch (`git push origin feature/fooBar`)
1. Create a new Pull Request