Sync project lead with ical (for on call assignees)
Project description
joca
Jira On Call Assignee
Check an ical url (files not supported yet) for current on call.
Installation
pip install joca
Configuration file
The configuration holds 3 sections, local, jira and projects.
local is for configuring logging.
jira houses the username, password and server url of the Jira instance joca connects to.
projects is a list of objects that tell joca what project, what ical and the regex to apply to the event summary to extract the users name.
Here is a basic configuration:
{ "local": { "logging": { "file": "/var/log/joca.log", "format": "%(asctime)s %(levelname)s %(message)s", "level": "info" }, }, "jira": { "server": "https://instance.jira.com", "username": "api-user", "password": "hunter2" }, "projects": [ { "key": "PROJ", "ical": "https://totally.a-website.com/calendar", "regex": "^(.*)$" } ] }
local.logging, format is not required.
local.logging.level doesn’t need to be uppercase.
projects.#.key doesn’t have to be uppercase, joca will handle that.
projects is a list, so feel free to have multiple projects set up, and it will loop over them.
To do
Check out todo.txt for the basic list of to-do’s.
todo.txt follows the syntax rules laid out here.
Version Numbering
joca follows the three major tenets of SemVer.
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. (Preston-Warner, 2013)
Build metadata MAY be denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch or pre-release version.
Build version follows RFC-1912 section 2.2:
The recommended syntax is YYYYMMDDnn (YYYY=year, MM=month, DD=day, nn=revision number. This won’t overflow until the year 4294” (Barr, 1996)
Example: 1.23.4-2018033000:
Major version 1
Minor version 23
Patch version 4
Build number 2018033000 => 2018 03 30 00
Please read the full spec at the link above or in the citations.
Exit codes
Exit/Error codes use the best approximation from errno.h.
Code |
errno.h |
joca usage |
---|---|---|
2 |
ENOENT |
The file does not exist. |
5 |
EIO |
The output was not expected. |
13 |
EACCES |
Jira returned a 401 Not Authorized. |
22 |
EINVAL |
Supposed Lead cannot be made Project Lead. |
43 |
EPROTONOSUPPORT |
File failed schema validation. |
78 |
ENOSYS |
Required import is not installed. |
Copyright
JOCA – Jira On Call Assignee – Change project lead based on an ical event. Copyright (C) 2018 Bryce McNab
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Citations
Preston-Warner, T. (2013). Semantic Versioning 2.0.0. Retrieved November 27, 2017, from https://semver.org/spec/v2.0.0.html
Barr, D. (1996). Common DNS Operational and Configuration Errors. Retrieved on March 30, 2018, from https://tools.ietf.org/html/rfc1912#section-2.2
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
Built Distribution
File details
Details for the file joca-1.4.2.tar.gz
.
File metadata
- Download URL: joca-1.4.2.tar.gz
- Upload date:
- Size: 22.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/2.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 224eaece7ae6f732ecf36e574704462e36171a0f4076738b05c26d65c1ffe514 |
|
MD5 | 6cc21108bd624e490d43f8b3a910b73b |
|
BLAKE2b-256 | 7004c793e6774a00702918728216250bea0bcbb425106c8d8052658790be8a7f |
File details
Details for the file joca-1.4.2-py2-none-any.whl
.
File metadata
- Download URL: joca-1.4.2-py2-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/2.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32d17d0ae2c750b493d5f1d0fffefc0f0f570e0972957c8b307e0cb67f151e6f |
|
MD5 | 51a0992c8ec7dfdd3fd7fccb61e689a6 |
|
BLAKE2b-256 | 5aad0430dc5e72815bc61af9c81559a97f281391525190c69d353ad4e6e8f72d |