flinventory 0.4.2__tar.gz → 0.4.3__tar.gz

{flinventory-0.4.2 → flinventory-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flinventory
-Version: 0.4.2
+Version: 0.4.3
 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 → flinventory-0.4.3}/README.md

@@ -32,9 +32,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).
-
-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.
+## Install
+`pip install flinventory`
+
+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 → flinventory-0.4.3}/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-0.4.2 → flinventory-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flinventory"
-version = "0.4.2"
+version = "0.4.3"
 description = "An inventory system for self-help repair shops"
 authors = [
     { name = "flukx", email = "flinventory-flukx@612211124.xyz" },
@@ -31,9 +31,8 @@ text = "GPL3"
 Homepage = "https://codeberg.org/flukx/flinventory"
 Issues = "https://codeberg.org/flukx/flinventory/issues"
 
-[projects.scripts]
-datacleanup = "flinventory.datacleanup:main"
-generate_labels = "flinventory.generate_labels:main"
+[project.scripts]
+flinventory-cli = "flinventory.__main__:main"
 
 [build-system]
 requires = [