{"id":22473135,"url":"https://github.com/bas080/will","last_synced_at":"2025-03-27T16:26:10.239Z","repository":{"id":26011349,"uuid":"29453965","full_name":"bas080/will","owner":"bas080","description":"CLI (command line interface) app to manage your tasks ( written in python )","archived":false,"fork":false,"pushed_at":"2015-02-15T19:47:13.000Z","size":232,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T20:12:17.819Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bas080.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-19T04:40:03.000Z","updated_at":"2018-05-25T09:14:44.000Z","dependencies_parsed_at":"2022-08-24T03:00:59.189Z","dependency_job_id":null,"html_url":"https://github.com/bas080/will","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bas080%2Fwill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bas080%2Fwill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bas080%2Fwill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bas080%2Fwill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bas080","download_url":"https://codeload.github.com/bas080/will/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245880960,"owners_count":20687643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-06T12:19:21.544Z","updated_at":"2025-03-27T16:26:10.203Z","avatar_url":"https://github.com/bas080.png","language":"Python","readme":"Will Do\n=======\n\nDo you have the will to do your todos? Now with \"will\" you can easily manage\nyour todo tasks using the command line and storing tasks in a human readable\nmarkdown format combined with Tabular Format.\n\nFeatures\n========\n- Every directory can have a todo list (.will directory)\n- Tasks have properties including title, tags, description and status\n- Tasks are simple text files that require a certain layout.\n- Quickly add, change status and cleanup your tasks.\n\nSetup\n=====\nAdd the following alias to your .~/bashrc\n```bash\nexport EDITOR=nano\nalias will='python ~/path/to/will.py'\n```\nYou need to define a default editor and you can use whatever alias you like.  \nIf you do not use \"will\" as alias and you are using the autocompletion function.\nThen please do not forget to change the \"_will\" function to the alias you are\nusing. \"_\u003cyour_preffered_command_name\u003e\"\n\nUsage\n=====\nThis is a command line tool. The command is \"will\". Here are some examples on\nhow to use the \"will\".\n\n**create a todo list(.will directory) in current directory**\n```bash\nwill init\n```\n\n**create a new task**\n```bash\nwill Start typing my task title\n```\nImportant to know is that the .will folder that will be used is the first one\nfound while looking in the current folder and then with every search iteration\ngoing in the parent folder.\n\nThus if there is no .will folder in the current folder but there is one in it's\nparent. Then that one will be used.\n\nThis opens your default editor with the subject in it already. See chapter named\ntasks to find out what a task file can and should contain.\n\n*Remember to start typing with a capital letter. This is done to avoid conflicts with the\noptions.*\n\n**list the tasks**\n```bash\nwill\n```\n\nThis will output the following\n\n```bash\nTASK  SUBJECT                   CATEGORY      DESCRIPTION                       DEADLINE         \n9197  Add font icons to portof  ...           replace the folder file and chap  2w 4d 21h        \n4955  Fix dammen board generat  Bug           The board generator is doing som  done             \n7097  Learn Angular             Learn         The technologies industry uses.   Jan 21 2015      \n4562  Nationalist               Development   data/scenarios/nationalist.js:    3w 2d 21h        \n6439  Learn Git better          Learn         Make aliases from learned comman  3w 3d 21h        \n2986  Will todo manager         Development   Keep the readme up to date with   -2d 2h           \n4839  Dammen                    Development   - Ability to add a game. States   21h              \n```\n\nYou can also list tasks that contain either the ID or certain keywords. It\nsearches case insensitively.\n\n```bash\nwill ls dev\n  #or\nwill list dev\n\nTASK  SUBJECT                   CATEGORY      DESCRIPTION                       DEADLINE         \n4562  Nationalist               Development   data/scenarios/nationalist.js:    3w 2d 21h        \n2986  Will todo manager         Development   Keep the readme up to date with   -2d 2h           \n4839  Dammen                    Development   - Ability to add a game. States   21h              \n```\n\n**view tasks**\n```bash\nwill view 3826\n```\nshow the file contents\n\n**find tasks**\n```bash\nwill find bug\n```\nThis returns the files of the tasks that contain CSS in the title and in the content.\n```bash\n/home/oen/.will/18839.md\n```\n\n**edit a task**\n```bash\nwill edit 1843\n  #or\nwill edit re-factor code\n```\nOpens up the task with corresponding ID or the task that matches the keywords\nthe most in your favorite EDITOR. \n\n**remove task**\n```bash\nwill rm 8372 3729 6234\n  #or\nwill remove 5819\n```\nYou cannot remove using keywords. This is done to avoid accidental removals.\nRemember that when removing a task it is gone for good. In case you want to set\nthe status of a task to completed or something similar, consider using categories instead to\nset the category of a task to completed or done. That way you do not loose\nvaluable information regarding the tasks.\n\n**export the tasks**\n*not yet implemented*\n```bash\nwill export\n```\n*An example of the output looks like this.*\n```bash\n```\n\nTasks\n=====\nA task file format is dead simple here it goes.\n```markdown\nTitle\tcategory_one\tcategory_two\tcategory...\n=====\nThis is a description\n- That include markdown style bullets\n- And it describes clearly what the\n- task is about.\n15 feb 2015\n```\nFirst line is the title and the categories. Notice the tabs between the title\nand the categories. To define a category you have to use tabs and it has to be\non the first line.\n\nThe description should always start on the third line. The second line should\nalways have the === separation which at the same time defines the header.\n\nThe bottom line is used to define the due date. The format for now must be 15\nfeb 2015 for it to show time till and time since. In the future I might also add\na start of task date. Making it also more useful for planning activities.\n\nConfigure\n=========\nThe \"config\" file can be found in every .will directory. So what can be\nconfigured? If not the config of the parent .will is used.\n\n## template\nMaybe you would preffer to make changes to the way data is represented\nduring viewing of tasks or logs. The following keywords are assigned for this\nfeature. If not defined they revert to the default.\n\n\n```rc\nstatusses_template = In directory {path}\\n  (use \"will set \u003cstatus\u003e \u003ctask...\u003e\" to change task(s) as status)\\n{statusses}\nstatus_template = Color.bold + '\\n{status}: {amount}\\n{tasks}\\n' + Color.end\ntask_template = Color.end + Color.red + '\\n\\t{id}\\t' + Color.end + '{title}'\n```\n\n## tags\nYou are also able to add default tags to a task. This might be handy for adding\nauthor name or project name. Anything really. The tags are comma seperated.\n\n```rc\ntags = author bas080, project will, management tool\n```\n\nRoad map\n========\n- Auto-completion functions for bash and Zsh shell.\n- Revive tasks that where \"cleaned\" from the list.\n- Tasks can be exported to JSON. (WIP)\n- Logs all user actions so you can see what happened.\n\n\nContribute\n==========\nPlease leave a comment if you know of improvements or even better, send me a\npull request. If you really like the project then consider starring or following\nit.\n\nLinks\n=====\n\u003ca href=\"https://github.com/bas080/will\"\u003eGitHub\u003c/a\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbas080%2Fwill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbas080%2Fwill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbas080%2Fwill/lists"}