proteuscmd

Name	proteuscmd JSON
Version	0.9 JSON
	download
home_page	https://github.com/virtUOS/proteuscmd
Summary	A command line interface to modify DNS entries in Proteus.
upload_time	2024-07-01 10:08:36
maintainer	None
docs_url	None
author	Lars Kiesow
requires_python	None
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Proteus Command Line Client

A simple command line client to modify DNS entries in Proteus.

## Installation

Use `pip` to install `proteuscmd`:

```
❯ pip install proteuscmd
```

## Configuration

Configure access credentials in `~/.proteus.json`:
```json
{
	"user": "api-user",
	"password": "super.secret!",
	"url": "https://proteus.example.com"
}
```

Additionally, you can specify a map of automatic replacements for domains.
This can be useful if, for example, all your domains also have an alternate domain with a `DNAME` record.
```json
{
	...
	"replace": {
		".ex.com": ".example.com"
	}
}
```

## Usage

```
❯ proteuscmd
Usage: python -m proteuscmd [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  dns  Get information about or update DNS entries.
  ip   Register IP addresses.
```

Get information about a DNS record:
```
❯ proteuscmd dns get lktest.uni-osnabrueck.de
```

## Shell Completion

The `proteuscmd` command line tool supports shell completion for several major shells:

For **Bash**, add to `~/.bashrc`:

```
eval "$(_PROTEUSCMD_COMPLETE=bash_source proteuscmd)"
```

For **ZSH**, add to `~/.zshrc`:

```
eval "$(_PROTEUSCMD_COMPLETE=zsh_source proteuscmd)"
```

For **fish**, add to `~/.config/fish/completions/proteuscmd.fish`:

```
_PROTEUSCMD_COMPLETE=fish_source proteuscmd | source
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/virtUOS/proteuscmd",
    "name": "proteuscmd",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Lars Kiesow",
    "author_email": "lkiesow@uos.de",
    "download_url": "https://files.pythonhosted.org/packages/f9/a7/c820c55580f4d4c18de63da8953ed000d2ea29e0b4fd5474a4c297a0f159/proteuscmd-0.9.tar.gz",
    "platform": null,
    "description": "# Proteus Command Line Client\n\nA simple command line client to modify DNS entries in Proteus.\n\n## Installation\n\nUse `pip` to install `proteuscmd`:\n\n```\n\u276f pip install proteuscmd\n```\n\n## Configuration\n\nConfigure access credentials in `~/.proteus.json`:\n```json\n{\n\t\"user\": \"api-user\",\n\t\"password\": \"super.secret!\",\n\t\"url\": \"https://proteus.example.com\"\n}\n```\n\nAdditionally, you can specify a map of automatic replacements for domains.\nThis can be useful if, for example, all your domains also have an alternate domain with a `DNAME` record.\n```json\n{\n\t...\n\t\"replace\": {\n\t\t\".ex.com\": \".example.com\"\n\t}\n}\n```\n\n## Usage\n\n```\n\u276f proteuscmd\nUsage: python -m proteuscmd [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  --help  Show this message and exit.\n\nCommands:\n  dns  Get information about or update DNS entries.\n  ip   Register IP addresses.\n```\n\nGet information about a DNS record:\n```\n\u276f proteuscmd dns get lktest.uni-osnabrueck.de\n```\n\n## Shell Completion\n\nThe `proteuscmd` command line tool supports shell completion for several major shells:\n\nFor **Bash**, add to `~/.bashrc`:\n\n```\neval \"$(_PROTEUSCMD_COMPLETE=bash_source proteuscmd)\"\n```\n\nFor **ZSH**, add to `~/.zshrc`:\n\n```\neval \"$(_PROTEUSCMD_COMPLETE=zsh_source proteuscmd)\"\n```\n\nFor **fish**, add to `~/.config/fish/completions/proteuscmd.fish`:\n\n```\n_PROTEUSCMD_COMPLETE=fish_source proteuscmd | source\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A command line interface to modify DNS entries in Proteus.",
    "version": "0.9",
    "project_urls": {
        "Homepage": "https://github.com/virtUOS/proteuscmd"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9a7c820c55580f4d4c18de63da8953ed000d2ea29e0b4fd5474a4c297a0f159",
                "md5": "d7be64bdad4e4f5c7b494e4a5ac25bc6",
                "sha256": "8008b65c8e1b32b4fa9f5ee38a2ebbfd15c943baab18396282d8828a5a1a7567"
            },
            "downloads": -1,
            "filename": "proteuscmd-0.9.tar.gz",
            "has_sig": false,
            "md5_digest": "d7be64bdad4e4f5c7b494e4a5ac25bc6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7114,
            "upload_time": "2024-07-01T10:08:36",
            "upload_time_iso_8601": "2024-07-01T10:08:36.453803Z",
            "url": "https://files.pythonhosted.org/packages/f9/a7/c820c55580f4d4c18de63da8953ed000d2ea29e0b4fd5474a4c297a0f159/proteuscmd-0.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-01 10:08:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "virtUOS",
    "github_project": "proteuscmd",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "proteuscmd"
}