cmgr


Namecmgr JSON
Version 0.2.3 PyPI version JSON
download
home_pageNone
SummaryA configuratable config manager for your packages.
upload_time2024-11-30 12:42:29
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 configuratable config manager
VCS
bugtrack_url
requirements consoleiotools consolecmdtools click
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Config Manager (cmgr)
[CHANGELOG](CHANGELOG.md)

[cmgr](https://github.com/kyan001/PyConfigManager) is a command-line tool to manage configurations and packages. It's designed to be simple and easy to use. It's written in Python and can be installed via pip and pipx.

## Get Started

```sh
pip install cmgr  # Install cmgr
cmgr  # Run cmgr. Detect all `cmgr.toml` under current folder.
```

## Installation

```sh
# using pip
pip install --user cmgr  # install cmgr
pip install --upgrade cmgr # upgrade cmgr
pip uninstall cmgr  # uninstall cmgr

# using pipx
pipx install cmgr  # install cmgr
pipx upgrade cmgr  # upgrade cmgr
pipx uninstall cmgr  # uninstall cmgr
```

## Usage

```sh
# Shell
cmgr --help  # Command-line help message.
cmgr --version  # Show version information.

cmgr  # Run cgmr. Will looking for all cmgr.toml under current folder.
cmgr -p/--profile '/path/to/root/cmgr.toml'  # Run cmgr with specific profile.
cmgr -r/--root '/path/to/root/'  # Run cmgr with specific root folder.
cmgr -n/--name 'my-cmgr.toml'  # Run cmgr with specific profile's filename.

# Install package
cmgr install ping3  # Install a package named ping3. Using default package manager.
cmgr install ping3 -c/--command 'ping3'  # Use specific command to detect if the package is installed before install.
cmgr install ping3 -m/--manager 'pip'  # Use specific package manager to install the package.

# Copy configuration
cmgr config "bash.conf" "~/.bashrc"  # Copy `./bash.conf` to `~/.bashrc`.
cmgr config "bash.conf" "~/.bashrc" -n/--name "BASH"  # Copy `bash.conf` to `~/` as `.bashrc` with specific name in output.
```

## Profile
* A cmgr profile example: [cmgr-example.toml](cmgr-example.toml)
* A minimal cmgr profile: [cmgr-minimal.toml](cmgr-minimal.toml)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cmgr",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "python3, configuratable, config, manager",
    "author": null,
    "author_email": "Kyan <k@kyan001.com>",
    "download_url": "https://files.pythonhosted.org/packages/ee/d4/6845bc1e304f3a4d509e2a18ee072c49c037f07a6414a89a01ae4a0c34e1/cmgr-0.2.3.tar.gz",
    "platform": null,
    "description": "# Config Manager (cmgr)\r\n[CHANGELOG](CHANGELOG.md)\r\n\r\n[cmgr](https://github.com/kyan001/PyConfigManager) is a command-line tool to manage configurations and packages. It's designed to be simple and easy to use. It's written in Python and can be installed via pip and pipx.\r\n\r\n## Get Started\r\n\r\n```sh\r\npip install cmgr  # Install cmgr\r\ncmgr  # Run cmgr. Detect all `cmgr.toml` under current folder.\r\n```\r\n\r\n## Installation\r\n\r\n```sh\r\n# using pip\r\npip install --user cmgr  # install cmgr\r\npip install --upgrade cmgr # upgrade cmgr\r\npip uninstall cmgr  # uninstall cmgr\r\n\r\n# using pipx\r\npipx install cmgr  # install cmgr\r\npipx upgrade cmgr  # upgrade cmgr\r\npipx uninstall cmgr  # uninstall cmgr\r\n```\r\n\r\n## Usage\r\n\r\n```sh\r\n# Shell\r\ncmgr --help  # Command-line help message.\r\ncmgr --version  # Show version information.\r\n\r\ncmgr  # Run cgmr. Will looking for all cmgr.toml under current folder.\r\ncmgr -p/--profile '/path/to/root/cmgr.toml'  # Run cmgr with specific profile.\r\ncmgr -r/--root '/path/to/root/'  # Run cmgr with specific root folder.\r\ncmgr -n/--name 'my-cmgr.toml'  # Run cmgr with specific profile's filename.\r\n\r\n# Install package\r\ncmgr install ping3  # Install a package named ping3. Using default package manager.\r\ncmgr install ping3 -c/--command 'ping3'  # Use specific command to detect if the package is installed before install.\r\ncmgr install ping3 -m/--manager 'pip'  # Use specific package manager to install the package.\r\n\r\n# Copy configuration\r\ncmgr config \"bash.conf\" \"~/.bashrc\"  # Copy `./bash.conf` to `~/.bashrc`.\r\ncmgr config \"bash.conf\" \"~/.bashrc\" -n/--name \"BASH\"  # Copy `bash.conf` to `~/` as `.bashrc` with specific name in output.\r\n```\r\n\r\n## Profile\r\n* A cmgr profile example: [cmgr-example.toml](cmgr-example.toml)\r\n* A minimal cmgr profile: [cmgr-minimal.toml](cmgr-minimal.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 configuratable config manager for your packages.",
    "version": "0.2.3",
    "project_urls": {
        "Changelog": "https://github.com/kyan001/PyConfigManager/blob/master/CHANGELOG.md",
        "Homepage": "https://github.com/kyan001/PyConfigManager",
        "Issue Tracker": "https://github.com/kyan001/PyConfigManager/issues",
        "Source Code": "https://github.com/kyan001/PyConfigManager"
    },
    "split_keywords": [
        "python3",
        " configuratable",
        " config",
        " manager"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fdfffbf696dbb1a916cc5a4f347859f863aee52573659988e1fb3b4bebd8165a",
                "md5": "8cae49d01bbc99f2d95e723355cd270b",
                "sha256": "80700b6d8cce072bce1201ad2d9569e1e38e793e8354ea2d59b1c649fe2fcd4a"
            },
            "downloads": -1,
            "filename": "cmgr-0.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8cae49d01bbc99f2d95e723355cd270b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7884,
            "upload_time": "2024-11-30T12:42:16",
            "upload_time_iso_8601": "2024-11-30T12:42:16.203284Z",
            "url": "https://files.pythonhosted.org/packages/fd/ff/fbf696dbb1a916cc5a4f347859f863aee52573659988e1fb3b4bebd8165a/cmgr-0.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eed46845bc1e304f3a4d509e2a18ee072c49c037f07a6414a89a01ae4a0c34e1",
                "md5": "a16c452707c1bfcdf33a9ce8d419fc03",
                "sha256": "4d99da9ed2a02792f0497792604bedd99780175aa244e655eb596ad22dad3f70"
            },
            "downloads": -1,
            "filename": "cmgr-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "a16c452707c1bfcdf33a9ce8d419fc03",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7398,
            "upload_time": "2024-11-30T12:42:29",
            "upload_time_iso_8601": "2024-11-30T12:42:29.742970Z",
            "url": "https://files.pythonhosted.org/packages/ee/d4/6845bc1e304f3a4d509e2a18ee072c49c037f07a6414a89a01ae4a0c34e1/cmgr-0.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-30 12:42:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kyan001",
    "github_project": "PyConfigManager",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "consoleiotools",
            "specs": []
        },
        {
            "name": "consolecmdtools",
            "specs": [
                [
                    ">=",
                    "6.6.1"
                ]
            ]
        },
        {
            "name": "click",
            "specs": []
        }
    ],
    "lcname": "cmgr"
}
        
Elapsed time: 0.35917s