renaming


Namerenaming JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryA cli tool to rename certain files according to a certain pattern.
upload_time2024-03-26 14:37:36
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseBSD 3-Clause License Copyright (c) 2024, Kyan Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords python3 renaming rename cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # renaming
[CHANGELOG](CHANGELOG.md)

[renaming](https://github.com/kyan001/PyRenaming) is a CLI tool to rename files in a directory according to a configuration file.

## Get Started

```sh
pip install renaming  # Install renaming

renaming  # Rename files in the current directory according to `renaming.toml`.
renaming -c/--config $config_file  # Rename files in the current directory according to "$config_file".
renaming -f/--folder $folder  # Rename files in "$folder" according to `renaming.toml`.
renaming -d/--dry-run  # Dry run. Show what would have been done, but do not actually rename anything.
renaming -y/--yes  # Do not ask for confirmation before renaming files.

renaming -h/--help  # Command-line help message.
renaming -v/--version  # Show version information.
```

## Installation

```sh
# pip
pip install --user renaming  # install renaming
pip install --upgrade renaming # upgrade renaming
pip uninstall renaming  # uninstall renaming

# pipx
pipx install renaming  # install renaming through pipx
pipx upgrade renaming  # upgrade renaming through pipx
pipx uninstall renaming  # uninstall renaming through pipx
```

## Config File
* Config file example: [renaming.toml](renaming.toml)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "renaming",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "python3, renaming, rename, cli",
    "author": null,
    "author_email": "Kyan <kai@kyan001.com>",
    "download_url": "https://files.pythonhosted.org/packages/f5/eb/4941469cca4a9249df8a42767097f36df6bda73a7c128dfc3bf65bdede81/renaming-0.1.3.tar.gz",
    "platform": null,
    "description": "# renaming\r\n[CHANGELOG](CHANGELOG.md)\r\n\r\n[renaming](https://github.com/kyan001/PyRenaming) is a CLI tool to rename files in a directory according to a configuration file.\r\n\r\n## Get Started\r\n\r\n```sh\r\npip install renaming  # Install renaming\r\n\r\nrenaming  # Rename files in the current directory according to `renaming.toml`.\r\nrenaming -c/--config $config_file  # Rename files in the current directory according to \"$config_file\".\r\nrenaming -f/--folder $folder  # Rename files in \"$folder\" according to `renaming.toml`.\r\nrenaming -d/--dry-run  # Dry run. Show what would have been done, but do not actually rename anything.\r\nrenaming -y/--yes  # Do not ask for confirmation before renaming files.\r\n\r\nrenaming -h/--help  # Command-line help message.\r\nrenaming -v/--version  # Show version information.\r\n```\r\n\r\n## Installation\r\n\r\n```sh\r\n# pip\r\npip install --user renaming  # install renaming\r\npip install --upgrade renaming # upgrade renaming\r\npip uninstall renaming  # uninstall renaming\r\n\r\n# pipx\r\npipx install renaming  # install renaming through pipx\r\npipx upgrade renaming  # upgrade renaming through pipx\r\npipx uninstall renaming  # uninstall renaming through pipx\r\n```\r\n\r\n## Config File\r\n* Config file example: [renaming.toml](renaming.toml)\r\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2024, Kyan  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "A cli tool to rename certain files according to a certain pattern.",
    "version": "0.1.3",
    "project_urls": {
        "Changelog": "https://github.com/kyan001/PyRenaming/blob/master/CHANGELOG.md",
        "Homepage": "https://github.com/kyan001/PyRenaming",
        "Issue Tracker": "https://github.com/kyan001/PyRenaming/issues",
        "Source Code": "https://github.com/kyan001/PyRenaming"
    },
    "split_keywords": [
        "python3",
        " renaming",
        " rename",
        " cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "92394b5409c916c2e99a2cdaa7af0fb60ac4b398af8bd15ea4762720c43338bb",
                "md5": "8f4c7ad2ae7eb94f18186aba706dfffa",
                "sha256": "2347785cdf899c53fa3b89220da80e320a4ab6eae39bde9259d8109710a2d39c"
            },
            "downloads": -1,
            "filename": "renaming-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8f4c7ad2ae7eb94f18186aba706dfffa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6570,
            "upload_time": "2024-03-26T14:37:34",
            "upload_time_iso_8601": "2024-03-26T14:37:34.956620Z",
            "url": "https://files.pythonhosted.org/packages/92/39/4b5409c916c2e99a2cdaa7af0fb60ac4b398af8bd15ea4762720c43338bb/renaming-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f5eb4941469cca4a9249df8a42767097f36df6bda73a7c128dfc3bf65bdede81",
                "md5": "f6fdae62a735da384d864876d0b13d20",
                "sha256": "36e4a59ca0a0359a4475f583a0d287575f7907b612b8916d56a239cdd85ba705"
            },
            "downloads": -1,
            "filename": "renaming-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "f6fdae62a735da384d864876d0b13d20",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6185,
            "upload_time": "2024-03-26T14:37:36",
            "upload_time_iso_8601": "2024-03-26T14:37:36.154428Z",
            "url": "https://files.pythonhosted.org/packages/f5/eb/4941469cca4a9249df8a42767097f36df6bda73a7c128dfc3bf65bdede81/renaming-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-26 14:37:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kyan001",
    "github_project": "PyRenaming",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "renaming"
}
        
Elapsed time: 0.25069s