Metadata-Version: 2.1
Name: dtocean-dummy-module
Version: 1.0.0
Summary: Dummy DTOcean module used in mdo-engine tests
License: GPL-3.0-or-later
Author: Mathew Topper
Author-email: damm_horse@yahoo.co.uk
Requires-Python: >=3.13,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: numpy (>=2.1.3,<3.0.0)
Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: polite-config (>=1.0.0,<2.0.0)
Requires-Dist: xlrd (>=2.0.1,<3.0.0)
Requires-Dist: xlwt (>=1.3.0,<2.0.0)
Description-Content-Type: text/markdown

# dtocean-dummy-module

## Overview

A python package to demonstrate some of the many features of Python and
introduce a typical structure for a Python package.

## Installation

Installation and development of the dummy module uses the [Poetry](
https://python-poetry.org/) dependency manager. Poetry must be installed
and available on the command line.

To install:

```console
poetry install
```

## Tests

A test suite is provided with the source code that uses [pytest](
https://docs.pytest.org).

Install the testing dependencies:

```console
poetry install --with test
```

Run the tests:

```console
poetry run pytest
```

## Example Usage

The following commands are run from the
[command-line interface](http://en.wikipedia.org/wiki/Command-line_interface).

### Execution

```console
dtocean-dummy 5
```

### Help

```console
dtocean-dummy -h
```

