| Name | sinko JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A flexible backup tool supporting local and remote backups using rsync and SSH |
| upload_time | 2025-09-16 16:39:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License
Copyright (c) 2024 Your Actual Name
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 |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Sinko Backup Tool
Sinko is a flexible backup tool that supports both local and remote backups using rsync and SSH.
SINKO is a lightweight, open-source file backup tool designed with simplicity in mind. Inspired by the functionality of rsync, SINKO streamlines the process of synchronizing and backing up files across directories and systems. By focusing on the essential features you need to keep your files secure, SINKO eliminates the complexity often associated with robust backup tools. This straightforward approach makes SINKO an accessible solution for users of all skill levels, allowing you to safeguard your valuable data without getting bogged down in intricate configurations.
## Features
- Local backups using rsync
- Remote backups using SSH
- Configuration using a config file
- Command-line interface
- Extremely easy to use
## Installation
1. Clone the repository:
```
git clone https://github.com/yourusername/sinko.git
cd sinko
```
2. Install the required dependencies:
```
pip install -r requirements.txt
```
## Usage
To use Sinko, you need to create an EDN configuration file (e.g., `sinko.conf.edn`) with the following structure:
```edn
{:source ["/path/to/file1.txt"
"/path/to/file2.txt"
"/path/to/directory/file3.txt"]
:destination "/path/to/backup/directory"}
```
Then, you can run the backup tool using the following command:
```
python -m source.main --sinko-conf /path/to/sinko.conf.edn
```
You can specify additional source files/directories via command line in two ways:
1. Multiple --source options:
```
python -m source.main --sinko-conf /path/to/sinko.conf.edn --source /extra/file1.txt --source /extra/dir2
```
2. Colon-delimited paths in a single --source option:
```
python -m source.main --sinko-conf /path/to/sinko.conf.edn --source "/extra/file1.txt:/extra/dir2:/extra/file3.txt"
```
The final backup source list will be a combination of sources from both the config file and command line options. When using colon-delimited paths, make sure to properly quote the argument if it contains special characters.
For the destination directory, the CLI option takes precedence over the config file if both are specified. You can override the destination directory from the config file using the --destination option:
```
python -m source.main --sinko-conf /path/to/sinko.conf.edn --destination /new/backup/path
```
Note that all CLI options except `--source` must be provided at most once. The following options cannot be duplicated:
- `--sinko-conf`
- `--destination`
- `--remote`
- `--log-level`
For remote backups, add the `--remote` flag:
```
python -m source.main --remote --sinko-conf /path/to/sinko.conf.edn
```
## Testing
To run the tests, use the following command:
```
pytest
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "sinko",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "KEJIA <DETONG.KEJI@GMAIL.COM>",
"download_url": "https://files.pythonhosted.org/packages/d1/3a/b53f2508e713fc01eff6a018ec1820474b06ce09218d414f7d88da038eae/sinko-0.1.0.tar.gz",
"platform": null,
"description": "# Sinko Backup Tool\n\nSinko is a flexible backup tool that supports both local and remote backups using rsync and SSH.\n\nSINKO is a lightweight, open-source file backup tool designed with simplicity in mind. Inspired by the functionality of rsync, SINKO streamlines the process of synchronizing and backing up files across directories and systems. By focusing on the essential features you need to keep your files secure, SINKO eliminates the complexity often associated with robust backup tools. This straightforward approach makes SINKO an accessible solution for users of all skill levels, allowing you to safeguard your valuable data without getting bogged down in intricate configurations.\n\n## Features\n\n- Local backups using rsync\n- Remote backups using SSH\n- Configuration using a config file\n- Command-line interface\n- Extremely easy to use\n\n## Installation\n\n1. Clone the repository:\n ```\n git clone https://github.com/yourusername/sinko.git\n cd sinko\n ```\n\n2. Install the required dependencies:\n ```\n pip install -r requirements.txt\n ```\n\n## Usage\n\nTo use Sinko, you need to create an EDN configuration file (e.g., `sinko.conf.edn`) with the following structure:\n\n```edn\n{:source [\"/path/to/file1.txt\"\n \"/path/to/file2.txt\"\n \"/path/to/directory/file3.txt\"]\n :destination \"/path/to/backup/directory\"}\n```\n\nThen, you can run the backup tool using the following command:\n\n```\npython -m source.main --sinko-conf /path/to/sinko.conf.edn\n```\n\nYou can specify additional source files/directories via command line in two ways:\n\n1. Multiple --source options:\n```\npython -m source.main --sinko-conf /path/to/sinko.conf.edn --source /extra/file1.txt --source /extra/dir2\n```\n\n2. Colon-delimited paths in a single --source option:\n```\npython -m source.main --sinko-conf /path/to/sinko.conf.edn --source \"/extra/file1.txt:/extra/dir2:/extra/file3.txt\"\n```\n\nThe final backup source list will be a combination of sources from both the config file and command line options. When using colon-delimited paths, make sure to properly quote the argument if it contains special characters.\n\nFor the destination directory, the CLI option takes precedence over the config file if both are specified. You can override the destination directory from the config file using the --destination option:\n```\npython -m source.main --sinko-conf /path/to/sinko.conf.edn --destination /new/backup/path\n```\n\nNote that all CLI options except `--source` must be provided at most once. The following options cannot be duplicated:\n- `--sinko-conf`\n- `--destination`\n- `--remote`\n- `--log-level`\n\nFor remote backups, add the `--remote` flag:\n\n```\npython -m source.main --remote --sinko-conf /path/to/sinko.conf.edn\n```\n\n## Testing\n\nTo run the tests, use the following command:\n\n```\npytest\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 Your Actual Name\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A flexible backup tool supporting local and remote backups using rsync and SSH",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://codeberg.org/wizardelf/sinko/src/branch/ling/README.md",
"Repository": "https://codeberg.org/wizardelf/sinko"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ec84a595b2ffd21e18285ccc79344943433accaca30814764654746489d72802",
"md5": "356186255fb9ace1f9000fedf4e5b637",
"sha256": "a650eec867a23d918655801be92769a40c7b11a0ac707dec8c0cb315cc015d4a"
},
"downloads": -1,
"filename": "sinko-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "356186255fb9ace1f9000fedf4e5b637",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12242,
"upload_time": "2025-09-16T16:39:01",
"upload_time_iso_8601": "2025-09-16T16:39:01.170251Z",
"url": "https://files.pythonhosted.org/packages/ec/84/a595b2ffd21e18285ccc79344943433accaca30814764654746489d72802/sinko-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d13ab53f2508e713fc01eff6a018ec1820474b06ce09218d414f7d88da038eae",
"md5": "3856fed6eef86af863bf88fcd3a52524",
"sha256": "de32fcfe4ea471c9469f8e80ac7e9f84c7bde00fd95e4a2cae47d8282c66f0fc"
},
"downloads": -1,
"filename": "sinko-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3856fed6eef86af863bf88fcd3a52524",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9515,
"upload_time": "2025-09-16T16:39:02",
"upload_time_iso_8601": "2025-09-16T16:39:02.233847Z",
"url": "https://files.pythonhosted.org/packages/d1/3a/b53f2508e713fc01eff6a018ec1820474b06ce09218d414f7d88da038eae/sinko-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-16 16:39:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "wizardelf",
"codeberg_project": "sinko",
"lcname": "sinko"
}
