# fs2f
## Description
The **fs2f** script is for taking snapshots of a file structure into a single file, similar to archiving without compression.
## Features
- Create a snapshot file from a specified directory.
- Restore the file structure from a snapshot file to a chosen directory.
- Preserve information about the owner and access rights on UNIX-like systems.
- List the files and directories stored in the snapshot file.
- Verify file integrity using hash checks.
- *Strict mode* aborts recovery in the event of a hash error.
## Installation
- from GitHub
```bash
git clone https://github.com/codyverse/fs2f.git
cd fs2f
```
- via PIP
```bash
pip install fs2f
```
## Usage
Options:
```
-h, --help Show this help message and exit.
-m Create a file structure snapshot and save it to a file.
-u Restore a file structure snapshot from a file.
-s Disable strict mode (continue restoring despite file hash mismatches).
-l snapshot_file List files and directories stored in a file structure snapshot.
-d directory Path to the directory.
-f snapshot_file Path to the snapshot file.
```
### Examples
- Snapshot the entire file structure inside the `./folder/a` directory to the `file.fs` file:
```bash
python3 fs2f.py -m -d ./folder/a -f file.fs
```
- Restore the file structure from the `file.fs` file to the `./folder/b` directory:
```bash
python3 fs2f.py -u -d ./folder/b -f file.fs
```
- Display all files and directories saved within the `file.fs` file:
```bash
python3 fs2f.py -l file.fs
```
## Contributing
Feel free to contribute by submitting issues or pull requests!
Raw data
{
"_id": null,
"home_page": "https://github.com/codyverse/fs2f",
"name": "fs2f",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "file, snapshot, image, archive",
"author": "Andrii Burkatskyi aka andr11b",
"author_email": "4ndr116@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/96/26d75ee4e148ae7d06331cc07ea9de6ed8a8128b88dae7d59aaa7bd95d9b/fs2f-0.0.1.241223.tar.gz",
"platform": null,
"description": "# fs2f\n\n## Description\n\nThe **fs2f** script is for taking snapshots of a file structure into a single file, similar to archiving without compression.\n\n## Features\n\n - Create a snapshot file from a specified directory.\n - Restore the file structure from a snapshot file to a chosen directory.\n - Preserve information about the owner and access rights on UNIX-like systems.\n - List the files and directories stored in the snapshot file.\n - Verify file integrity using hash checks.\n - *Strict mode* aborts recovery in the event of a hash error.\n\n## Installation\n\n- from GitHub\n ```bash\n git clone https://github.com/codyverse/fs2f.git\n cd fs2f\n ```\n\n- via PIP\n ```bash\n pip install fs2f\n ```\n\n## Usage\n\nOptions:\n```\n -h, --help Show this help message and exit.\n -m Create a file structure snapshot and save it to a file.\n -u Restore a file structure snapshot from a file.\n -s Disable strict mode (continue restoring despite file hash mismatches).\n -l snapshot_file List files and directories stored in a file structure snapshot.\n -d directory Path to the directory.\n -f snapshot_file Path to the snapshot file.\n```\n\n### Examples\n\n- Snapshot the entire file structure inside the `./folder/a` directory to the `file.fs` file:\n ```bash\n python3 fs2f.py -m -d ./folder/a -f file.fs\n ```\n- Restore the file structure from the `file.fs` file to the `./folder/b` directory:\n ```bash\n python3 fs2f.py -u -d ./folder/b -f file.fs\n ```\n\n- Display all files and directories saved within the `file.fs` file:\n ```bash\n python3 fs2f.py -l file.fs\n ```\n\n## Contributing\n\nFeel free to contribute by submitting issues or pull requests!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "fs2f: A tool for taking snapshots of a file structure into a single file.",
"version": "0.0.1.241223",
"project_urls": {
"Homepage": "https://github.com/codyverse/fs2f"
},
"split_keywords": [
"file",
" snapshot",
" image",
" archive"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ee3807fbe696ba4d5b9106b40528c7355cab8fd6b0da6211fea57850ec3a4557",
"md5": "1a7163580f1c86c3bbd6d2e8e56c4168",
"sha256": "882bd5889cf34c7376fc0774ff5b61bb4a30e67ad6a3ea69e12bbaacbe69404e"
},
"downloads": -1,
"filename": "fs2f-0.0.1.241223-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a7163580f1c86c3bbd6d2e8e56c4168",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5454,
"upload_time": "2024-12-23T13:28:56",
"upload_time_iso_8601": "2024-12-23T13:28:56.378163Z",
"url": "https://files.pythonhosted.org/packages/ee/38/07fbe696ba4d5b9106b40528c7355cab8fd6b0da6211fea57850ec3a4557/fs2f-0.0.1.241223-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "429626d75ee4e148ae7d06331cc07ea9de6ed8a8128b88dae7d59aaa7bd95d9b",
"md5": "44774731e6cf2a68be03f78fe543aeb7",
"sha256": "85e1935261d851bafd3360b161486c7e5b3040a6e9d62bd906c67365905b0125"
},
"downloads": -1,
"filename": "fs2f-0.0.1.241223.tar.gz",
"has_sig": false,
"md5_digest": "44774731e6cf2a68be03f78fe543aeb7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6567,
"upload_time": "2024-12-23T13:28:58",
"upload_time_iso_8601": "2024-12-23T13:28:58.559004Z",
"url": "https://files.pythonhosted.org/packages/42/96/26d75ee4e148ae7d06331cc07ea9de6ed8a8128b88dae7d59aaa7bd95d9b/fs2f-0.0.1.241223.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-23 13:28:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "codyverse",
"github_project": "fs2f",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fs2f"
}
JSON
