Reference¶
CLI Commands¶
absorb.main¶
Creates the main click group for absorb.
absorb.core.tasks.commands¶
tasks¶
The main click group for tasks.
tasks [OPTIONS] COMMAND [ARGS]...
add¶
- Adds a new task to tasks.json and commits the task to the git
repository.
- param name
Name of the task.
- type name
str
- param due_date
Due date for the task.
- type due_date
str
- param priority
Priority for the task.
- type priority
str
- param group
Group for the task.
- type group
str
- rtype
None
tasks add [OPTIONS] NAME DUE_DATE PRIORITY GROUP
Arguments
- NAME¶
Required argument
- DUE_DATE¶
Required argument
- PRIORITY¶
Required argument
- GROUP¶
Required argument
delete¶
Deletes a task from tasks.json.
- param id
ID of the task.
- type id
str
tasks delete [OPTIONS] ID
Arguments
- ID¶
Required argument
edit¶
- Edits an existing task in tasks.json and commits the changes in the git
repository.
- param id
ID of the task.
- type id
str
- param name
Name of the task.
- type name
str
- param date
Due date for the task.
- type date
str
- param priority
Priority for the task.
- type priority
str
- param group
Group for the task.
- type group
str
- rtype
None
tasks edit [OPTIONS] ID NAME DATE PRIORITY GROUP
Arguments
- ID¶
Required argument
- NAME¶
Required argument
- DATE¶
Required argument
- PRIORITY¶
Required argument
- GROUP¶
Required argument
show¶
Shows all tasks present in tasks.json.
tasks show [OPTIONS]
show-group¶
Shows all tasks belonging to group_name
- param group_name
Group name to which the task belongs.
- type group_name
str
- rtype
None
tasks show-group [OPTIONS] GROUP_NAME
Arguments
- GROUP_NAME¶
Required argument
absorb.core.kanban.commands¶
kanban¶
Creates the main click group for kanban boards.
kanban [OPTIONS] COMMAND [ARGS]...
add¶
Adds a card to the kanban board.
- param name
Name of the card.
- type name
str
- param status
Status of the card.
- type status
str
- param description
Description of the card.
- type description
str
- param tags
Tags for the card.
- type tags
str
- rtype
None
kanban add [OPTIONS] NAME STATUS DESCRIPTION TAGS
Arguments
- NAME¶
Required argument
- STATUS¶
Required argument
- DESCRIPTION¶
Required argument
- TAGS¶
Required argument
delete¶
Deletes a card from the kanban board.
- param id
ID of the card.
- type id
str
- rtype
None
kanban delete [OPTIONS] ID
Arguments
- ID¶
Required argument
edit¶
Edits a card in the kanban board.
- param id
ID of the card.
- type id
str
- param name
Name of the card.
- type name
str
- param description
Description of the card.
- type description
str
- param tags
Tags for the card.
- type tags
str
- rtype
None
kanban edit [OPTIONS] ID NAME DESCRIPTION TAGS
Arguments
- ID¶
Required argument
- NAME¶
Required argument
- DESCRIPTION¶
Required argument
- TAGS¶
Required argument
move-card¶
Moves a card to the specified status.
- param id
ID of the card.
- type id
str
- param new_status
The new status to which the card should be moved to.
- type new_status
str
- rtype
None
kanban move-card [OPTIONS] ID NEW_STATUS
Arguments
- ID¶
Required argument
- NEW_STATUS¶
Required argument
show¶
Shows the kanban board.
kanban show [OPTIONS]
absorb.core.idea.commands¶
idea¶
The main click group for idea.
idea [OPTIONS] COMMAND [ARGS]...
edit¶
- Edits an existing idea in ideas.json and commits the changes in the git
repository.
- param id
ID of the idea.
- type id
str
- param name
Name of the idea.
- type name
str
- param description
Description of the idea.
- type description
str
- param tags
Tags for the idea.
- type tags
str
- rtype
None
idea edit [OPTIONS] ID NAME DESCRIPTION TAGS
Arguments
- ID¶
Required argument
- NAME¶
Required argument
- DESCRIPTION¶
Required argument
- TAGS¶
Required argument
new¶
- Adds a new idea to ideas.json and commits the idea to the git
repository.
- param name
Name of the idea.
- type name
str
- param description
Description of the idea.
- type description
str
- param tags
Tags for the idea.
- type tags
str
- rtype
None
idea new [OPTIONS] NAME DESCRIPTION TAGS
Arguments
- NAME¶
Required argument
- DESCRIPTION¶
Required argument
- TAGS¶
Required argument
open¶
Opens an idea present in ideas.json.
- param id
ID of the idea.
- type id
str
- rtype
None
idea open [OPTIONS] ID
Arguments
- ID¶
Required argument
show¶
Shows all ideas present in ideas.json.
idea show [OPTIONS]
Utility Functions¶
absorb.utils.log_utils¶
- absorb.utils.log_utils.get_logger() → logging.getLogger¶
Initializes a logger which is utilized by the click commands.
- Returns
Returns a logger.
- Return type
logging.getLogger
absorb.utils.tasks_utils¶
- absorb.utils.tasks_utils.convert_timedelta(duration: datetime.timedelta) → collections.namedtuple¶
Converts a timedelta object into the custom ExtractedDate namedtuple.
- Parameters
duration (timedelta) – Timedelta object for date.
- Returns
ExtractedDate namedtuple.
- Return type
namedtuple
- absorb.utils.tasks_utils.parse_tasks(file_content: Any) → None¶
Prints the tasks table.
- Parameters
file_content (Any) – File content containing tasks.
- Return type
None
absorb.utils.kanban_utils¶
- absorb.utils.kanban_utils.parse_card(card: Any) → str¶
Returns a string containing the card content.
- Parameters
card (Any) – JSON object containing data for the card.
- Returns
Formatted string with the card.
- Return type
str
- absorb.utils.kanban_utils.parse_kanban(content: Any) → None¶
Prints the kanban board.
- Parameters
content (Any) – File content containing cards.
- Return type
None
absorb.utils.idea_utils¶
- absorb.utils.idea_utils.open_idea(file_content: Any) → None¶
Prints the parsed idea.
- Parameters
file_content (Any) – File content containing the idea.
- Return type
None
- absorb.utils.idea_utils.parse_idea(idea: Any) → str¶
Returns a string containing the idea.
- Parameters
idea (Any) – JSON object containing data for the idea.
- Returns
Formatted string with the idea.
- Return type
str
- absorb.utils.idea_utils.parse_ideas(file_content: Any) → None¶
Prints the ideas table.
- Parameters
file_content (Any) – File content containing ideas.
- Return type
None