gopappy


Namegopappy JSON
Version 1.8.0 PyPI version JSON
download
home_pageNone
SummaryGoDaddy v1 API implementation with secured auth token.
upload_time2024-10-19 00:08:28
maintainerNone
docs_urlNone
authorGamaliel Espinoza
requires_python<3.13,>=3.11
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # gopappy

Inspo from [here](https://github.com/gamikun/gopapi).

## Installation

```bash
python -m pip install -U gopappy
```

## Usage

### Authentication

* Run `gopappy` to setup authentication
* Three values are [needed to authenticate](https://developer.godaddy.com/keys):
  * API Key
  * API Secret
  * Domain

### Adding a DNS record to a domain

```bash
# A record
gopappy add-record $DOMAIN -t A -n subdomain -d 127.0.0.1

# CNAME
gopappy add-record $DOMAIN -t CNAME -n www -d $DOMAIN

# TXT
gopappy add-record $DOMAIN -t TXT -n subdomain -d "some text here"
```

### Deleting a DNS record from a domain

```bash
gopappy delete-record $DOMAIN -t A -n subdomain
```

### Listing records of a domain

```bash
# list all records
gopappy records $DOMAIN

# filter by record type
gopappy records $DOMAIN -t cname
```

### Listing all domains in godaddy account

```bash
gopappy domains
# mydomain1.com
# mydomain2.com
```

### Check whether a domain is available to purchase or not

```bash
gopappy check $DOMAIN 
```

## TODO

* Control for no arguments (e.g., call `--help`)
    ```bash
    λ gopappy
    Failed to retrieve environment variables from keyring
    Enter your GoDaddy API Key:
    Enter your GoDaddy API Secret:
    Enter your GoDaddy Domain: testytesterson.com
    Successfully set environment variables in keyring!

    Usage: gopappy [OPTIONS] COMMAND [ARGS]...
    Try 'gopappy --help' for help.
    ╭─ Error ───────────────────────────────────────────────────────────────────────────────────────────────────╮
    │ Missing command.                                                                                          │
    ╰───────────────────────────────────────────────────────────────────────────────────────────────────────────╯

    ```
* Add subcommand to manage `auth`
  * CRUD

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "gopappy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Gamaliel Espinoza",
    "author_email": "gamaliel.espinoza@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/51/9e/4836937dc0ef5d5512d1f12cd478c26b7cda1202a0c241c3bf9e8c3178a6/gopappy-1.8.0.tar.gz",
    "platform": null,
    "description": "# gopappy\n\nInspo from [here](https://github.com/gamikun/gopapi).\n\n## Installation\n\n```bash\npython -m pip install -U gopappy\n```\n\n## Usage\n\n### Authentication\n\n* Run `gopappy` to setup authentication\n* Three values are [needed to authenticate](https://developer.godaddy.com/keys):\n  * API Key\n  * API Secret\n  * Domain\n\n### Adding a DNS record to a domain\n\n```bash\n# A record\ngopappy add-record $DOMAIN -t A -n subdomain -d 127.0.0.1\n\n# CNAME\ngopappy add-record $DOMAIN -t CNAME -n www -d $DOMAIN\n\n# TXT\ngopappy add-record $DOMAIN -t TXT -n subdomain -d \"some text here\"\n```\n\n### Deleting a DNS record from a domain\n\n```bash\ngopappy delete-record $DOMAIN -t A -n subdomain\n```\n\n### Listing records of a domain\n\n```bash\n# list all records\ngopappy records $DOMAIN\n\n# filter by record type\ngopappy records $DOMAIN -t cname\n```\n\n### Listing all domains in godaddy account\n\n```bash\ngopappy domains\n# mydomain1.com\n# mydomain2.com\n```\n\n### Check whether a domain is available to purchase or not\n\n```bash\ngopappy check $DOMAIN \n```\n\n## TODO\n\n* Control for no arguments (e.g., call `--help`)\n    ```bash\n    \u03bb gopappy\n    Failed to retrieve environment variables from keyring\n    Enter your GoDaddy API Key:\n    Enter your GoDaddy API Secret:\n    Enter your GoDaddy Domain: testytesterson.com\n    Successfully set environment variables in keyring!\n\n    Usage: gopappy [OPTIONS] COMMAND [ARGS]...\n    Try 'gopappy --help' for help.\n    \u256d\u2500 Error \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n    \u2502 Missing command.                                                                                          \u2502\n    \u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\n    ```\n* Add subcommand to manage `auth`\n  * CRUD\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "GoDaddy v1 API implementation with secured auth token.",
    "version": "1.8.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f01dd267238b0b503435cdba9bcfc6d8797503b9619f5da8de386dd9a1bd279a",
                "md5": "45b41b7ed9a2992c374f8ffc6cc7e8d1",
                "sha256": "fcc45779dd75644a91d07925ff23f9d0eaaf035678ec9871291a03823d0fbf5b"
            },
            "downloads": -1,
            "filename": "gopappy-1.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "45b41b7ed9a2992c374f8ffc6cc7e8d1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.11",
            "size": 7144,
            "upload_time": "2024-10-19T00:08:26",
            "upload_time_iso_8601": "2024-10-19T00:08:26.735912Z",
            "url": "https://files.pythonhosted.org/packages/f0/1d/d267238b0b503435cdba9bcfc6d8797503b9619f5da8de386dd9a1bd279a/gopappy-1.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "519e4836937dc0ef5d5512d1f12cd478c26b7cda1202a0c241c3bf9e8c3178a6",
                "md5": "7193042a7806b60bf366099e61b42e4c",
                "sha256": "cb1c98d3976135b2b5ac074f87653254dc24b14c7daed17768821755f6703865"
            },
            "downloads": -1,
            "filename": "gopappy-1.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7193042a7806b60bf366099e61b42e4c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.11",
            "size": 6421,
            "upload_time": "2024-10-19T00:08:28",
            "upload_time_iso_8601": "2024-10-19T00:08:28.317552Z",
            "url": "https://files.pythonhosted.org/packages/51/9e/4836937dc0ef5d5512d1f12cd478c26b7cda1202a0c241c3bf9e8c3178a6/gopappy-1.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-19 00:08:28",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "gopappy"
}
        
Elapsed time: 0.58982s