| Name | auto-update JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | auto-update is a Python package designed to update Python projects installed on client systems that do not have Git installed. It retrieves the latest release from a specified GitHub repository, compares it with the currently installed version, and updates the project accordingly. |
| upload_time | 2024-04-27 18:29:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2024 Shaik Abdus Samad 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 |
update
auto update scripts
auto update
python script update
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyUpdater
`auto-update` is a Python package designed to update Python projects installed on client systems that do not have Git installed. It retrieves the latest release from a specified GitHub repository, compares it with the currently installed version, and updates the project accordingly.
## Installation
You can install PyUpdater via pip:
```bash
pip install auto-update
```
# Usage
Create a new file `_auto_update.py` in the project root. Replace `owner` with your github username and `repo` with your github repository. Replace `release` with your release name.
### _auto_update.py
```python
"""
{owner}/{repo}
{release}
"""
from auto_update import Updater
updater = Updater(__doc__.strip())
```
`Updater` will then check for updates and apply them if necessary. It will log its activities to a file named updater.log in the current directory.
# License
This project is licensed under the MIT [License](https://github.com/shaiksamad/auto-update/blob/main/LICENSE) - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "auto-update",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "update, auto update scripts, auto update, python script update",
"author": null,
"author_email": "Shaik Abdus Samad <shaiksamad.dev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/16/24/e13b01a67b62d965de09d62fc537c78bb12c5a42b614b225fa7d3a34c327/auto_update-0.1.0.tar.gz",
"platform": null,
"description": "# PyUpdater\r\n\r\n`auto-update` is a Python package designed to update Python projects installed on client systems that do not have Git installed. It retrieves the latest release from a specified GitHub repository, compares it with the currently installed version, and updates the project accordingly.\r\n\r\n\r\n## Installation\r\n\r\nYou can install PyUpdater via pip:\r\n\r\n```bash\r\npip install auto-update\r\n```\r\n\r\n# Usage\r\n\r\nCreate a new file `_auto_update.py` in the project root. Replace `owner` with your github username and `repo` with your github repository. Replace `release` with your release name.\r\n\r\n### _auto_update.py\r\n```python\r\n\"\"\"\r\n{owner}/{repo}\r\n{release}\r\n\"\"\"\r\n\r\nfrom auto_update import Updater\r\n\r\n\r\nupdater = Updater(__doc__.strip())\r\n```\r\n\r\n\r\n`Updater` will then check for updates and apply them if necessary. It will log its activities to a file named updater.log in the current directory.\r\n\r\n# License\r\nThis project is licensed under the MIT [License](https://github.com/shaiksamad/auto-update/blob/main/LICENSE) - see the LICENSE file for details.\r\n\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Shaik Abdus Samad 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": "auto-update is a Python package designed to update Python projects installed on client systems that do not have Git installed. It retrieves the latest release from a specified GitHub repository, compares it with the currently installed version, and updates the project accordingly.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/shaiksamad/auto-update.git",
"Issues": "https://github.com/shaiksamad/auto-update/issues",
"Repository": "https://github.com/shaiksamad/auto-update.git"
},
"split_keywords": [
"update",
" auto update scripts",
" auto update",
" python script update"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5f72420610d59d95d11736529d37071c12a3ca6989d02e565e1071168a6e632",
"md5": "e68262a090b04bd7497995b2a66fe63f",
"sha256": "b5bae82c2321875b20c79c6185974739734ba4d33ac3287d82935828b9e34178"
},
"downloads": -1,
"filename": "auto_update-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e68262a090b04bd7497995b2a66fe63f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4301,
"upload_time": "2024-04-27T18:29:25",
"upload_time_iso_8601": "2024-04-27T18:29:25.588334Z",
"url": "https://files.pythonhosted.org/packages/e5/f7/2420610d59d95d11736529d37071c12a3ca6989d02e565e1071168a6e632/auto_update-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1624e13b01a67b62d965de09d62fc537c78bb12c5a42b614b225fa7d3a34c327",
"md5": "a3401473632d5c9e1c86f9070a073e03",
"sha256": "6430114edd954cbd0f5b9339834180036d04888c0bc27239a9a2a8c1b0905849"
},
"downloads": -1,
"filename": "auto_update-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "a3401473632d5c9e1c86f9070a073e03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3515,
"upload_time": "2024-04-27T18:29:27",
"upload_time_iso_8601": "2024-04-27T18:29:27.615461Z",
"url": "https://files.pythonhosted.org/packages/16/24/e13b01a67b62d965de09d62fc537c78bb12c5a42b614b225fa7d3a34c327/auto_update-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 18:29:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shaiksamad",
"github_project": "auto-update",
"github_not_found": true,
"lcname": "auto-update"
}
