| Name | pdm-autoexport JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | A PDM plugin to sync the exported files with the project file |
| upload_time | 2023-06-27 03:27:19 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
pdm
plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pdm-autoexport
[](https://pypi.org/project/pdm-autoexport)
[](https://pdm.fming.dev)
A PDM plugin to sync the exported files with the project file.
## Installation
Install the plugin with PDM CLI:
```bash
pdm plugin add pdm-autoexport
```
Or using `pipx inject`:
```bash
pipx inject pdm pdm-autoexport
```
## Usage
Configure the requirement mapping in `pyproject.toml`:
```toml
[[tool.pdm.autoexport]]
filename = "requirements/prod.txt"
groups = ["default"]
[[tool.pdm.autoexport]]
filename = "setup.py"
format = "setuppy"
```
Then the requirement files will be synced every time when the lock file is updated.
## Configuration
The configuration is an array of table `[[tool.pdm.autoexport]]` where each item may contain the following keys:
- `filename` (required): The path to the exported file.
- `groups` (optional, default: `["default"]`): The groups of optional dependencies or dev dependency groups of PDM to sync with.
- `format` (optional, default: `"requirements"`): The format of the exported file, same as the `--format` option to the `pdm export` command.
Only `requirements` and `setuppy` are supported.
- `without-hashes` (optional, default: `false`): Whether to remove the hashes from the exported file. Only applicable to `requirements` format.
Raw data
{
"_id": null,
"home_page": "",
"name": "pdm-autoexport",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "pdm plugin",
"author": "",
"author_email": "Frost Ming <mianghong@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ba/09/bca46c627fca49ade329c043e9944a5e6e338e9928b6269cc92b0d15dcae/pdm_autoexport-0.2.0.tar.gz",
"platform": null,
"description": "# pdm-autoexport\n\n\n[](https://pypi.org/project/pdm-autoexport)\n[](https://pdm.fming.dev)\n\nA PDM plugin to sync the exported files with the project file.\n\n## Installation\n\nInstall the plugin with PDM CLI:\n\n```bash\npdm plugin add pdm-autoexport\n```\n\nOr using `pipx inject`:\n\n```bash\npipx inject pdm pdm-autoexport\n```\n\n## Usage\n\nConfigure the requirement mapping in `pyproject.toml`:\n\n```toml\n[[tool.pdm.autoexport]]\nfilename = \"requirements/prod.txt\"\ngroups = [\"default\"]\n\n[[tool.pdm.autoexport]]\nfilename = \"setup.py\"\nformat = \"setuppy\"\n```\n\nThen the requirement files will be synced every time when the lock file is updated.\n\n## Configuration\n\nThe configuration is an array of table `[[tool.pdm.autoexport]]` where each item may contain the following keys:\n\n- `filename` (required): The path to the exported file.\n- `groups` (optional, default: `[\"default\"]`): The groups of optional dependencies or dev dependency groups of PDM to sync with.\n- `format` (optional, default: `\"requirements\"`): The format of the exported file, same as the `--format` option to the `pdm export` command.\n Only `requirements` and `setuppy` are supported.\n- `without-hashes` (optional, default: `false`): Whether to remove the hashes from the exported file. Only applicable to `requirements` format.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A PDM plugin to sync the exported files with the project file",
"version": "0.2.0",
"project_urls": {
"Changelog": "https://github.com/frostming/pdm-autoexport/releases",
"Homepage": "https://github.com/frostming/pdm-autoexport"
},
"split_keywords": [
"pdm",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4862a7f6fdd49cd8be5c1df2b5b40ae949f670b105c7da0242a0a2ae863c31c3",
"md5": "bb78651bbfcaf6b18bad8410286d4ab1",
"sha256": "385dd748bca5031a54cb3bcfbc1f230712fb6305d8d8ae75ee30affcbf98a4fc"
},
"downloads": -1,
"filename": "pdm_autoexport-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb78651bbfcaf6b18bad8410286d4ab1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 3995,
"upload_time": "2023-06-27T03:27:18",
"upload_time_iso_8601": "2023-06-27T03:27:18.735349Z",
"url": "https://files.pythonhosted.org/packages/48/62/a7f6fdd49cd8be5c1df2b5b40ae949f670b105c7da0242a0a2ae863c31c3/pdm_autoexport-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba09bca46c627fca49ade329c043e9944a5e6e338e9928b6269cc92b0d15dcae",
"md5": "efce1268f8b2dd19d71995478ac7aab7",
"sha256": "a7bd49c39cfc8a35dcd648f11e00817c3e1cb4764cb6501ab9d11a621934feac"
},
"downloads": -1,
"filename": "pdm_autoexport-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "efce1268f8b2dd19d71995478ac7aab7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3535,
"upload_time": "2023-06-27T03:27:19",
"upload_time_iso_8601": "2023-06-27T03:27:19.765048Z",
"url": "https://files.pythonhosted.org/packages/ba/09/bca46c627fca49ade329c043e9944a5e6e338e9928b6269cc92b0d15dcae/pdm_autoexport-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 03:27:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "frostming",
"github_project": "pdm-autoexport",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pdm-autoexport"
}
