MHKiT-Software / MHKiT-Python / 18573116114
85%
master: 85%

LAST BUILD BRANCH: develop
DEFAULT BRANCH: master
Ran
Jobs 0
Files 0
Run time –
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
18573116114

push

github

web-flow 
Fix pip module package building (#421)

Status: Ready

The v1.0.0 release on PyPI is missing all submodules (wave, tidal,
dolfyn, etc.) when installed via pip and downstream via conda.

## Reproduction

```bash
pip install "mhkit[all]"
```

```bash
python
Python 3.11.12 (main, Apr  8 2025, 14:15:29) [Clang 15.0.0 (clang-1500.1.0.2.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import mhkit
>>> mhkit.__version__
'v1.0.0'
>>> from mhkit import river
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: cannot import name 'river' from 'mhkit' (/opt/homebrew/lib/python3.11/site-packages/mhkit/__init__.py)
```

### Installed Package Contents

Inspecting the installed package shows two files (run `python -m site`
to find `site-packages`
path):

```bash
ls /opt/homebrew/lib/python3.11/site-packages/mhkit
__init__.py __pycache__ warnings.py
```

All submodules (wave, river, tidal, dolfyn, power, loads, mooring,
acoustics, qc, utils) are missing.

### Reproduction

Running the same build command used by GitHub Actions:

```bash
python -m build --wheel --outdir dist/ .
```

- `python -m build`: Runs Python's `build` module (PEP 517 build
frontend) to build the package
- `--wheel`: Build only a wheel distribution (skips source distribution)
- `--outdir dist/`: Output directory for built files
- `.`: Build the package in the current directory (where
`pyproject.toml` is)

Build output shows two files being copied:

```
running build_py
creating build/lib/mhkit
copying mhkit/warnings.py -> build/lib/mhkit
copying mhkit/__init__.py -> build/lib/mhkit
```

Wheel contents:

```
adding 'mhkit/__init__.py'
adding 'mhkit/warnings.py'
```

## Probable Root Cause

In `pyproject.toml`, this configuration tells setuptools to only include
the top-level `mhkit` package, not any subpackages per:
https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#setuptools-specific-configuration

```toml... (continued)
Source Files on build 18573116114
Detailed source file information is not available for this build.