GitCalendar
Tool that generates an ICS file from issues, milestones and iterations, of one or more GitLab projects. Only events with a due date are considered.
Setup
The script requires Python >= 3.6 and uses the libraries ics (Apache License v2.0) and python-gitlab (LGPL v3.0). You can install it from PyPi with the following command:
pip install gitcalendar
Usage
There are two options of running the script:
Run it with a config
- Rename gitlab-config.ini.example to
gitlab-config.iniand fit to your needs - Make sure that all wanted variables are given
- Make sure to declare your private token, a valid project or group id, and the path where your calendar files should be generated at.
Once this is done, you can run the script as follows:
gitcalendar --config <PATH OF YOUR CONFIG>
Run it with all the options you need
Warning! Please consider using the prior option for not leaking any access tokens
- Here, there's a need to declare the url of the gitlab instance, your private token, and at least one project or group id.
gitcalendar -u <URL> -t <PRIVATE TOKEN> -p <LIST OF PROJECT IDS> -g <LIST OF GROUP IDS>
For more options please use:
gitcalendar -h
Development
After you cloned the repository and changed into it, you can perform the following actions.
Setup
Install with pip as follows:
pip install -e .[develop]
Package Build
You can build a source package with the following command:
python setup.py sdist
You can build a wheel with the following command:
python setup.py bdist
Changes
Please see the CHANGELOG.md for notable changes.
Contributing
Please see the CONTRIBUTING.md if you want to contribute.
Contributors
Please see CONTRIBUTORS.md for further information about the contributors.
License
Please see LICENSE.md for further information about how the content is licensed.
Metadata
Release files for gitcalendar 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gitcalendar-1.0.0.tar.gz | 6.9 kB | Without provenance | Details for gitcalendar-1.0.0.tar.gz |
Release files / gitcalendar-1.0.0.tar.gz
| Download URL | gitcalendar-1.0.0.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
982440f3bdc8270dd821f74d9ab14cbea251d0c82941ca5adbed627a8e281a68
|
|
BLAKE2b-256 checksum How to use checksums |
ed7c8e3f012b017d3cfb7cc9f9e135c891585d15b2048190c4cc926d9b5fee40
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.8
|
Security for gitcalendar 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.