| Name | diamondpack JSON |
| Version |
1.4.5
JSON |
| download |
| home_page | None |
| Summary | A simple packager for creating distributable python applications |
| upload_time | 2024-04-05 18:34:39 |
| maintainer | None |
| docs_url | None |
| author | Alagyn |
| requires_python | None |
| license | MIT License Copyright (c) 2023 Ben "Alagyn" Kimbrough Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
package
distribute
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src="https://github.com/alagyn/DiamondPack/blob/d847471f6e84bff69195800990b87b2d95a72342/docs/diamondPack.png?raw=true" width="256" align="right"/>
# DiamondPack
A simple packager for creating distributable Python applications
---
Used to create distributable applications in the simplest way possible.
Enables Python applications to easily run on systems that don't have Python installed, and without the need for users to know what Python even is.
## Features:
- Build Windows and Linux applications
- Minimal configuration needed
- Fast execution, no waiting for libraries to unzip
## Install:
Default install:
`pip install diamondpack`
If you don't already have a version of CMake installed, in order to use the "app" mode,
install the optional cmake package
`pip install diamondpack[app]`
or
`pip install cmake`
## Usage:
### 1. Configure DiamondPack via your `pyproject.toml`
```toml
[project.scripts]
# Each script named here will generate a new executable
myScript = "examplePackage.myScript:main"
[tool.diamondpack]
mode = "app"
# Prevents specific installed packages from being reduced to only .pyc files
# Some packages complaing about this. This is a list of the MODULE's name, same as it is imported as
# NOT the pip package name
py-cache-blacklist = ["opencv"]
# Prevents specific stdlib packages from being copied to reduce package size
stdlib-blacklist = ["email", "turtle", "unittest"]
# Flag to copy required tk/tcl files
include-tk = false
# Additional data files can be copied into your distribution like this
# File globs are copied to the specified path in the dist.
data-globs = [
["myData/img*.jpg", "destinationDir"],
["myData/data.dat", "data"]
]
# Enable some additional logging for the "app" mode
debug-logs = true
```
Mode can be `app` or `script`:
- `app` will generate a compiled executable (requires CMake and a compiler installed)
- `script` will generate a bash (Linux) or batch (Windows) script
### 2. Build your application into a wheel
`python -m build --wheel`
Check out the `test` folder for an example package and its `pyproject.toml` configuration
### 3. Run diamondpack
`python -m diamondpack` or, with a venv activated, simply run `diamondpack`
### 4. Profit
Your package will be placed in `dist/[package-name]-[version]/`
## FAQ
**Q) Do DiamondPack applications work cross-platform?**
A) While DiamondPack itself is cross-platform, packaged applications are only usable in the OS they were packaged on
**Q) What is that cool snake doin in that there box?**
A) His name is Henry and he protects your packages
Raw data
{
"_id": null,
"home_page": null,
"name": "diamondpack",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "package, distribute",
"author": "Alagyn",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1e/fc/422a5202902e9c2449dd508293848b4867b2b2452ba28272d5684319e4dc/diamondpack-1.4.5.tar.gz",
"platform": null,
"description": "<img src=\"https://github.com/alagyn/DiamondPack/blob/d847471f6e84bff69195800990b87b2d95a72342/docs/diamondPack.png?raw=true\" width=\"256\" align=\"right\"/>\n\n# DiamondPack\nA simple packager for creating distributable Python applications\n\n---\n\nUsed to create distributable applications in the simplest way possible.\nEnables Python applications to easily run on systems that don't have Python installed, and without the need for users to know what Python even is.\n\n## Features:\n- Build Windows and Linux applications\n- Minimal configuration needed\n- Fast execution, no waiting for libraries to unzip\n\n## Install:\n\nDefault install:\n`pip install diamondpack`\n\nIf you don't already have a version of CMake installed, in order to use the \"app\" mode,\ninstall the optional cmake package \n`pip install diamondpack[app]`\nor\n`pip install cmake`\n\n## Usage:\n\n### 1. Configure DiamondPack via your `pyproject.toml`\n\n```toml\n[project.scripts]\n# Each script named here will generate a new executable\nmyScript = \"examplePackage.myScript:main\"\n\n[tool.diamondpack]\nmode = \"app\"\n\n# Prevents specific installed packages from being reduced to only .pyc files\n# Some packages complaing about this. This is a list of the MODULE's name, same as it is imported as\n# NOT the pip package name\npy-cache-blacklist = [\"opencv\"]\n\n# Prevents specific stdlib packages from being copied to reduce package size\nstdlib-blacklist = [\"email\", \"turtle\", \"unittest\"]\n\n# Flag to copy required tk/tcl files\ninclude-tk = false\n\n# Additional data files can be copied into your distribution like this\n# File globs are copied to the specified path in the dist.\ndata-globs = [\n [\"myData/img*.jpg\", \"destinationDir\"],\n [\"myData/data.dat\", \"data\"]\n]\n\n# Enable some additional logging for the \"app\" mode\ndebug-logs = true\n```\n\nMode can be `app` or `script`:\n- `app` will generate a compiled executable (requires CMake and a compiler installed)\n- `script` will generate a bash (Linux) or batch (Windows) script\n\n\n### 2. Build your application into a wheel\n`python -m build --wheel` \nCheck out the `test` folder for an example package and its `pyproject.toml` configuration\n\n### 3. Run diamondpack\n`python -m diamondpack` or, with a venv activated, simply run `diamondpack` \n\n### 4. Profit\nYour package will be placed in `dist/[package-name]-[version]/`\n\n## FAQ\n\n**Q) Do DiamondPack applications work cross-platform?** \nA) While DiamondPack itself is cross-platform, packaged applications are only usable in the OS they were packaged on\n\n**Q) What is that cool snake doin in that there box?** \nA) His name is Henry and he protects your packages\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Ben \"Alagyn\" Kimbrough Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A simple packager for creating distributable python applications",
"version": "1.4.5",
"project_urls": {
"Issues": "https://github.com/alagyn/DiamondPack/issues",
"Repository": "https://github.com/alagyn/DiamondPack"
},
"split_keywords": [
"package",
" distribute"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce06bd7e5305e68a1d1a22ca37f07eb1b970c9ada3de9643f1f093c78702cc8e",
"md5": "87ff28e0d37e307dac95c4c57b1f1403",
"sha256": "1b0db2e2148a00f2efe1bca4d51e6950d4736bc460e7eb36a357527644113766"
},
"downloads": -1,
"filename": "diamondpack-1.4.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87ff28e0d37e307dac95c4c57b1f1403",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14790,
"upload_time": "2024-04-05T18:34:52",
"upload_time_iso_8601": "2024-04-05T18:34:52.340094Z",
"url": "https://files.pythonhosted.org/packages/ce/06/bd7e5305e68a1d1a22ca37f07eb1b970c9ada3de9643f1f093c78702cc8e/diamondpack-1.4.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1efc422a5202902e9c2449dd508293848b4867b2b2452ba28272d5684319e4dc",
"md5": "b2123d11a030ba76e075c43d46a224d3",
"sha256": "3bd5200081f0c4448da5f115e2ad91a090b58428c33ebf9c98d377d9dfced213"
},
"downloads": -1,
"filename": "diamondpack-1.4.5.tar.gz",
"has_sig": false,
"md5_digest": "b2123d11a030ba76e075c43d46a224d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13622,
"upload_time": "2024-04-05T18:34:39",
"upload_time_iso_8601": "2024-04-05T18:34:39.349871Z",
"url": "https://files.pythonhosted.org/packages/1e/fc/422a5202902e9c2449dd508293848b4867b2b2452ba28272d5684319e4dc/diamondpack-1.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 18:34:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alagyn",
"github_project": "DiamondPack",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "diamondpack"
}
