{"id":23988870,"url":"https://github.com/veit/items","last_synced_at":"2026-04-12T22:03:21.579Z","repository":{"id":200205378,"uuid":"705031940","full_name":"veit/items","owner":"veit","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-22T11:00:18.000Z","size":65,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-22T11:01:15.736Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/veit.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSES/BSD-3-Clause.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-14T20:51:33.000Z","updated_at":"2024-07-17T09:45:52.560Z","dependencies_parsed_at":"2023-10-16T04:06:53.841Z","dependency_job_id":"ef0808f4-a31e-4c8d-9e24-72976d84b3fb","html_url":"https://github.com/veit/items","commit_stats":null,"previous_names":["veit/items"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veit%2Fitems","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veit%2Fitems/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veit%2Fitems/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veit%2Fitems/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/veit","download_url":"https://codeload.github.com/veit/items/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240593178,"owners_count":19825939,"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":"2025-01-07T16:18:40.093Z","updated_at":"2026-04-12T22:03:21.574Z","avatar_url":"https://github.com/veit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. SPDX-FileCopyrightText: 2023 Veit Schiele\n\n.. SPDX-License-Identifier: BSD-3-Clause\n\n==========================\nitems – a simple todo list\n==========================\n\n*items* is a simple command line tool for managing tasks. It allows you to\ncreate, display, update and delete tasks, as well as change their status.\n\nStatus\n======\n\n.. image:: https://img.shields.io/github/contributors/veit/items.svg\n   :alt: Contributors\n   :target: https://github.com/veit/items/graphs/contributors\n.. image:: https://img.shields.io/github/license/veit/items.svg\n   :alt: License\n   :target: https://github.com/veit/items/blob/main/LICENSE\n.. image:: https://github.com/veit/items/workflows/CI/badge.svg\n   :target: https://github.com/veit/items/actions?workflow=CI\n   :alt: CI Status\n\nFeatures\n========\n\n* Create tasks with summary and owner\n* Display tasks, optionally filtered by owner or status\n* Update tasks and their status (todo, in progress, done)\n* Delete individual or all tasks\n* Simple command line interface\n* Programmable Python API\n\nInstallation\n============\n\n#. Download and unpack:\n\n   … on Linux/macOS:\n\n   .. code-block:: console\n\n      $ curl -O https://codeload.github.com/veit/items/zip/main\n      $ unzip main\n      Archive:  main\n      …\n         creating: items-main/\n      …\n\n   … on Windows:\n\n   .. code-block:: ps1con\n\n      C:\u003e curl.exe -o main.zip -O https://codeload.github.com/veit/items/zip/main\n      C:\u003e tar -xvzf main.zip\n      items-main/\n      items-main/.gitignore\n      …\n\n#. Install Python packages:\n\n   … on Linux/macOS:\n\n   .. code-block:: console\n\n      $ cd items\n      $ python3 -m venv .\n      $ . bin/activate\n      $ python -m pip install --upgrade pip\n      $ python -m pip install -e .\n\n   … on Windows:\n\n   .. code-block:: ps1con\n\n      C:\u003e py -m venv .\n      C:\u003e Scripts\\activate\n      C:\u003e python -m pip install --upgrade pip\n      C:\u003e python -m pip install -e .\n\nUsage\n=====\n\nCommand line instructions\n-------------------------\n\nAfter activating the virtual Python environment, you can use items on the\ncommand line:\n\n.. code-block:: console\n\n   # Display all tasks (default if no command is specified)\n   $ items\n\n   # Add a new task\n   $ items add \"My task description\" --owner \"Veit\"\n\n   # Show filtered list\n   $ items list --owner \"Veit\" --state \"todo\"\n\n   # Update task\n   $ items update 1 --owner \"Veit\" --summary \"Update description\"\n\n   # Change the status of a task\n   $ items start 1    # Set status to \"in progress\"\n   $ items finish 1   # Set status to \"done\"\n\n   # Delete task\n   $ items delete 1\n\n   # Display number of tasks\n   $ items count\n\n   # Display the file path of the database\n   $ items config\n\n   # Display version\n   $ items version\n\nPython API\n----------\n\nYou can also use the items functionality directly in your Python code:\n\n.. code-block:: python\n\n   # Initialise database\n   from items import ItemsDB, Item\n\n   # Connect to database\n   db = ItemsDB(\"/path/to/database\")\n\n   # Add new task\n   item = Item(summary=\"Implement feature\", owner=\"Veit\")\n   item_id = db.add_item(item)\n\n   # Retrieve task by ID\n   item = db.get_item(item_id)\n\n   # Update task\n   db.update_item(item_id, Item(summary=\"Implement feature with tests\"))\n\n   # Change status\n   db.start(item_id)  # Set to \"in progress\"\n   db.finish(item_id)  # Set to \"done\"\n\n   #  List tasks (optionally with filtering)\n   all_items = db.list_items()\n   veit_tasks = db.list_items(owner=\"Veit\")\n   in_process = db.list_items(state=\"in progress\")\n\n   #  Delete task\n   db.delete_item(item_id)\n\n   # Close connection\n   db.close()\n\nConfiguration\n=============\n\nThe database file is saved under ``~/items_db`` by default. You can change this\npath by setting the environment variable ``ITEMS_DB_DIR``:\n\n.. code-block:: console\n\n   # Linux/macOS\n   $ export ITEMS_DB_DIR=/pfad/zu/meiner/datenbank\n\n   # Windows\n   C:\u003e set ITEMS_DB_DIR=C:\\pfad\\zu\\meiner\\datenbank\n\nProject links\n=============\n\n* `Documentation \u003chttps://items.cusy.io\u003e`_\n* `GitHub \u003chttps://github.com/veit/items\u003e`_\n* `Mastodon \u003chttps://mastodon.social/deck/@Python4DataScience\u003e`_\n\nCollaboration\n=============\n\nIf you have suggestions for improvements and additions, I recommend that you\ncreate a `Fork \u003chttps://github.com/veit/items/fork\u003e`_ of my\n`GitHub Repository \u003chttps://github.com/veit/items/\u003e`_ and make\nyour changes there. You are also welcome to make a *pull request*. If the\nchanges contained therein are small and atomic, I’ll be happy to look at your\nsuggestions.\n\nLicense\n=======\n\nThis project is licensed under the BSD-3-Clause licence. Further information can\nbe found in the ``LICENSE`` file in the project repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveit%2Fitems","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveit%2Fitems","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveit%2Fitems/lists"}