flinventory 0.4.2__py3-none-any.whl → 0.5.0__py3-none-any.whl

flinventory/__main__.py

@@ -34,7 +34,8 @@ def parse_args():
     return parser.parse_args()
 
 
-if __name__ == "__main__":
+def main():
+    """Run the command-line interface."""
     arguments = parse_args()
     datacleanup.logging_config(arguments)
     try:
@@ -43,3 +44,7 @@ if __name__ == "__main__":
         print("No command given. See -h for help information.")
     else:
         function(arguments)
+
+
+if __name__ == "__main__":
+    main()

flinventory/location.py

@@ -213,12 +213,13 @@ class Schema:
         ).get_schema_hierarchy(location_info)
 
     def get_valid_subs(
-        self, shortcuts: Literal["yes", "only", "()", "*"] = "yes"
+        self, shortcuts: Literal["yes", "only", "()", "*", "no"] = "yes"
     ) -> Optional[list[Union[str, int]]]:
         """A list of valid sub schemas. Usable for suggesting options.
 
         Args:
             shortcuts: if valid shortcuts should be listed as well:
+                'no': shortcuts are not listed
                 'yes': shortcuts listed in the same way as names,
                 'only': only shortcuts are listed
                 '()': shortcuts are listed in parentheses after the name (note: result
@@ -232,6 +233,8 @@ class Schema:
             return None
         if self._subs is None:
             return []
+        if shortcuts == "no":
+            return [sub.name for sub in self._subs]
         if shortcuts == "yes":
             return [name for sub in self._subs for name in (sub.name, sub.shortcut)]
         if shortcuts == "only":

{flinventory-0.4.2.dist-info → flinventory-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flinventory
-Version: 0.4.2
+Version: 0.5.0
 Summary: An inventory system for self-help repair shops
 Author-Email: flukx <flinventory-flukx@612211124.xyz>
 License: GPL3
@@ -55,9 +55,23 @@ The data format is a specific directory structure with specific file names:
 
 No keys in `things/someID/*yaml` are mandatory. Therefore, code that uses the data has to handle missing data.
 
-## Functionalities
-With this repository alone, entering data means writing the json files by hand. For a GUI method, see [flinventory-GUI](https://codeberg.org/flukx/flinventory-gui).
+## Install
+`pip install flinventory`
 
-The scripts are
-- `generate_labels.py` for creating signs that can be printed and glued to the boxes. The size and formatting of the signs happens in `things/*/sign.json`. Also it creates a list of all names of all things with a reference to their location. This list is in markdown and can be converted with pandoc to a printable (multiple page) list. For details see the help messages.
-- `datacleanup.py` for various tasks for reformatting the yaml files. This is helpful to have a bit of standardisation to avoid big git diffs when the yaml files are read and written again. For details see the help messages.
+or 
+```
+git clone https://codeberg.org/flukx/flinventory
+# install requirements listed in pyproject.toml
+# e.g. with
+nix-shell
+```
+
+## Usage
+flinventory is mainly intended as a python module used
+in the [flinventory-GUI](https://codeberg.org/flukx/flinventory-gui).
+But by installing this module, also the command-line interface `flinventory-cli` is installed.
+(It can also be run with the repo and `python -m flinventory`.)
+
+This command-line interface includes
+- `flinventory-cli label` for creating signs that can be printed and glued to the boxes. The size and formatting of the signs happens in `things/*/sign.json`. Also, it creates a list of all names of all things with a reference to their location. This list is in markdown and can be converted with pandoc to a printable (multiple page) list. For details see the help messages.
+- `flinventory-cli {normalize,printed,shortcut,unprinted,useIDs,locationsFile}` for various tasks for reformatting the yaml files. This is helpful to have a bit of standardisation to avoid big git diffs when the yaml files are read and written again. For details see the help messages.

{flinventory-0.4.2.dist-info → flinventory-0.5.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
-flinventory-0.4.2.dist-info/METADATA,sha256=ZQjK-O4pZu_8nTuBLmDKJ0iSepizKaVkxaGIRP-cTnc,4542
-flinventory-0.4.2.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
-flinventory-0.4.2.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-flinventory-0.4.2.dist-info/licenses/LICENSE,sha256=9c-AWlAEeFMmn1aODEfabsw2he-SpQeykurYw-KqSdw,34478
+flinventory-0.5.0.dist-info/METADATA,sha256=hJhT7XOxDx-C0be0YzyJyBtG-CzCOpFNk8Vk9DC-15M,4907
+flinventory-0.5.0.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
+flinventory-0.5.0.dist-info/entry_points.txt,sha256=De3jjbHfy68_ZrwdjywlgrSUCn4QhqZGI0CJJt9S8_c,78
+flinventory-0.5.0.dist-info/licenses/LICENSE,sha256=9c-AWlAEeFMmn1aODEfabsw2he-SpQeykurYw-KqSdw,34478
 flinventory/__init__.py,sha256=0HTGxw9J-2KnbxQbzX6HH-Pztkp0BEjiHANhndfbtYM,270
-flinventory/__main__.py,sha256=YI3dGiBr1i56JpGommQTWYjgfCmhr2JT1pQUdf0lf1w,1228
+flinventory/__main__.py,sha256=5U_RxWDlnhzlC98RaE8SkejjiYjv27OLdm5DPYgL4Gw,1295
 flinventory/box.py,sha256=rk7yrAjVdxcrpvmTMt3jkMVOAoQNJfqoSig9U2S3yJ0,10480
 flinventory/constant.py,sha256=pPNCwScLon_MOKL9_jjD_sxqB7Q2WW6rZqtrBl7SyWk,10283
 flinventory/datacleanup.py,sha256=_CImmWJhq5uKz21jJQUqKYoQfbHEYA0000RyPRt5BI0,11363
 flinventory/defaulted_data.py,sha256=KAy6V2KLcifLg7zHBFnx_eFLp31sCWih1Btp6cE0bQc,21585
 flinventory/generate_labels.py,sha256=wB9ibokHOcab599qZhi5uTzfy3DTo3wT4DJP9qLMzXs,6642
 flinventory/inventory_io.py,sha256=OWThcf9nzeZNqvNpzQiBhESQAnVXC7hUA8DEVzq-w-Y,12561
-flinventory/location.py,sha256=eaZ8tF8HdzH17IBDl3_p_MsnSw5-H1GfbvkTe3dPFGk,16593
+flinventory/location.py,sha256=kJoR5iZF-loimiqEUCaSpDXDDGYV8FECZxodh68Rp9U,16728
 flinventory/sign.py,sha256=8G7fsne3Nsf8zZKKTUl40uWMNsWIv7FYV2KcqBR2MQI,5515
 flinventory/signprinter_latex.py,sha256=Ytf1T_ADedj_Wkqe8bWyN23-TwFaKE7zFpeoYxn5NzM,19105
 flinventory/thing.py,sha256=86fXj3RwTbkCdVVWrbyO-VEW_e5lKJlV8PPt1Xf8ejY,5079
@@ -20,4 +20,4 @@ flinventory/thingtemplate_latex/sign.tex,sha256=cVlOjImuS97Gf19MGW27HiP6Uw8JNnob
 flinventory/thingtemplate_latex/signlist-footer.tex,sha256=LcZw5__h8SqgMmYxs5oLbXLaFTQlx_X5rtYnpxwUh9Y,14
 flinventory/thingtemplate_latex/signlist-header.tex,sha256=F1J4aSPq6QO_Ved4Zn7-rytP1vDkdWTqjjtGJpe_FDg,297
 flinventory/thingtemplate_latex/signs-example.tex,sha256=J6eCcPhP0Xklgn8xnSenDOvjzmc_NGmakWU4RGbeUtM,3090
-flinventory-0.4.2.dist-info/RECORD,,
+flinventory-0.5.0.dist-info/RECORD,,

flinventory-0.5.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+flinventory-cli = flinventory.__main__:main
+
+[gui_scripts]
+

flinventory-0.4.2.dist-info/entry_points.txt

@@ -1,4 +0,0 @@
-[console_scripts]
-
-[gui_scripts]
-