https://github.com/veit/items

https://github.com/veit/items

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/veit/items
• Owner: veit
• Created: 2023-10-14T20:51:33.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-22T11:00:18.000Z (8 months ago)
• Last Synced: 2024-05-22T11:01:15.736Z (8 months ago)
• Language: Python
• Size: 63.5 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSES/BSD-3-Clause.txt

Awesome Lists containing this project

README

        
.. SPDX-FileCopyrightText: 2023 Veit Schiele

.. SPDX-License-Identifier: BSD-3-Clause

==========================

items – a simple todo list

==========================

Status

======

.. image:: https://img.shields.io/github/contributors/veit/items.svg

   :alt: Contributors

   :target: https://github.com/veit/items/graphs/contributors

.. image:: https://img.shields.io/github/license/veit/items.svg

   :alt: License

   :target: https://github.com/veit/items/blob/main/LICENSE

.. image:: https://github.com/veit/items/workflows/CI/badge.svg

   :target: https://github.com/veit/items/actions?workflow=CI

   :alt: CI Status

Installation

============

#. Download and unpack:

   … on Linux/macOS:

   .. code-block:: console

      $ curl -O https://codeload.github.com/veit/items/zip/main

      $ unzip main

      Archive:  main

      …

         creating: items-main/

      …

   … on Windows:

   .. code-block:: ps1con

      C:> curl.exe -o main.zip -O https://codeload.github.com/veit/items/zip/main

      C:> tar -xvzf main.zip

      items-main/

      items-main/.gitignore

      …

#. Install Python packages:

   … on Linux/macOS:

   .. code-block:: console

      $ cd items

      $ python3 -m venv .

      $ source bin/activate

      $ python -m pip install --upgrade pip

      $ python -m pip install -e .

   … on Windows:

   .. code-block:: ps1con

      C:> python -m venv .

      C:> Scripts\python -m pip install --upgrade pip

      C:> Scripts\python -m pip install -e .

Project links

=============

* `Documentation `_

* `GitHub `_

* `Mastodon `_

Collaboration

=============

If you have suggestions for improvements and additions, I recommend that you

create a `Fork `_ of my

`GitHub Repository `_ and make

your changes there. You are also welcome to make a *pull request*. If the

changes contained therein are small and atomic, I’ll be happy to look at your

suggestions.