# SUD
 [](https://pypi.org/project/sud/) [](https://github.com/ffaraone/sud/actions/workflows/test.yml) [](https://sonarcloud.io/dashboard?id=sud) [](https://sonarcloud.io/dashboard?id=sud) [](https://sonarcloud.io/dashboard?id=sud)
> Sud, Sud nuie simme r'o Sud,
> nuie simme curt' e nire,
> nuie simme buone pe' canta
> e faticamm' a faticà
>
> [(Pietra Motecorvino)](https://en.wikipedia.org/wiki/Pietra_Montecorvino)
`SUD` (Scaleway Update Dns) is a small utility to add/update an "A" record in a DNS zone
managed by [Scaleway](https://scaleway.com).
## Install via Pip
```bash
$ pip install sud
```
## Configure
By default SUD search for a configuration file in `/etc/sud/sud-config.yml`.
A minimal configuration file need the hostname you want to add/update and
the API secret needed to talk with the Scaleway API like in the following example:
```yaml
hostname: myname.mydomain.com
api_secret: 1279bde5-150f-4113-ba37-c4c58e1dfece
```
It is possible to change the frequency with which SUD checks if an IP change has occurred
as well as receiving a telegram notification with the new IP address:
```yaml
hostname: myname.mydomain.com
api_secret: 1279bde5-150f-4113-ba37-c4c58e1dfece
frequency: 600 # each 10 minutes
notifications:
telegram:
token: 0987654321:tdCkfKaJooaIWMvebbKYeliLfLhlhvpKAB
chat_id: -1234567890
```
## Run
To run sud just type:
```bash
$ sud run
```
if you want to place your config file somewhere else you can use:
```bash
$ sud -c /path/to/config.yml run
```
## Help
You can get help just typing:
```bash
$ sud --help
```
## License
`SUD` is released under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
Raw data
{
"_id": null,
"home_page": "https://github.com/ffaraone/sud",
"name": "sud",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4",
"maintainer_email": "",
"keywords": "sud,scaleway,dns,dynamic,dynamicdns",
"author": "Francesco Faraone",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/11/36/65c496a30251903e60efa77addcdbae0be2d1142fcc0b8bacad39e26fbdf/sud-0.3.0.tar.gz",
"platform": null,
"description": "# SUD\n\n [](https://pypi.org/project/sud/) [](https://github.com/ffaraone/sud/actions/workflows/test.yml) [](https://sonarcloud.io/dashboard?id=sud) [](https://sonarcloud.io/dashboard?id=sud) [](https://sonarcloud.io/dashboard?id=sud)\n\n\n > Sud, Sud nuie simme r'o Sud, \n > nuie simme curt' e nire, \n > nuie simme buone pe' canta \n > e faticamm' a fatic\u00e0 \n > \n > [(Pietra Motecorvino)](https://en.wikipedia.org/wiki/Pietra_Montecorvino)\n\n\n`SUD` (Scaleway Update Dns) is a small utility to add/update an \"A\" record in a DNS zone\nmanaged by [Scaleway](https://scaleway.com).\n\n\n## Install via Pip\n\n\n```bash\n$ pip install sud\n```\n\n## Configure\n\nBy default SUD search for a configuration file in `/etc/sud/sud-config.yml`.\n\nA minimal configuration file need the hostname you want to add/update and\nthe API secret needed to talk with the Scaleway API like in the following example:\n\n```yaml\nhostname: myname.mydomain.com\napi_secret: 1279bde5-150f-4113-ba37-c4c58e1dfece\n```\n\nIt is possible to change the frequency with which SUD checks if an IP change has occurred\nas well as receiving a telegram notification with the new IP address:\n\n\n```yaml\nhostname: myname.mydomain.com\napi_secret: 1279bde5-150f-4113-ba37-c4c58e1dfece\nfrequency: 600 # each 10 minutes\nnotifications:\n telegram:\n token: 0987654321:tdCkfKaJooaIWMvebbKYeliLfLhlhvpKAB\n chat_id: -1234567890\n```\n\n## Run\n\nTo run sud just type:\n\n```bash\n$ sud run\n```\n\nif you want to place your config file somewhere else you can use:\n\n```bash\n$ sud -c /path/to/config.yml run\n```\n\n## Help\n\nYou can get help just typing:\n\n```bash\n$ sud --help\n```\n\n## License\n\n`SUD` is released under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Scaleway Update DNS",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://github.com/ffaraone/sud",
"Homepage": "https://github.com/ffaraone/sud",
"Repository": "https://github.com/ffaraone/sud"
},
"split_keywords": [
"sud",
"scaleway",
"dns",
"dynamic",
"dynamicdns"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91bf07ed72b836265734e37804e05cd2ff6616c30577c08e6b40b098b55b96ad",
"md5": "0b569102ff377eb43d23692e43cc4533",
"sha256": "01d058ac56a73d65d3e152d79d234ddfd9958b472494077c6e591112349bb975"
},
"downloads": -1,
"filename": "sud-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b569102ff377eb43d23692e43cc4533",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4",
"size": 12887,
"upload_time": "2024-02-28T23:28:08",
"upload_time_iso_8601": "2024-02-28T23:28:08.385255Z",
"url": "https://files.pythonhosted.org/packages/91/bf/07ed72b836265734e37804e05cd2ff6616c30577c08e6b40b098b55b96ad/sud-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "113665c496a30251903e60efa77addcdbae0be2d1142fcc0b8bacad39e26fbdf",
"md5": "8819f5768e2d39c0e891cf9ad9d6a10b",
"sha256": "a8c1ce47b5685f4523b6105c771f9f4c93be720eab189e1e009c9776a98e960c"
},
"downloads": -1,
"filename": "sud-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8819f5768e2d39c0e891cf9ad9d6a10b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4",
"size": 12328,
"upload_time": "2024-02-28T23:28:09",
"upload_time_iso_8601": "2024-02-28T23:28:09.828707Z",
"url": "https://files.pythonhosted.org/packages/11/36/65c496a30251903e60efa77addcdbae0be2d1142fcc0b8bacad39e26fbdf/sud-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-28 23:28:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ffaraone",
"github_project": "sud",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sud"
}
JSON
