Skip to main content

CLI to submit tasklogs to Jira

Project description

tasklog: a terminal based application to submit work/task logs to JIRA issues, to Slack channels

Compatible with Python versions

  • Python 3.7.3+

Basic Setup

Install for all users, from Pypi

sudo bash make.sh --install-package-globally-from-pypi
tasklog -h

Install + run app (for development):

source make.sh --enable-development-env
bash make.sh --install-dependencies
bash make.sh --install-package-in-development-mode
bash make.sh --show-tasklog-options

Install for all users, from source

sudo bash make.sh --install-package-globally-from-source
tasklog -h

Setup/Run the application:

bash make.sh --show-tasklog-options
OR
bash make.sh --show-tasklog-submit-worklog-cli-sample
bash make.sh --show-tasklog-submit-daily-cli-sample

Run the test suite:

Requirement: App is installed for development purpose

bash make.sh --install-test-dependencies
bash make.sh --run-tests

Sample Config file:

# Slack Server
slack:
 # API Token
 apiToken: "FOOBAR"
 # Channel to post to, without # prefix
 channel: "daily"
# JIRA Server
jira:
 # Server URL
 serverURL: "http://.example.com"
 # Account Username
 username: "me"
 # Account Password
 password: "you"
 # HTTPS connection must be with a valid server certificate. boolean: true / false
 verifyCertificate: false
# JIRA Issue Preferences
issue:
 # Issue Creation Preferences
 creation:
   # Prefered Issue Type when creating issues
   # (list of issue type name, sorted in descending order)
   typePreferedOrder:
     - Task
     - Improvement
     - Bug
     - New Feature
     - Sub-Task
     - Epic
     - Story
     - Technical Task
     - Question
# New JIRA Issue prefered title as a numbered title
dayX:
 # Starting title keyword
 prefixPreferedOrder:
   - Day
   - Jour
# CLI Logging
logging:
 # Logging level. Enum: DEBUG, INFO, WARN, ERROR, CRITICAL
 severity: "INFO"
 # Log file name
 file: "tasklog.cli.log"

Sample tasklog file:

MOCKTEST-1
23-05-2019
4.5h
This log will be created against an existing JIRA issue named "MOCKTEST-1"

WORKLOG#
MOCKTEST
22-05-2019
8h
This is log will be logged against a brand new JIRA issue in project with key MOCKTEST
- and an extra line
- and an extra line 2
-- and an extra line 3

WORKLOG#
MOCKTEST
23-05-2019
4.5h
This is a multiline description
it is cool is not it ?

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tasklog, version 0.0.12
Filename, size File type Python version Upload date Hashes
Filename, size tasklog-0.0.12-py3-none-any.whl (22.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size tasklog-0.0.12.tar.gz (15.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page