Git Based Leaves management system
Project description
gitleaves
Git Based Leaves management system
Project status: Still in early stage but we use it in production
Features
- Pull requests based leaves management. Most natural for software development team
- Github friendly workflow
- Generates github wiki friendly markdown reports. Markdown can be used by different static site generators too
Specifications
File names
- leaves.<YYYY>.csv
- extras.<YYYY>.csv
Format
Leaves
MMDD [- MMDD], Name, Reason / Details [Optional]
Extra days
MMDD [- MMDD], Name, Reason / Details [Optional]
Example
1115 - 1126, Tony Stark, Hawaii
1129 - 1210, Peter Parker,
1129 - 1202, Bruce Wayne,
1220 - 1224, Loki Laufeyson, Smell the flowers
Usage
Organization setup
- Create a git repo for your organization's leaves data
mkdir leavesdata
cd leavesdata
git init
mkdir data
fname=data/leaves.`date +%Y`.csv
# example data
echo `1129 - 1202, Bruce Wayne,` >> $fname
echo `1220 - 1224, Loki Laufeyson, Smell the flowers` >> $fname
git commit -a
git push origin main
- Install gitleaves
pip install gitleaves
- Generate reports
gitleaves genreports
ls reports/
- Automate report generation Document github actions based report generation
Process
- Apply for leave(s) by adding records to leaves.YYYY.csv
- Raise a PR
- Leave is approved if the PR is merged
Dev Guidelines
- Human Readable data files (as much possible)
TODO
Credits
This package was created with Cookiecutter_ and the audreyr/cookiecutter-pypackage project template.
- Cookiecutter: https://github.com/audreyr/cookiecutter
- audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
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
gitleaves-0.6.3.tar.gz
(12.5 kB
view details)
File details
Details for the file gitleaves-0.6.3.tar.gz.
File metadata
- Download URL: gitleaves-0.6.3.tar.gz
- Upload date:
- Size: 12.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 275d7cf4d02aee6484ddeadc73c9acf402aa5b604fd8acd9deaf9b5bf157adce |
|
| MD5 | cae08bc0f42f8496269e805e93243cd9 |
|
| BLAKE2b-256 | a6dd69adcae2f0b5d4deb1a064dc7b367ae0b675cfaf0bc80c85e55cac6a2ef2 |
