| Name | todolog JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Actively Manage ToDos! |
| upload_time | 2023-12-31 17:36:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
todo
log
todolog
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# todolog
Actively Manage ToDos!
## Motivations
Annotated ToDos are not well managed.
## Features
- If there is any ToDo that is past due, logs a message.
- Different log levels can be applied for each ToDo.
- ToDo can be actively managed as a separate TOML file, not as an annotation.
- Logging can be turned off.
- Each module can have a separate TOML file.
- Configurations in TOML file is cached on memory without continuing to read.
## Usage
1. Install todolog
```shell
pip install todolog
```
2. Specify the name of the configuration file to be used for todo logging in `pyproject.toml`(`pyproject.toml` must be under the source root).
```toml
# pyproject.toml
[tool.todolog]
filename = "todolog.toml"
default_log_message = "This is a default log message."
```
3. Write a configuration for todos in TOML format.
```toml
# todolog.toml
[key1]
responsible = "qu3vipon@gmail.com"
message = "This is a log message."
due = 2023-12-31
log_level = "WARNING"
description = """
This is a description about a todo.
It can be written very long, but it is ignored at run time.
"""
```
4. Add a decorator to the function that should be managed.
```python
@todo(key="key1")
def deprecated_function():
pass
```
5. (Optional) Logging can be turned off.
```python
@todo(key="key1", ignore=True)
def deprecated_function():
pass
```
Raw data
{
"_id": null,
"home_page": null,
"name": "todolog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "todo,log,todolog",
"author": null,
"author_email": "qu3vipon <qu3vipon@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f7/eb/c1b5fc1dfb031bffcfed4c6f738abe2a7da9a18114d09c095131299f74c5/todolog-0.1.3.tar.gz",
"platform": null,
"description": "# todolog\nActively Manage ToDos!\n\n## Motivations\nAnnotated ToDos are not well managed.\n\n## Features\n- If there is any ToDo that is past due, logs a message.\n- Different log levels can be applied for each ToDo.\n- ToDo can be actively managed as a separate TOML file, not as an annotation.\n- Logging can be turned off.\n- Each module can have a separate TOML file. \n- Configurations in TOML file is cached on memory without continuing to read.\n\n## Usage\n1. Install todolog\n ```shell\n pip install todolog\n ```\n\n2. Specify the name of the configuration file to be used for todo logging in `pyproject.toml`(`pyproject.toml` must be under the source root). \n ```toml\n # pyproject.toml\n [tool.todolog]\n filename = \"todolog.toml\"\n default_log_message = \"This is a default log message.\"\n ```\n\n3. Write a configuration for todos in TOML format.\n ```toml\n # todolog.toml\n [key1]\n responsible = \"qu3vipon@gmail.com\"\n message = \"This is a log message.\"\n due = 2023-12-31\n log_level = \"WARNING\"\n description = \"\"\"\n This is a description about a todo.\n It can be written very long, but it is ignored at run time.\n \"\"\"\n ```\n\n4. Add a decorator to the function that should be managed.\n ```python\n @todo(key=\"key1\")\n def deprecated_function():\n pass\n ```\n\n5. (Optional) Logging can be turned off.\n ```python\n @todo(key=\"key1\", ignore=True)\n def deprecated_function():\n pass\n ```\n",
"bugtrack_url": null,
"license": null,
"summary": "Actively Manage ToDos!",
"version": "0.1.3",
"project_urls": {
"Home": "https://github.com/qu3vipon/todolog"
},
"split_keywords": [
"todo",
"log",
"todolog"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9ea6cd7846527c3579a948e2f1a724dd7cfe302941f9af1571ae7923d66d4c6e",
"md5": "ccea7e5ba4114bd12cc0267030cfffee",
"sha256": "3dc0d2d32c5acd1ae787417cf1bd0bce0a93582539fc49c30a34a48ff0a9e582"
},
"downloads": -1,
"filename": "todolog-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ccea7e5ba4114bd12cc0267030cfffee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4482,
"upload_time": "2023-12-31T17:36:11",
"upload_time_iso_8601": "2023-12-31T17:36:11.010884Z",
"url": "https://files.pythonhosted.org/packages/9e/a6/cd7846527c3579a948e2f1a724dd7cfe302941f9af1571ae7923d66d4c6e/todolog-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f7ebc1b5fc1dfb031bffcfed4c6f738abe2a7da9a18114d09c095131299f74c5",
"md5": "6cb6260db439d3b09f114041c22a91fa",
"sha256": "996d28aea1197e544324ad5f968b2b34d963ce8290a98e877c810baf9e0f0237"
},
"downloads": -1,
"filename": "todolog-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "6cb6260db439d3b09f114041c22a91fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7351,
"upload_time": "2023-12-31T17:36:16",
"upload_time_iso_8601": "2023-12-31T17:36:16.020836Z",
"url": "https://files.pythonhosted.org/packages/f7/eb/c1b5fc1dfb031bffcfed4c6f738abe2a7da9a18114d09c095131299f74c5/todolog-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-31 17:36:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qu3vipon",
"github_project": "todolog",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "todolog"
}
