| Name | mddj JSON |
| Version |
0.0.7
JSON |
| download |
| home_page | |
| Summary | A CLI for extracting python metadata from packages |
| upload_time | 2023-09-28 05:02:55 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mddj
Your DJ of MetaData.
[](https://pypi.org/project/mddj)
[](https://pypi.org/project/mddj)
-----
**Table of Contents**
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## Overview
A CLI for interacting with your python package metadata.
Supports multiple packaging backends via a uniform interface.
## Installation
```console
pipx install mddj
```
## Usage
### Env Vars
#### Build Isolation
``MDDJ_ISOLATED_BUILDS=0`` can be set to disable the (default) behavior using
isolated build environments when getting package metadata.
This requires that you have installed all of the build-system requirements in
to the current environment, but will be much faster.
### Commands
See `--help` on each command for more detail on supported options.
#### `mddj self version`
Show the version of `mddj`.
#### `mddj read requires-python`
Show the `requires_python` field.
#### `mddj read version`
Show the `version`.
#### `mddj read tox min-version`
Show the minimum python version in the `tox` env_list.
#### `mddj read tox list-versions`
Show all python versions in the `tox` env_list.
#### `mddj write version`
Write a new version to a target file, defaulting to a `version = ...` assignment
in `pyproject.toml`.
Supports configuration via `pyproject.toml`.
### Config
Configuration for `mddj` can only be read from a `tool.mddj` table in
`pyproject.toml`. No other configuration sources are supported.
#### `write_version`
This setting controls how version information is written for
`mddj write version`.
It takes a colon delimited string with two or three values.
Either `{mode}:{path}:{key}` or `{mode}:{key}`.
The only supported `{mode}` is `"assign"` (for now).
`{path}` defaults to `pyproject.toml` if omitted.
`{key}` is the name of the attribute used to assign a value.
This defaults to `assign: version`.
For example, the following config can be used to target a `__version__`
attribute in an `__init__.py` file in a src-layout project:
```toml
[tool.mddj]
write_version = "assign: src/foopkg/__init__.py: __version__"
```
## License
`mddj` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": "",
"name": "mddj",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Stephen Rosen <sirosen@globus.org>",
"download_url": "https://files.pythonhosted.org/packages/c1/74/e6d1fb4743833181483b87faa80e213ffe9ccb8080b735d6183488ca557a/mddj-0.0.7.tar.gz",
"platform": null,
"description": "# mddj\n\nYour DJ of MetaData.\n\n[](https://pypi.org/project/mddj)\n[](https://pypi.org/project/mddj)\n\n-----\n\n**Table of Contents**\n\n- [Overview](#overview)\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#license)\n\n## Overview\n\nA CLI for interacting with your python package metadata.\n\nSupports multiple packaging backends via a uniform interface.\n\n## Installation\n\n```console\npipx install mddj\n```\n\n## Usage\n\n### Env Vars\n\n#### Build Isolation\n\n``MDDJ_ISOLATED_BUILDS=0`` can be set to disable the (default) behavior using\nisolated build environments when getting package metadata.\n\nThis requires that you have installed all of the build-system requirements in\nto the current environment, but will be much faster.\n\n### Commands\n\nSee `--help` on each command for more detail on supported options.\n\n#### `mddj self version`\n\nShow the version of `mddj`.\n\n#### `mddj read requires-python`\n\nShow the `requires_python` field.\n\n#### `mddj read version`\n\nShow the `version`.\n\n#### `mddj read tox min-version`\n\nShow the minimum python version in the `tox` env_list.\n\n#### `mddj read tox list-versions`\n\nShow all python versions in the `tox` env_list.\n\n#### `mddj write version`\n\nWrite a new version to a target file, defaulting to a `version = ...` assignment\nin `pyproject.toml`.\n\nSupports configuration via `pyproject.toml`.\n\n### Config\n\nConfiguration for `mddj` can only be read from a `tool.mddj` table in\n`pyproject.toml`. No other configuration sources are supported.\n\n#### `write_version`\n\nThis setting controls how version information is written for\n`mddj write version`.\n\nIt takes a colon delimited string with two or three values.\nEither `{mode}:{path}:{key}` or `{mode}:{key}`.\n\nThe only supported `{mode}` is `\"assign\"` (for now).\n`{path}` defaults to `pyproject.toml` if omitted.\n`{key}` is the name of the attribute used to assign a value.\n\nThis defaults to `assign: version`.\n\nFor example, the following config can be used to target a `__version__`\nattribute in an `__init__.py` file in a src-layout project:\n\n```toml\n[tool.mddj]\nwrite_version = \"assign: src/foopkg/__init__.py: __version__\"\n```\n\n## License\n\n`mddj` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI for extracting python metadata from packages",
"version": "0.0.7",
"project_urls": {
"changelog": "https://github.com/sirosen/mddj/blob/main/CHANGELOG.md",
"source": "https://github.com/sirosen/mddj"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "598d6867035af712e76abb5e5f18e1b56380e7ef1cbc91645fcac628a9231536",
"md5": "8ce48703f59957a31c2d755a9b9e9beb",
"sha256": "2a05e0cb7f85d92bcafec2087598e364e97c946c2da1d50ddde1da24ef58ffa0"
},
"downloads": -1,
"filename": "mddj-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ce48703f59957a31c2d755a9b9e9beb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11878,
"upload_time": "2023-09-28T05:02:53",
"upload_time_iso_8601": "2023-09-28T05:02:53.435677Z",
"url": "https://files.pythonhosted.org/packages/59/8d/6867035af712e76abb5e5f18e1b56380e7ef1cbc91645fcac628a9231536/mddj-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c174e6d1fb4743833181483b87faa80e213ffe9ccb8080b735d6183488ca557a",
"md5": "7112b6169122d8328e120dbb28031df5",
"sha256": "a31ca414306cd6c26be5a382d3fac8cbb5327e86e71c3832479f3184d34121a0"
},
"downloads": -1,
"filename": "mddj-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "7112b6169122d8328e120dbb28031df5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9434,
"upload_time": "2023-09-28T05:02:55",
"upload_time_iso_8601": "2023-09-28T05:02:55.013639Z",
"url": "https://files.pythonhosted.org/packages/c1/74/e6d1fb4743833181483b87faa80e213ffe9ccb8080b735d6183488ca557a/mddj-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-28 05:02:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sirosen",
"github_project": "mddj",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mddj"
}
