| Name | backupp JSON |
| Version |
0.0.19
JSON |
| download |
| home_page | None |
| Summary | Back ups your folder to your preferred local or network destination reading or creating a gitignore file. |
| upload_time | 2024-05-18 13:44:39 |
| maintainer | None |
| docs_url | None |
| author | Sermet Pekin |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# backupp
[](https://github.com/SermetPekin/backupp-rep/actions/workflows/python-package.yml)
**backupp** is a Python package that automates the backup of folders to a specified local or network destination. It intelligently utilizes or generates a `.gitignore` file to manage which files or folders should be ignored during the backup process.
## Installation
Install the latest version of backupp using pip:
```bash
pip install backupp -U # Alternatively, you can use pip3
```
## Usage
### Console (Windows) / Terminal (Linux/Mac)
To backup specific folders to a designated backup folder, use:
```bash
backupp /path/to/source_folder /path/to/backup_folder
```
Examples:
- Backup a specific folder:
```bash
backupp /some_folder/that_folder my_backup_folder
```
- Backup the current folder:
```bash
backupp . path/to_my_backup_folder
```
- Backup the parent folder:
```bash
backupp .. path/to_my_backup_folder
```
## Handling .gitignore
The **backupp** package searches for an existing `.gitignore` file in the source directory. If it doesn't find one, it will create a default `.gitignore` file. You can modify this file to customize which files or folders should be excluded from backups, similar to how Git uses `.gitignore`.
## Setup Global Backup Folder
To set a default backup folder, which can be used for subsequent backup operations without specifying a path each time:
```bash
backupp --setup /path/to/my_favorite_backup_folder
```
## Backup to favorite folder
```bash
backupp path/source/somefolder
```
## Backup current folder to favorite backup folder
```bash
backupp .
```
## Check Backup Setup
To display your current backup configuration and preferences:
```bash
backupp --check
```
Raw data
{
"_id": null,
"home_page": null,
"name": "backupp",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Sermet Pekin",
"author_email": "sermet.pekin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1e/e6/21767c1154791b8df8afa7e53e7028de3614ccdf7b553e1544a585c02fe4/backupp-0.0.19.tar.gz",
"platform": null,
"description": "# backupp\n\n[](https://github.com/SermetPekin/backupp-rep/actions/workflows/python-package.yml)\n\n**backupp** is a Python package that automates the backup of folders to a specified local or network destination. It intelligently utilizes or generates a `.gitignore` file to manage which files or folders should be ignored during the backup process.\n\n## Installation\n\nInstall the latest version of backupp using pip:\n\n```bash\npip install backupp -U # Alternatively, you can use pip3\n```\n\n## Usage\n\n### Console (Windows) / Terminal (Linux/Mac)\n\nTo backup specific folders to a designated backup folder, use:\n\n```bash\nbackupp /path/to/source_folder /path/to/backup_folder\n```\n\nExamples:\n\n- Backup a specific folder:\n ```bash\n backupp /some_folder/that_folder my_backup_folder\n ```\n\n- Backup the current folder:\n ```bash\n backupp . path/to_my_backup_folder\n ```\n\n- Backup the parent folder:\n ```bash\n backupp .. path/to_my_backup_folder\n ```\n\n## Handling .gitignore\n\nThe **backupp** package searches for an existing `.gitignore` file in the source directory. If it doesn't find one, it will create a default `.gitignore` file. You can modify this file to customize which files or folders should be excluded from backups, similar to how Git uses `.gitignore`.\n\n## Setup Global Backup Folder\n\nTo set a default backup folder, which can be used for subsequent backup operations without specifying a path each time:\n\n```bash\nbackupp --setup /path/to/my_favorite_backup_folder\n```\n## Backup to favorite folder\n\n\n```bash\nbackupp path/source/somefolder \n```\n\n## Backup current folder to favorite backup folder \n\n```bash\nbackupp . \n```\n\n\n## Check Backup Setup\n\nTo display your current backup configuration and preferences:\n\n```bash\nbackupp --check\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Back ups your folder to your preferred local or network destination reading or creating a gitignore file.",
"version": "0.0.19",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "927166c92a1244839f757e4d05a65b0304eddec2d81a5598b091c630e5f4af9b",
"md5": "aec96a3ea81994ca4fbf7a7313112308",
"sha256": "e0a9519b8412ce3a61800043e2097e9480bd06de804a45b6c138d1e3efcdab41"
},
"downloads": -1,
"filename": "backupp-0.0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aec96a3ea81994ca4fbf7a7313112308",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 29650,
"upload_time": "2024-05-18T13:44:37",
"upload_time_iso_8601": "2024-05-18T13:44:37.671500Z",
"url": "https://files.pythonhosted.org/packages/92/71/66c92a1244839f757e4d05a65b0304eddec2d81a5598b091c630e5f4af9b/backupp-0.0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ee621767c1154791b8df8afa7e53e7028de3614ccdf7b553e1544a585c02fe4",
"md5": "2e98f8ceb6e4b52eac4dde44d65d39b9",
"sha256": "fcc639a97a435b19f08b879f6b3480cae432a952c041d27ab4cd0a480277d725"
},
"downloads": -1,
"filename": "backupp-0.0.19.tar.gz",
"has_sig": false,
"md5_digest": "2e98f8ceb6e4b52eac4dde44d65d39b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 23215,
"upload_time": "2024-05-18T13:44:39",
"upload_time_iso_8601": "2024-05-18T13:44:39.419630Z",
"url": "https://files.pythonhosted.org/packages/1e/e6/21767c1154791b8df8afa7e53e7028de3614ccdf7b553e1544a585c02fe4/backupp-0.0.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-18 13:44:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "backupp"
}
