shinigami

Name	shinigami JSON
Version	0.2.1 JSON
	download
home_page	https://github.com/battleoverflow/shinigami
Summary	Shinigami is an open source Python library allowing the user to generate and build Dockerfiles during runtime
upload_time	2024-04-15 05:55:11
maintainer	None
docs_url	None
author	battleoverflow
requires_python	>=3.6
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <h1 align="center">
    <img src="https://raw.githubusercontent.com/battleoverflow/shinigami/main/assets/shinigami_logo.png" />
</h1>

<p align="center">
    <b>Shinigami was created to be simplistic and maintainable</b>
</p>

Shinigami is an open source Python library allowing the user to generate and build Dockerfiles during runtime.

## Usage

You can install Shinigami via pip:

```bash
pip install shinigami
```

### Example

```python
from shinigami import Shinigami

def create_file():
    Shinigami(lang_os="python", version="3.9", build=True, verbose=True, color=True).generate_dockerfile()

if __name__ == '__main__':
    create_file()
```

If you just want to generate the Dockerfile without building the container, you can do that too. Just remove the `build` boolean from the class and you should see a Dockerfile populate in your current directory within seconds.

## CLI

### Usage

Available commands:

```
-h,  --help      |  Help menu
-i,  --image     |  Docker image to generate
-v,  --version   |  Version of the Docker image
-b,  --build     |  Build the Dockerfile after generation
-c,  --color     |  Generate color in the output
-rm, --remove    |  Remove the Dockerfile in your current working directory
```

### Examples

This command will generate a Dockerfile for Ubuntu 22.04, but won't build the Docker image
```bash
shinigami -i "ubuntu" -v "22.04"
```

This command will build a Docker image running Python 3.8 and generate the Dockerfile
```bash
shinigami -i "python" -v "3.8" -b
```

Removes the Dockerfile in your current working directory
```bash
shinigami -rm
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/battleoverflow/shinigami",
    "name": "shinigami",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "battleoverflow",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/6e/d9/7c99b1bc6449bf4309e4e44d3f82de0a14e7a88ecc588f792e7b470a6206/shinigami-0.2.1.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">\n    <img src=\"https://raw.githubusercontent.com/battleoverflow/shinigami/main/assets/shinigami_logo.png\" />\n</h1>\n\n<p align=\"center\">\n    <b>Shinigami was created to be simplistic and maintainable</b>\n</p>\n\nShinigami is an open source Python library allowing the user to generate and build Dockerfiles during runtime.\n\n## Usage\n\nYou can install Shinigami via pip:\n\n```bash\npip install shinigami\n```\n\n### Example\n\n```python\nfrom shinigami import Shinigami\n\ndef create_file():\n    Shinigami(lang_os=\"python\", version=\"3.9\", build=True, verbose=True, color=True).generate_dockerfile()\n\nif __name__ == '__main__':\n    create_file()\n```\n\nIf you just want to generate the Dockerfile without building the container, you can do that too. Just remove the `build` boolean from the class and you should see a Dockerfile populate in your current directory within seconds.\n\n## CLI\n\n### Usage\n\nAvailable commands:\n\n```\n-h,  --help      |  Help menu\n-i,  --image     |  Docker image to generate\n-v,  --version   |  Version of the Docker image\n-b,  --build     |  Build the Dockerfile after generation\n-c,  --color     |  Generate color in the output\n-rm, --remove    |  Remove the Dockerfile in your current working directory\n```\n\n### Examples\n\nThis command will generate a Dockerfile for Ubuntu 22.04, but won't build the Docker image\n```bash\nshinigami -i \"ubuntu\" -v \"22.04\"\n```\n\nThis command will build a Docker image running Python 3.8 and generate the Dockerfile\n```bash\nshinigami -i \"python\" -v \"3.8\" -b\n```\n\nRemoves the Dockerfile in your current working directory\n```bash\nshinigami -rm\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Shinigami is an open source Python library allowing the user to generate and build Dockerfiles during runtime",
    "version": "0.2.1",
    "project_urls": {
        "Homepage": "https://github.com/battleoverflow/shinigami"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "27af8bb35dc65eef858c165e15b96148a501d2704949355f6104dc75dc4071b4",
                "md5": "22a405fa14ac6b986ea5367cdd958717",
                "sha256": "c7e0d4b3838b74a9290e4b192dd517fb71700b244242be558cd26c833e6d9531"
            },
            "downloads": -1,
            "filename": "shinigami-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "22a405fa14ac6b986ea5367cdd958717",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 4944,
            "upload_time": "2024-04-15T05:55:10",
            "upload_time_iso_8601": "2024-04-15T05:55:10.100634Z",
            "url": "https://files.pythonhosted.org/packages/27/af/8bb35dc65eef858c165e15b96148a501d2704949355f6104dc75dc4071b4/shinigami-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ed97c99b1bc6449bf4309e4e44d3f82de0a14e7a88ecc588f792e7b470a6206",
                "md5": "862281431a5a837d677d03adeccdf5ec",
                "sha256": "3a1dd4922f0391e42afe0a6ca0a92d265eac78ddc3bad2e7963f8f3b026cb3ad"
            },
            "downloads": -1,
            "filename": "shinigami-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "862281431a5a837d677d03adeccdf5ec",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4429,
            "upload_time": "2024-04-15T05:55:11",
            "upload_time_iso_8601": "2024-04-15T05:55:11.962652Z",
            "url": "https://files.pythonhosted.org/packages/6e/d9/7c99b1bc6449bf4309e4e44d3f82de0a14e7a88ecc588f792e7b470a6206/shinigami-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-15 05:55:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "battleoverflow",
    "github_project": "shinigami",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "shinigami"
}