# Python Backup Script
This Python script performs backups of a specified directory to another location. It can be useful for creating regular backups of important data.
## Features
- **Backup Functionality:** Automatically copies files from a specified directory to a backup folder.
- **Exclude Directories:** Allows excluding specific directories from the backup process.
- **Logging:** Logs the start and completion of each backup operation.
## Getting Started
### Prerequisites
- Python 3.x
- `os` and `shutil` libraries (usually included in Python standard library)
### Installation
Install the module using:
- **Windows**:
- `pip install backupfolders`.
- **MacOs**:
- `pip3 install backupfolders`.
### Usage
```python
from backupfolders import backupfolders
# source directory
mainPath = r"C:\Users\HP\Desktop\New folder (2)\flappy-bird"
# backup directory
destinationPath = r"D:\Backups"
# exclude folders not to backup
exclude_folders = [] #if any folder needs to be excluded from backup
backupdir = backupfolders.Backup()
backupdir.backup(mainPath, destinationPath, exclude_folders)
```
There will be a txt file created in which there will be backup log, of which folder you created backup and when it started and completed all this information
## Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or create a pull request
## License
This project is licensed under the MIT License.
## Acknowledgments
This script was inspired by the need for a simple backup solution.
Special thanks to the Python community for their valuable contributions and support.
Raw data
{
"_id": null,
"home_page": "https://github.com/Fahad-codecraft",
"name": "backupfolders",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "backup, folders, files",
"author": "Fahad Devnikar",
"author_email": "devnikarfahad@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e9/29/c8bd007ee6d93e16cae551470f0d6acc81f5ab6bd6903cbe85efd183a7f5/backupfolders-0.6.tar.gz",
"platform": null,
"description": "# Python Backup Script\n\nThis Python script performs backups of a specified directory to another location. It can be useful for creating regular backups of important data.\n\n## Features\n\n- **Backup Functionality:** Automatically copies files from a specified directory to a backup folder.\n- **Exclude Directories:** Allows excluding specific directories from the backup process.\n- **Logging:** Logs the start and completion of each backup operation.\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.x\n- `os` and `shutil` libraries (usually included in Python standard library)\n\n### Installation\nInstall the module using:\n- **Windows**:\n - `pip install backupfolders`.\n- **MacOs**:\n - `pip3 install backupfolders`.\n\n### Usage\n```python\nfrom backupfolders import backupfolders\n\n# source directory\nmainPath = r\"C:\\Users\\HP\\Desktop\\New folder (2)\\flappy-bird\"\n\n# backup directory\ndestinationPath = r\"D:\\Backups\"\n\n# exclude folders not to backup\nexclude_folders = [] #if any folder needs to be excluded from backup\n\nbackupdir = backupfolders.Backup()\n\nbackupdir.backup(mainPath, destinationPath, exclude_folders)\n\n```\n\nThere will be a txt file created in which there will be backup log, of which folder you created backup and when it started and completed all this information\n\n## Contributing\nContributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or create a pull request\n\n## License\nThis project is licensed under the MIT License.\n\n## Acknowledgments\nThis script was inspired by the need for a simple backup solution.\nSpecial thanks to the Python community for their valuable contributions and support.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Backup your folders from one location to another with ease.",
"version": "0.6",
"project_urls": {
"Homepage": "https://github.com/Fahad-codecraft"
},
"split_keywords": [
"backup",
" folders",
" files"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b54a631d738a8cdb8543f4450f15ced4494c3f98a139baba7ff199c17404ba4b",
"md5": "4ab156b1d4f871c66cd2dba13a28f18b",
"sha256": "bf6c6b13b1c5b4abd16ddad815c29c8c95dbc93f623ac6ee570018929307b404"
},
"downloads": -1,
"filename": "backupfolders-0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ab156b1d4f871c66cd2dba13a28f18b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4261,
"upload_time": "2024-04-29T16:40:22",
"upload_time_iso_8601": "2024-04-29T16:40:22.786417Z",
"url": "https://files.pythonhosted.org/packages/b5/4a/631d738a8cdb8543f4450f15ced4494c3f98a139baba7ff199c17404ba4b/backupfolders-0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e929c8bd007ee6d93e16cae551470f0d6acc81f5ab6bd6903cbe85efd183a7f5",
"md5": "5725a36c5fee698b5aea170f26716cf7",
"sha256": "74deec9e7d30f6d109b348b372c08071dbba3e1a291cbbc63f73dcf30d3ee8fa"
},
"downloads": -1,
"filename": "backupfolders-0.6.tar.gz",
"has_sig": false,
"md5_digest": "5725a36c5fee698b5aea170f26716cf7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3972,
"upload_time": "2024-04-29T16:40:24",
"upload_time_iso_8601": "2024-04-29T16:40:24.455757Z",
"url": "https://files.pythonhosted.org/packages/e9/29/c8bd007ee6d93e16cae551470f0d6acc81f5ab6bd6903cbe85efd183a7f5/backupfolders-0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 16:40:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "backupfolders"
}