INFO1112 A1 - Just a friendly reminder
In this assignment, you'll be creating a basic application called "Jafr" (short for "Just afriendly reminder"). This application helps multiple users manage their tasks and meetingson a Unix-like OS (a popular choice of OS in industry where developers might sharecomputer system or host web applications).Jafr is Unix-friendly. This means that
1. Users interact with Jafr by typing commands in a command-line interface.
2. Jafr assumes that all the tasks and meetings are stored in text files that are otherwisemanaged by users of the shared system. Users simply edit these files themselves whenthey want to make changes outside of Jafr.You will implement Jafr in Python and write a simple start upscriptin Bash. You will thenwrite I/O end to end tests for Jafr.These specifications first describe each behaviour of Jafr. The final sections describe errorhandling, how to write tests for Jafr and provide some hints.
Overview
Jafr is designed to run whenever a user opens their terminal at the beginning of their day.Users can choose to view reminders that are relevant to the current day, or make changes.Changes can include sharing reminders with other users.There are two kinds of reminders: tasks and meetings.NoteStudents and tutors often have great suggestions to specifications.While no majorchanges will be made after release, this assignment specification may be clarified up to
Week 4, 27/08/2023. Revised versions will be clearly markedandaccompanyingannouncements made to Edstem.
Setup
Jafr primarily relies on two text files for each user: tasks.md and meetings.md . These textfiles are placed inside a master directory of the user's choosing.The user chooses their master directory inside a JSON file called user-settings.jsonlocated at ~/.jafr/user-settings.json . You may consider ~/.jafr/ a 'hidden' directory,for Jafr's internal use only.user-settings.json has a single key valuepair storing the absolute path to the masterdirectory.Sample user-settings.json :HintNotice that the hidden directory .jafr/ is inside a user's home directory which can besymbolically referred to by ~.
You can fetch the path referred to by ~ in Python by using os.path.expanduser('~')
{
"master": "/home/dailystuff"
}Help! What's a JSON file?JSON is a universal file format for easy data reading and writing. There are two kinds ofdata structures possible to write in JSON: objects and arrays.Curly braces are used to define an object: a collection of name/value pairs (exactly like
a dictionary in Python). Square brackets are used to define an array:an ordered list ofvalues (exactly like a list in Python).You may use Python's json library in your implementation to read JSONfiles. Seejson.load()Notetasks.md and meetings.md for each user are given inside your scaffold. Assume theuser creates these themselves using their preferred text editor.The ~/.jafr/ directoryfor each user is also given inside your scaffold. You do not
have to handle the case where ~/.jafr/user-settings.json is missing for any user.Assume Jafr has some installation script that handlesthis, outside of the scope of yourassignment.Text files containing remindersThe two text files inside the master directory for each user are as follows.tasks.mdThis text file contains dot pointed tasks with the following format. Dates follow DD/MM/YY, or
more precisely the C standard format %d/%m/%y (see the datetimedocs). You will only everhave to handle dates in the years 1969 - 2068 (inclusive).For examplemeetings.mdThis text file contains dot pointed meetings with the following format. Times follow HH:mm,or moreprecisely the C standard format %H:%M (see the datetime docs).For example
- Due:
- Complete INFO1112 A1 Due: 01/10/23 not complete
- Acquire Twitter Due: 30/10/23 complete
- Study linux namespaces Due: 30/09/23 not complete Hint
Notice that a task must end with complete or not complete !Moreover, the format implies that a task description should never contain the stringDue: . You do not have to handle the case where a user does this.-
Jafr runs when jafr.py is executed by the Python interpreter. There is one command lineargument which will contain a path (absolute orrelative) to a given passwd file. More on thisbelow.For example
Jafr first displays relevant reminders (tasks followed by meetings),before showing a menu.The menu contains the following.
A user chooses one option only.This invokes the relevant behaviour, described below. If the user enters 6 , Jafr exits. Aftercompleting a behaviour, Jafr returns to the menu.For examplepython3 jafr.py passwdListed meetings are simply displayed in the order that they appear in meetings.mdWhich directory would you like Jafr to use?
Setup
You do not have to handle a missing ~/.jafr directory or~/.jafr/user-settings.jsonfile for any user.If either tasks.md or meetings.md aremissing from the user's chosen master directorythen Jafr does not display any reminders or show the menu. Jafr writes the following
message to standard error before simply exiting.UpdateSome systems (which include Edstem's Arch and macOS) may not run .bashrc in
login shells. These are shells that are started upon logging in.
However, on any system you may start Bash again by simply executing bash . This willbe a "non-login" shell and will always run .bashrc .HintIn order to be awarded this section of the assignment, you may assume jafr.py andpasswd exists inside every user's home directory.
Remember .bashrc is a universal script. This means you can findplenty of help bylooking this up online.If the user's chosen masterdirectory does not exist, then Jafr does not display anyreminders or show the menu. Jafr writes the following message to standard error before
exiting.Text filestasks.md and meetings.md can contain any amount of text, and not necessarily onlytasks/meetings. A line is only considered a task or meeting if it is a dot point (the line Edstem. This will make it easier to handle the hidden directories and edittext files.tasks.md and meetings.md filesA test is constructed by creating a .in file and a .out file. The filename prefix to these
should describe the test.The .in file should contain all user input that will be written to standard input. Thecorresponding .out file should contain output that is expected to be written by Jafr to
standard output.The other files and directories present in tests/ are shared across all tests. You may writethree to five test users and a handful of test cases for each user. That is, each test caseshould choose a user to rely on.You can use your own tests as follows.
1. Run python3 jafr.py tests/passwd .
2. Run each test by manually inspecting the appropriate .in and .out file. Enter inputfrom the .in file. Compare your program's actual output to the .out file.Any changes to tasks.md and meetings.md files made by your tests will not be capturedwith a .in and .out file. You do not have to capture these changes in your tests.You may include any comments about your testing in a test_readme.md to your marker ifyou wish, such as current date and current user for each test.See Daniel's video on Canvas for more about manual testing. See pinned post #284 onEdstem for more help around changing users for each test while on your local machine.Further hints and where to startHint"Home directories" of your test users will need to be defined in your tests/passwd file.While tests/passwd may not be used by your tests (which do not need to cover。