From 61ab6fcff829bc26ce0508644b6b2c5dacdea1bc Mon Sep 17 00:00:00 2001 From: Nineteendo Date: Tue, 17 Sep 2024 18:58:32 +0200 Subject: [PATCH] Add pipx command --- docs/source/get-started.rst | 4 +++- docs/source/index.rst | 2 ++ src/jsonyx/_decoder.py | 1 - src/jsonyx/_manipulator.py | 1 - 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/source/get-started.rst b/docs/source/get-started.rst index b95d778..24ff9bb 100644 --- a/docs/source/get-started.rst +++ b/docs/source/get-started.rst @@ -40,7 +40,9 @@ To use :mod:`jsonyx`, first install it using pip, .. rubric:: pipx (PyPI) - .. todo:: Add command + .. code-block:: console + + $ pipx install jsonyx .. tab:: GitHub diff --git a/docs/source/index.rst b/docs/source/index.rst index 21d9b89..cec2816 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -93,6 +93,8 @@ to :ref:`install ` the project. api/index cli +.. todo:: Add specification + .. toctree:: :caption: About the Project :hidden: diff --git a/src/jsonyx/_decoder.py b/src/jsonyx/_decoder.py index df06581..7e248d7 100644 --- a/src/jsonyx/_decoder.py +++ b/src/jsonyx/_decoder.py @@ -1,6 +1,5 @@ # Copyright (C) 2024 Nice Zombies """JSON decoder.""" -# TODO(Nice Zombies): add specification from __future__ import annotations __all__: list[str] = [ diff --git a/src/jsonyx/_manipulator.py b/src/jsonyx/_manipulator.py index 034c126..a85ff48 100644 --- a/src/jsonyx/_manipulator.py +++ b/src/jsonyx/_manipulator.py @@ -3,7 +3,6 @@ # TODO(Nice Zombies): add error messages # TODO(Nice Zombies): raise JSONSyntaxError # TODO(Nice Zombies): update schema ID -# TODO(Nice Zombies): write specification from __future__ import annotations __all__: list[str] = ["Manipulator"]