set up of the repository

README.md

@@ -1,26 +1,8 @@
-# NewTec Python Template
+# pyMetricCli
 
----
+pyMetricCli is a collection of scripts and API implementations for generating and playing with metrics.
 
-- In GitHub, use the button `Use this template` to create a new repository.
-- Clone the repository, and open `.vscode\template_python.code-workspace` to open the workspace with Visual Studio Code (VSCode).
-- Install the recommended extensions if desired.
-- Search and replace the keyword `template_python` with the name of your project `<your_project_name>`.
-- Change the name in the workspace file `.vscode\template_python.code-workspace` to `.vscode\<your_project_name>.code-workspace`. You may need to restart VSCode.
-- Change the name in the src folder `src\template_python` to `src\<your_project_name>`
-- Change the imports in the `__main__.py` file if required:
-
-```python
-from <your_project_name>.version import __version__, __author__, __email__, __repository__, __license__
-from <your_project_name>.ret import Ret
-```
-
-- Change the author, email and description in `pyproject.toml` and `setup.cfg`.
-- Delete this block when you are done.
-
----
-
-[![License](https://img.shields.io/badge/license-bsd-3.svg)](https://choosealicense.com/licenses/bsd-3-clause/) [![Repo Status](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip) [![CI](https://github.com/NewTec-GmbH/template_python/actions/workflows/ci.yml/badge.svg)](https://github.com/NewTec-GmbH/template_python/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-bsd-3.svg)](https://choosealicense.com/licenses/bsd-3-clause/) [![Repo Status](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip) [![CI](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/ci.yml/badge.svg)](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/ci.yml)
 
 - [Installation](#installation)
 - [Overview](#overview)
@@ -60,11 +42,11 @@ Used 3rd party libraries which are not part of the standard Python package:
 
 ## Issues, Ideas And Bugs
 
-If you have further ideas or you found some bugs, great! Create an [issue](https://github.com/NewTec-GmbH/template_python/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
+If you have further ideas or you found some bugs, great! Create an [issue](https://github.com/NewTec-GmbH/pyMetricCli/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
 
 ## License
 
-The whole source code is published under [BSD-3-Clause](https://github.com/NewTec-GmbH/template_python/blob/main/LICENSE).
+The whole source code is published under [BSD-3-Clause](https://github.com/NewTec-GmbH/pyMetricCli/blob/main/LICENSE).
 Consider the different licenses of the used third party libraries too!
 
 ## Contribution

pyproject.toml

@@ -3,13 +3,14 @@ requires = ["setuptools", "setuptools-scm", "wheel", "toml"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "template_python"
+name = "pyMetricCli"
 version = "1.0.0"
-description = "template_python"
+description = "pyMetricCli is a collection of scripts and API implementations for generating and playing with metrics."
 readme = "README.md"
 requires-python = ">=3.9"
 authors = [
-    { name = "template_python", email = "[email protected]" }
+    { name = "Gabryel Reyes", email = "[email protected]" },
+    { name = "Juliane Kerpe", email = "[email protected]" }
 ]
 license = {text = "BSD 3-Clause"}
 classifiers = [
@@ -31,12 +32,12 @@ test = [
 ]
 
 [project.urls]
-documentation = "https://github.com/NewTec-GmbH/template_python"
-repository = "https://github.com/NewTec-GmbH/template_python"
-tracker = "https://github.com/NewTec-GmbH/template_python/issues"
+documentation = "https://github.com/NewTec-GmbH/pyMetricCli"
+repository = "https://github.com/NewTec-GmbH/pyMetricCli"
+tracker = "https://github.com/NewTec-GmbH/pyMetricCli/issues"
 
 [project.scripts]
-template_python = "template_python.__main__:main"
+pyMetricCli = "pyMetricCli.__main__:main"
 
 [tool.pytest.ini_options]
 pythonpath = [

setup.cfg

@@ -1,12 +1,12 @@
 [metadata]
-name = template_python
-version = attr: template_python.version.__version__
-description = template_python
+name = pyMetricCli
+version = attr: pyMetricCli.version.__version__
+description = pyMetricCli is a collection of scripts and API implementations for generating and playing with metrics.
 long_description = file: README.md
 long_description_content_type = text/markdown; charset=UTF-8
-url = https://github.com/NewTec-GmbH/template_python
-author = template_python
-author_email = template_python@newtec.de
+url = https://github.com/NewTec-GmbH/pyMetricCli
+author = Juliane Kerpe
+author_email = juliane.kerpe@newtec.de
 license = BSD 3-Clause
 license_files = LICENSE
 classifiers =
@@ -16,9 +16,9 @@ classifiers =
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
 project_urls = 
-    Documentation = https://github.com/NewTec-GmbH/template_python
-    Source = https://github.com/NewTec-GmbH/template_python
-    Tracker = https://github.com/NewTec-GmbH/template_python/issues
+    Documentation = https://github.com/NewTec-GmbH/pyMetricCli
+    Source = https://github.com/NewTec-GmbH/pyMetricCli
+    Tracker = https://github.com/NewTec-GmbH/pyMetricCli/issues
 
 [options]
 package_dir=
@@ -40,4 +40,4 @@ where=src
 
 [options.entry_points]
 console_scripts =
-    template_python = template_python.__main__:main
+    pyMetricCli = pyMetricCli.__main__:main

src/template_python/__main__.py → src/pyMetricCli/__main__.py

@@ -36,8 +36,8 @@
 import sys
 import logging
 
-from template_python.version import __version__, __author__, __email__, __repository__, __license__
-from template_python.ret import Ret
+from pyMetricCli.version import __version__, __author__, __email__, __repository__, __license__
+from pyMetricCli.ret import Ret
 
 ################################################################################
 # Variables

src/template_python/version.py → src/pyMetricCli/version.py

@@ -77,7 +77,7 @@ def init_from_metadata():
         list: Tool related information
     """
 
-    my_metadata = meta.metadata('template_python')
+    my_metadata = meta.metadata('pyMetricCli')
 
     return \
         my_metadata['Version'], \