| Name | damply JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | A Quick Tool For Sorting Dicom Files |
| upload_time | 2024-05-31 23:57:28 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
damply
package
pixi
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# damply
[](https://codecov.io/gh/jjjermiah/damply)
[](https://github.com/jjjermiah/damply/actions/workflows/main.yaml)
[](https://www.codefactor.io/repository/github/jjjermiah/damply)
[](https://github.com/prefix-dev/pixi)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/astral-sh/ruff)
[](https://github.com/squidfunk/mkdocs-material)
[](https://pypi.org/project/damply/)
[](https://pypi.org/project/damply/)
[](https://pypi.org/project/damply/)
[](https://pepy.tech/project/damply)
## Overview
DaMPly (Data Management Plan) is a Python module designed to streamline the process of managing and packaging directories.
This tool is particularly useful for archiving project directories while leaving behind a README file to provide context and instructions for future users.
## Features
View a project's `README`, with emphasized fields that follow the Data Management Plan (DMP) guidelines.
TODO
- [ ] README Check: Verifies the presence of a README file in the specified directory.
- [ ] User Interaction: Prompts the user for necessary information to enhance the archiving process.
- [ ] Directory Compression: Compresses all files and sub
## Development
This project uses [`pixi`](pixi.sh) for managing the development environment.
A set of convenient `tasks` are defined in the `pyproject.toml` file to streamline the development process.
The `build` feature contains the following tasks:
- `build`: Builds the package.
- `publish-pypi`: Publishes the package to the main PYPI repository.
- `publish-test`: Publishes the package to the TEST-PYPI repository.
For more details, view the [devnotes on pixi + hatch](devnotes/pixi-hatch-build.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "damply",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Jermiah Joseph <jermiahjoseph98@gmail.com>",
"keywords": "damply, package, pixi, python",
"author": null,
"author_email": "Jermiah Joseph <jermiahjoseph98@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/93/b8/a504f6efbc34a64db53a33def3963dcc75da175d1cc08a2a383c2cdda7c0/damply-0.6.0.tar.gz",
"platform": null,
"description": "# damply\n\n[](https://codecov.io/gh/jjjermiah/damply)\n[](https://github.com/jjjermiah/damply/actions/workflows/main.yaml)\n[](https://www.codefactor.io/repository/github/jjjermiah/damply)\n\n[](https://github.com/prefix-dev/pixi)\n[](https://github.com/pre-commit/pre-commit)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/squidfunk/mkdocs-material)\n\n[](https://pypi.org/project/damply/)\n[](https://pypi.org/project/damply/)\n[](https://pypi.org/project/damply/)\n[](https://pepy.tech/project/damply)\n\n## Overview\n\n\nDaMPly (Data Management Plan) is a Python module designed to streamline the process of managing and packaging directories. \n\nThis tool is particularly useful for archiving project directories while leaving behind a README file to provide context and instructions for future users.\n\n## Features\n\nView a project's `README`, with emphasized fields that follow the Data Management Plan (DMP) guidelines.\n\n\nTODO\n- [ ] README Check: Verifies the presence of a README file in the specified directory.\n- [ ] User Interaction: Prompts the user for necessary information to enhance the archiving process.\n- [ ] Directory Compression: Compresses all files and sub\n\n\n## Development\n\nThis project uses [`pixi`](pixi.sh) for managing the development environment.\nA set of convenient `tasks` are defined in the `pyproject.toml` file to streamline the development process.\n\nThe `build` feature contains the following tasks:\n\n- `build`: Builds the package.\n- `publish-pypi`: Publishes the package to the main PYPI repository.\n- `publish-test`: Publishes the package to the TEST-PYPI repository.\n \nFor more details, view the [devnotes on pixi + hatch](devnotes/pixi-hatch-build.md).",
"bugtrack_url": null,
"license": null,
"summary": "A Quick Tool For Sorting Dicom Files",
"version": "0.6.0",
"project_urls": {
"changelog": "https://github.com/jjjermiah/damply/blob/main/docs/CHANGELOG.md",
"documentation": "https://jjjermiah.github.io/damply/",
"homepage": "https://github.com/jjjermiah/damply",
"issues": "https://github.com/jjjermiah/damply/issues",
"repository": "https://github.com/jjjermiah/damply"
},
"split_keywords": [
"damply",
" package",
" pixi",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c6ece3c591162ad6abf98c20a10eaa0a4db17cd11f2a74ab2af2076b75e854be",
"md5": "aaf5a3fb9d8bb935e0c921ae8cea6e61",
"sha256": "5ed66fe9e0828c4dfe640acbc8f0e0645ce2826afbfb4a3dc756ea531df96f5a"
},
"downloads": -1,
"filename": "damply-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aaf5a3fb9d8bb935e0c921ae8cea6e61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7655,
"upload_time": "2024-05-31T23:57:26",
"upload_time_iso_8601": "2024-05-31T23:57:26.989709Z",
"url": "https://files.pythonhosted.org/packages/c6/ec/e3c591162ad6abf98c20a10eaa0a4db17cd11f2a74ab2af2076b75e854be/damply-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "93b8a504f6efbc34a64db53a33def3963dcc75da175d1cc08a2a383c2cdda7c0",
"md5": "2b2136d1c882e8cef9c19e38f5821137",
"sha256": "ba7dcbdd84a8b05a54901eaa2b7eb1749d0d2ba9486d0e09b1be3ebe26b24143"
},
"downloads": -1,
"filename": "damply-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "2b2136d1c882e8cef9c19e38f5821137",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 215638,
"upload_time": "2024-05-31T23:57:28",
"upload_time_iso_8601": "2024-05-31T23:57:28.039608Z",
"url": "https://files.pythonhosted.org/packages/93/b8/a504f6efbc34a64db53a33def3963dcc75da175d1cc08a2a383c2cdda7c0/damply-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-31 23:57:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jjjermiah",
"github_project": "damply",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "damply"
}
