# ext2term
`ext2term` is a Python CLI tool and library designed to help users learn about the ext2 file system. It simulates a terminal environment, allowing users to interact with the ext2 file system without the need to mount it on their system.
## Features
- **Navigate Directories**: Use familiar commands like `ls` and `cd` to explore the file structure.
- **View File Contents**: Draft ext2-formatted files to your own file system by using `dump`.
- **Extensibility**: `ext2term` serves as a Python library, making it possible for other developers to include ext2 functionality in their own Python programs.
## Installation
`pip install ext2term`
## Usage
`ext2term <ext2fs.img>`
This will launch a virtual terminal session where you can start interacting with your ext2 file system. Here are some of the commands available:
- `ls [-l]`: List the contents of the cwd.
- `cd DIRECTORY`: Change into the specified directory.
- `pwd`: Display the current working directory.
- `dump FILE DESTINATION_PATH`: Copy a file from the file system to the local file system.
- `exit`: Close the session and exit the virtual terminal.
## As a Python Library
In addition to being a CLI tool, `ext2term` is also usable as a library. You can import its classes and utilize them in your own Python code to manipulate or analyze an ext2 file system programmatically.
Here's a snippet showing how you could use `ext2term` in your code:
```python
from ext2term import Ext2
# Initialize an Ext2 object with the path to your ext2 filesystem
ext2_fs = Ext2('/path/to/ext2fs.img')
# List the contents of the root directory
ext2_fs.ls()
# Change the directory
ext2_fs.cd('some_directory')
# Print the current working directory
ext2_fs.pwd()
```
## Contributing
I'm open to contributions.
## License
ext2term is released under the BSD 2-Clause License.
## Disclaimer
This tool is for educational purposes only and should not be used on a production environment or to manipulate critical data.
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/ext2term",
"name": "ext2term",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": null,
"keywords": "ext2 filesystem",
"author": "William Guerrand",
"author_email": "guerrandw@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a0/64/7f6a993261acaa23307da51e52d4a82ca1ca4b45ecec92d6685c3805e274/ext2term-0.2.0.tar.gz",
"platform": null,
"description": "# ext2term\n\n`ext2term` is a Python CLI tool and library designed to help users learn about the ext2 file system. It simulates a terminal environment, allowing users to interact with the ext2 file system without the need to mount it on their system.\n\n## Features\n\n- **Navigate Directories**: Use familiar commands like `ls` and `cd` to explore the file structure.\n- **View File Contents**: Draft ext2-formatted files to your own file system by using `dump`. \n- **Extensibility**: `ext2term` serves as a Python library, making it possible for other developers to include ext2 functionality in their own Python programs.\n\n## Installation\n\n`pip install ext2term`\n\n## Usage\n\n`ext2term <ext2fs.img>`\n\nThis will launch a virtual terminal session where you can start interacting with your ext2 file system. Here are some of the commands available:\n\n- `ls [-l]`: List the contents of the cwd.\n- `cd DIRECTORY`: Change into the specified directory.\n- `pwd`: Display the current working directory.\n- `dump FILE DESTINATION_PATH`: Copy a file from the file system to the local file system.\n- `exit`: Close the session and exit the virtual terminal.\n\n## As a Python Library\n\nIn addition to being a CLI tool, `ext2term` is also usable as a library. You can import its classes and utilize them in your own Python code to manipulate or analyze an ext2 file system programmatically.\n\nHere's a snippet showing how you could use `ext2term` in your code:\n\n```python\nfrom ext2term import Ext2\n\n# Initialize an Ext2 object with the path to your ext2 filesystem\next2_fs = Ext2('/path/to/ext2fs.img')\n\n# List the contents of the root directory\next2_fs.ls()\n\n# Change the directory\next2_fs.cd('some_directory')\n\n# Print the current working directory\next2_fs.pwd()\n```\n\n## Contributing\nI'm open to contributions.\n\n## License\next2term is released under the BSD 2-Clause License.\n\n## Disclaimer\nThis tool is for educational purposes only and should not be used on a production environment or to manipulate critical data.\n",
"bugtrack_url": null,
"license": "BSD 2-Clause License",
"summary": "A CLI and library for navigating ext2 filesystems",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/yourusername/ext2term"
},
"split_keywords": [
"ext2",
"filesystem"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba296f33cc2f83f70ba0a5b6a8917b08e0851f98a1965f47ac151f3870ec3f5e",
"md5": "632b8e27ffcbe7c95d45db74ab3c7d5f",
"sha256": "72d4ea639bbc97c459b4b9d8cadaf0b5857957bc10686e791c6f2b7452d1bb5a"
},
"downloads": -1,
"filename": "ext2term-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "632b8e27ffcbe7c95d45db74ab3c7d5f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 11766,
"upload_time": "2024-04-29T21:47:02",
"upload_time_iso_8601": "2024-04-29T21:47:02.132268Z",
"url": "https://files.pythonhosted.org/packages/ba/29/6f33cc2f83f70ba0a5b6a8917b08e0851f98a1965f47ac151f3870ec3f5e/ext2term-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0647f6a993261acaa23307da51e52d4a82ca1ca4b45ecec92d6685c3805e274",
"md5": "6c66ea2a14ea33991ead448dd535af92",
"sha256": "cfc6a994c15af4e627e01d9e040ee258dbd953f4cac2caa03f1a496ab02bb1e7"
},
"downloads": -1,
"filename": "ext2term-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6c66ea2a14ea33991ead448dd535af92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 10556,
"upload_time": "2024-04-29T21:47:04",
"upload_time_iso_8601": "2024-04-29T21:47:04.281559Z",
"url": "https://files.pythonhosted.org/packages/a0/64/7f6a993261acaa23307da51e52d4a82ca1ca4b45ecec92d6685c3805e274/ext2term-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 21:47:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "ext2term",
"github_not_found": true,
"lcname": "ext2term"
}
JSON
