feat: poetry add entrypoint to the module (#15)

README.md

@@ -50,9 +50,9 @@ poetry add https://github.com/SchweizerischeBundesbahnen/python-requirements-ins
 ```
 ## Execute
 ```bash
-python -m python_requirements_inspector.main inputs.json
+poetry run inspect-requirements path/to/input/json
 ```
-## Outputs will be returned in outputs.json
+## Outputs will be returned in /tmp/output_*.json
 ```json
 [
   {"id": "requirements1",

pyproject.toml

@@ -29,6 +29,9 @@ tox = "^4.12.1"
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.poetry.scripts]
+inspect-requirements = "python_requirements_inspector.main:run"
+
 [tool.ruff]
 line-length = 240
 fix = true

python_requirements_inspector/main.py

@@ -41,7 +41,7 @@ def main(json_path: str) -> str:
     return output_file.name
 
 
-if __name__ == "__main__":
+def run() -> None:
     # Set up the command-line argument parser
     parser = argparse.ArgumentParser(description="Analyses workitem data provided by a json file.")
     parser.add_argument("jsonfile", type=str, help="path to the json file")
@@ -50,5 +50,8 @@ def main(json_path: str) -> str:
     args = parser.parse_args()
     json_file_path = args.jsonfile
 
-    output_file_path = main(json_file_path)
-    print(output_file_path)
+    print(main(json_file_path))
+
+
+if __name__ == "__main__":
+    run()