Metadata-Version: 2.1
Name: python_package_template_demo
Version: 0.0.1
Summary: A description of the project.
Author-email: Marc Horlacher <marc.horlacher@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Marc Horlacher
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: mkdocs
Requires-Dist: mkdocstrings[python]
Requires-Dist: mkdocs-material

# python_package_template_demo

A short description of the project. 


## Installation

### Using Pip

```
pip install python_package_template_demo
```

### Using Conda

```
conda install -c conda-forge python_package_template_demo
```

### Using Docker

First, pull the docker image. 
```
docker pull 
```

Then, run commands as shown below. 
```
docker run python_package_template_demo --help 
```
To provide input files and capture output file, mount host files and/or directories using `--mount` (see the Docker [docs](https://docs.docker.com/engine/storage/bind-mounts/)). 


## Usage

See the [documentation](https://mhorlacher.github.io/python_package_template_demo) for a usage guide and API reference. # python-package-template-demo
