Delete
======
*A simple, cross-platform, command-line move-to-trash.*
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
:alt: License
.. image:: https://img.shields.io/pypi/v/delete-cli.svg
:target: https://pypi.org/project/delete-cli
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/delete-cli.svg?logoColor=white
:target: https://pypi.org/project/delete-cli
:alt: Python Versions
.. image:: https://readthedocs.org/projects/delete-cli/badge/?version=latest&color=green
:target: https://delete-cli.readthedocs.io
:alt: Documentation
.. image:: https://pepy.tech/badge/delete-cli
:target: https://pepy.tech/badge/delete-cli
:alt: Downloads
But why?
--------
The ``del`` command is a simple alternative to using the standard ``rm`` command.
Using ``rm`` as a matter of course can be dangerous and prone to mistakes. Once a file is
unlinked with ``rm`` it cannot be recovered (without having backups).
All major graphical environments offer a "move to trash" option. This does a clean move
operation to a "trash" folder. Once a file as been put in the trash it can be recovered
easily. Periodically, the trash can be emptied if desired.
``del`` is a command-line implementation of this metaphor. It maintains a basic
``sqlite3`` database of files and folders put in the trash. Using the ``--list`` option
will list the contents. Using ``--restore`` will restore a file or folder from the trash.
Using ``--empty`` will purge anything put in the trash by ``del``.
Installation
------------
If you already have Python 3.12+ on your system, you can install ``del`` using Pip.
.. code-block:: bash
pip install delete-cli
Basic Usage
-----------
Calling ``del`` with no arguments or with the ``--help`` flag yield typically Unix
style behavior, print a usage or help statement, respectively. For detailed usage and
examples you can read the manual page, ``man del``.
Deleting files and folders is as simple as:
.. code-block:: bash
del file1.txt file2.txt folderA
Files or folders that get deleted with the same basename will have a suffix added before
the extension (e.g., ``file1.1.txt``, ``file1.2.txt``, ...).
Restore files using their basename (in the trash), their full path (in the trash) or
their original full path.
Documentation
-------------
Documentation is available at `delete-cli.readthedocs.io <https://delete-cli.readthedocs.io>`_.
For basic usage information on the command-line use: ``del --help``. For a more comprehensive
usage guide on the command line you can view the manual page with ``man del``.
Contributions
-------------
Contributions are welcome in the form of suggestions for additional features, pull requests with
new features or bug fixes, etc. If you find bugs or have questions, open an *Issue* here. If and
when the project grows, a code of conduct will be provided along side a more comprehensive set of
guidelines for contributing; until then, just be nice.
Raw data
{
"_id": null,
"home_page": "https://delete-cli.readthedocs.io",
"name": "delete-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.12,<4.0",
"maintainer_email": "",
"keywords": "command-line,utility",
"author": "Geoffrey Lentner",
"author_email": "glentner@purdue.edu",
"download_url": "https://files.pythonhosted.org/packages/ad/31/13da80953801d185806ddb3a0e0dff3ecc5cafd1aa9f77e7af2da6a84ff7/delete_cli-2.0.0.tar.gz",
"platform": null,
"description": "Delete\n======\n\n*A simple, cross-platform, command-line move-to-trash.*\n\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: License\n\n.. image:: https://img.shields.io/pypi/v/delete-cli.svg\n :target: https://pypi.org/project/delete-cli\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/delete-cli.svg?logoColor=white\n :target: https://pypi.org/project/delete-cli\n :alt: Python Versions\n\n.. image:: https://readthedocs.org/projects/delete-cli/badge/?version=latest&color=green\n :target: https://delete-cli.readthedocs.io\n :alt: Documentation\n\n.. image:: https://pepy.tech/badge/delete-cli\n :target: https://pepy.tech/badge/delete-cli\n :alt: Downloads\n\n\nBut why?\n--------\n\nThe ``del`` command is a simple alternative to using the standard ``rm`` command.\nUsing ``rm`` as a matter of course can be dangerous and prone to mistakes. Once a file is\nunlinked with ``rm`` it cannot be recovered (without having backups).\n\nAll major graphical environments offer a \"move to trash\" option. This does a clean move\noperation to a \"trash\" folder. Once a file as been put in the trash it can be recovered\neasily. Periodically, the trash can be emptied if desired.\n\n``del`` is a command-line implementation of this metaphor. It maintains a basic\n``sqlite3`` database of files and folders put in the trash. Using the ``--list`` option\nwill list the contents. Using ``--restore`` will restore a file or folder from the trash.\nUsing ``--empty`` will purge anything put in the trash by ``del``.\n\n\nInstallation\n------------\n\nIf you already have Python 3.12+ on your system, you can install ``del`` using Pip.\n\n.. code-block:: bash\n\n pip install delete-cli\n\n\nBasic Usage\n-----------\n\nCalling ``del`` with no arguments or with the ``--help`` flag yield typically Unix\nstyle behavior, print a usage or help statement, respectively. For detailed usage and\nexamples you can read the manual page, ``man del``.\n\nDeleting files and folders is as simple as:\n\n.. code-block:: bash\n\n del file1.txt file2.txt folderA\n\nFiles or folders that get deleted with the same basename will have a suffix added before\nthe extension (e.g., ``file1.1.txt``, ``file1.2.txt``, ...).\n\nRestore files using their basename (in the trash), their full path (in the trash) or\ntheir original full path.\n\n\nDocumentation\n-------------\n\nDocumentation is available at `delete-cli.readthedocs.io <https://delete-cli.readthedocs.io>`_.\nFor basic usage information on the command-line use: ``del --help``. For a more comprehensive\nusage guide on the command line you can view the manual page with ``man del``.\n\n\nContributions\n-------------\n\nContributions are welcome in the form of suggestions for additional features, pull requests with\nnew features or bug fixes, etc. If you find bugs or have questions, open an *Issue* here. If and\nwhen the project grows, a code of conduct will be provided along side a more comprehensive set of\nguidelines for contributing; until then, just be nice.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple, cross-platform, command-line move-to-trash.",
"version": "2.0.0",
"project_urls": {
"Documentation": "https://delete-cli.readthedocs.io",
"Homepage": "https://delete-cli.readthedocs.io",
"Repository": "https://github.com/glentner/delete-cli"
},
"split_keywords": [
"command-line",
"utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52b96d48ebe201a73585585734e68e5df498044c219fb751bf7f15a5d5f2289c",
"md5": "c5f5a74245b281600fcc5148bd71a857",
"sha256": "68466bfc34e889693f97103b37836d925051993ea47e6a643f34f4eb3960b298"
},
"downloads": -1,
"filename": "delete_cli-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5f5a74245b281600fcc5148bd71a857",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12,<4.0",
"size": 7516,
"upload_time": "2024-01-27T22:44:45",
"upload_time_iso_8601": "2024-01-27T22:44:45.121676Z",
"url": "https://files.pythonhosted.org/packages/52/b9/6d48ebe201a73585585734e68e5df498044c219fb751bf7f15a5d5f2289c/delete_cli-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad3113da80953801d185806ddb3a0e0dff3ecc5cafd1aa9f77e7af2da6a84ff7",
"md5": "eaf5018a5ca60ca99b00013be6afadc2",
"sha256": "774ae6cf546846285b13a5f78320e73dba782b1b35e1d992572a4b686da4ed53"
},
"downloads": -1,
"filename": "delete_cli-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "eaf5018a5ca60ca99b00013be6afadc2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12,<4.0",
"size": 6676,
"upload_time": "2024-01-27T22:44:46",
"upload_time_iso_8601": "2024-01-27T22:44:46.716639Z",
"url": "https://files.pythonhosted.org/packages/ad/31/13da80953801d185806ddb3a0e0dff3ecc5cafd1aa9f77e7af2da6a84ff7/delete_cli-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-27 22:44:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glentner",
"github_project": "delete-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "delete-cli"
}
JSON
