Metadata-Version: 2.4
Name: mlenergy
Version: 0.0.1
Summary: ML.ENERGY namespace package
Author-email: Jae-Won Chung <jaewon.chung.cs@gmail.com>
License-Expression: Apache-2.0
Project-URL: Repository, https://github.com/ml-energy/python
Project-URL: Issues, https://github.com/ml-energy/python/issues
Keywords: machine-learning,energy,gpu
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: mlenergy-data
Provides-Extra: data
Requires-Dist: mlenergy-data; extra == "data"

# mlenergy

Meta-package for the [ML.ENERGY](https://ml.energy) Python ecosystem.

This distribution contains no code of its own. It exists to give the ecosystem a single PyPI handle and to install its constituent packages as a bundle.

## Install

```bash
pip install mlenergy        # everything
pip install mlenergy-data   # just the data toolkit
```

The Python import namespace `mlenergy` is a [PEP 420 implicit namespace package](https://peps.python.org/pep-0420/). Each subpackage (`mlenergy.data`, ...) is shipped by its own distribution and merged at import time.

| distribution | imports as | repo |
|---|---|---|
| `mlenergy-data` | `mlenergy.data` | [ml-energy/data](https://github.com/ml-energy/data) |

## Adding a new subpackage

1. New repo publishes a `mlenergy-<name>` distribution that ships `mlenergy/<name>/` (with no top-level `mlenergy/__init__.py`).
2. Add `mlenergy-<name>` to this package's `dependencies` and to `[project.optional-dependencies]`.
3. Cut a new release of `mlenergy`.
