ddnsu


Nameddnsu JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryA dynamic DNS update client
upload_time2024-05-25 17:04:55
maintainerPhillippe Ang
docs_urlNone
authorPhillippe Ang
requires_python>=3.8
licenseCopyright (c) 2024 Phillippe Ang Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords ddns update client dynamic dns
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Dynamic DNS Updater
===================

[![version](https://img.shields.io/pypi/v/ddnsu?style=flat-square)][0]
![py](https://img.shields.io/pypi/pyversions/ddnsu?style=flat-square)
[![whl](https://img.shields.io/pypi/wheel/ddnsu?style=flat-square)][1]
[![license](https://img.shields.io/pypi/l/ddnsu?style=flat-square)][2]

DDNSU is a Python 3 script for updating dynamic DNS records. It can
keep track of your last known IP address and detect your current
one to determine if updating records is necessary. Currently, only
Namecheap's DDNS is supported.

## Installation

The recommended way to install `ddnsu` is to use [pip][3] and install
from PyPI:

```bash
python -m pip install ddnsu
```

You can also install from Wheel files available [here][4]:

```bash
python -m pip install './ddnsu-0.0.0.whl'
```

## Usage

Once installed, the `ddnsu` command should be available from the
command line. At minimum, the domain and hosts to be updated and the
DDNS password must be specified. This can be done via command line
options:

```bash
ddnsu --domain example.com --hosts www forum blog --pswd 1234
```

Alternatively, they can be specified in a JSON config file named
`ddnsu_config.json` placed in the working directory:

```json
{
    "schema": 1,
    "config": {
        "pswd": "1234",
        "domain": "example.com",
        "hosts": [
            "www",
            "forum",
            "blog"
        ]
    }
}
```

```bash
# `domain`, `hosts`, and `pswd` supplied by config file
ddnsu --log_level debug
```

All options except `--working_dir` and `--log_level` can be used in
the config file instead of the command line. If an option is used in
both the command line and the config file, the command line value
takes precedence.

## Contributing

Pull requests are welcome. For major changes, please [open an issue][5] first
to discuss what you would like to change.

## License

[MIT][2]


[0]: https://pypi.org/project/ddnsu/

[1]: https://pypi.org/project/ddnsu/#files

[2]: https://opensource.org/license/mit

[3]: https://pip.pypa.io/en/stable/

[4]: https://pypi.org/project/ddnsu/#files

[5]: https://github.com/phillippe/ddnsu/issues

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ddnsu",
    "maintainer": "Phillippe Ang",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "ddns, update, client, dynamic, dns",
    "author": "Phillippe Ang",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/d6/ed/22592cdd255a385a0b59d44e2a3d80a884923009416f02bcf210ba23e1c6/ddnsu-0.1.0.tar.gz",
    "platform": null,
    "description": "Dynamic DNS Updater\n===================\n\n[![version](https://img.shields.io/pypi/v/ddnsu?style=flat-square)][0]\n![py](https://img.shields.io/pypi/pyversions/ddnsu?style=flat-square)\n[![whl](https://img.shields.io/pypi/wheel/ddnsu?style=flat-square)][1]\n[![license](https://img.shields.io/pypi/l/ddnsu?style=flat-square)][2]\n\nDDNSU is a Python 3 script for updating dynamic DNS records. It can\nkeep track of your last known IP address and detect your current\none to determine if updating records is necessary. Currently, only\nNamecheap's DDNS is supported.\n\n## Installation\n\nThe recommended way to install `ddnsu` is to use [pip][3] and install\nfrom PyPI:\n\n```bash\npython -m pip install ddnsu\n```\n\nYou can also install from Wheel files available [here][4]:\n\n```bash\npython -m pip install './ddnsu-0.0.0.whl'\n```\n\n## Usage\n\nOnce installed, the `ddnsu` command should be available from the\ncommand line. At minimum, the domain and hosts to be updated and the\nDDNS password must be specified. This can be done via command line\noptions:\n\n```bash\nddnsu --domain example.com --hosts www forum blog --pswd 1234\n```\n\nAlternatively, they can be specified in a JSON config file named\n`ddnsu_config.json` placed in the working directory:\n\n```json\n{\n    \"schema\": 1,\n    \"config\": {\n        \"pswd\": \"1234\",\n        \"domain\": \"example.com\",\n        \"hosts\": [\n            \"www\",\n            \"forum\",\n            \"blog\"\n        ]\n    }\n}\n```\n\n```bash\n# `domain`, `hosts`, and `pswd` supplied by config file\nddnsu --log_level debug\n```\n\nAll options except `--working_dir` and `--log_level` can be used in\nthe config file instead of the command line. If an option is used in\nboth the command line and the config file, the command line value\ntakes precedence.\n\n## Contributing\n\nPull requests are welcome. For major changes, please [open an issue][5] first\nto discuss what you would like to change.\n\n## License\n\n[MIT][2]\n\n\n[0]: https://pypi.org/project/ddnsu/\n\n[1]: https://pypi.org/project/ddnsu/#files\n\n[2]: https://opensource.org/license/mit\n\n[3]: https://pip.pypa.io/en/stable/\n\n[4]: https://pypi.org/project/ddnsu/#files\n\n[5]: https://github.com/phillippe/ddnsu/issues\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2024 Phillippe Ang  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A dynamic DNS update client",
    "version": "0.1.0",
    "project_urls": {
        "Changelog": "https://github.com/phillippe/ddnsu/blob/main/CHANGELOG.md",
        "Documentation": "https://pypi.org/project/ddnsu/",
        "Homepage": "https://pypi.org/project/ddnsu/",
        "Issues": "https://github.com/phillippe/ddnsu/issues",
        "Repository": "https://github.com/phillippe/ddnsu.git"
    },
    "split_keywords": [
        "ddns",
        " update",
        " client",
        " dynamic",
        " dns"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "afe8020c47ca76aa6143520c63e298090a7fc2227da3ca95782d909773ce2398",
                "md5": "be17c228ff8090572e519c9f51fe7bbd",
                "sha256": "4036770e3cb32f40acb49238882a175b713f9254d5dc4ec9ac1f07cff77531d6"
            },
            "downloads": -1,
            "filename": "ddnsu-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "be17c228ff8090572e519c9f51fe7bbd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7076,
            "upload_time": "2024-05-25T17:04:54",
            "upload_time_iso_8601": "2024-05-25T17:04:54.436182Z",
            "url": "https://files.pythonhosted.org/packages/af/e8/020c47ca76aa6143520c63e298090a7fc2227da3ca95782d909773ce2398/ddnsu-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d6ed22592cdd255a385a0b59d44e2a3d80a884923009416f02bcf210ba23e1c6",
                "md5": "688f3acd7e69e9fa666f0a1fb2913e5e",
                "sha256": "e6840f74f1a68606f0126e42d50d80c0487016bb05f7b2832dbdae8b920a960a"
            },
            "downloads": -1,
            "filename": "ddnsu-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "688f3acd7e69e9fa666f0a1fb2913e5e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6790,
            "upload_time": "2024-05-25T17:04:55",
            "upload_time_iso_8601": "2024-05-25T17:04:55.981346Z",
            "url": "https://files.pythonhosted.org/packages/d6/ed/22592cdd255a385a0b59d44e2a3d80a884923009416f02bcf210ba23e1c6/ddnsu-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-25 17:04:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "phillippe",
    "github_project": "ddnsu",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ddnsu"
}
        
Elapsed time: 0.28693s