`tlo.conf` should be in user's data directory

Open
#1,054 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
cli

Research direction

Start by locating the tlo command entry point and the code that currently loads tlo.conf from the TLOmodel source directory. Evaluate the cross-platform Python libraries mentioned in the issue and choose one for the platform-specific user data locations. Done means tlo can run from outside the source directory and find its configuration in the user's data directory on macOS, Windows, and Linux.

Written by the indexing model from the issue text.

Description

enhancement framework

tlo.conf holds the configuration for the tlo command-line tool (specifically settings related to connecting to and using Azure Batch services). We'd like to increase the usefulness and utility of the tlo tool (e.g. run from anywhere, set where the user wants to save their output files etc.).

Currenty, tlo.conf is assumed to live at the top of the TLOmodel source directory. The tlo command needs to be executed in that same directory. We want to setup the tlo.conf file in the user's data directory (i.e. ~/Library/Application Support/TLOmodel on MacOS; C:\Users\\AppData\Local\TLOmodel\TLOmodel on Windows; ~/.config/TLOmodel on Linux)

There are a few Python libraries that can handle this cross-platform. Need to evaluate them, and pick one to update tlo.

Dominant language
Python
Stars
35
Forks
17
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from UCL/TLOmodel

All issues in UCL/TLOmodel

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.