Metadata-Version: 2.4
Name: octodns-mythicbeasts
Version: 3.0.0
Summary: Mythic Beasts DNS provider for octoDNS
Author-email: Ross McFarland <rwmcfa1@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/octodns/octodns-mythicbeasts
Project-URL: Source, https://github.com/octodns/octodns-mythicbeasts
Project-URL: Issues, https://github.com/octodns/octodns-mythicbeasts/issues
Keywords: dns,octodns,dns-as-code
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: Name Service (DNS)
Classifier: Topic :: System :: Systems Administration
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: octodns>=1.5.0
Requires-Dist: requests>=2.27.0
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-network; extra == "test"
Requires-Dist: requests_mock; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-network; extra == "dev"
Requires-Dist: requests_mock; extra == "dev"
Requires-Dist: black<27.0.0,>=26.0.0; extra == "dev"
Requires-Dist: build>=0.7.0; extra == "dev"
Requires-Dist: changelet; extra == "dev"
Requires-Dist: isort>=5.11.5; extra == "dev"
Requires-Dist: proviso; extra == "dev"
Requires-Dist: pyflakes>=2.2.0; extra == "dev"
Requires-Dist: readme_renderer[md]>=26.0; extra == "dev"
Requires-Dist: twine>=3.4.2; extra == "dev"
Dynamic: license-file

## Mythic Beasts DNS provider for octoDNS

An [octoDNS](https://github.com/octodns/octodns/) provider that targets [Mythic Beasts DNS](https://www.mythic-beasts.com/support/hosting/dns).

### Installation

#### Command line

```
pip install octodns-mythicbeasts
```

#### requirements.txt/setup.py

Pinning specific versions or SHAs is recommended to avoid unplanned upgrades.

##### Versions

```
# Start with the latest versions and don't just copy what's here
octodns==0.21.1
octodns-mythicbeasts==2.0.0
```

##### SHAs

```
# Start with the latest/specific versions and don't just copy what's here
-e git+https://git@github.com/octodns/octodns.git@9da19749e28f68407a1c246dfdf65663cdc1c422#egg=octodns
-e git+https://git@github.com/octodns/octodns-mythicbeasts.git@ec9661f8b335241ae4746eea467a8509205e6a30#egg=octodns_mythicbeasts
```

### Configuration

```yaml
providers:
  mythicbeasts:
    class: octodns_mythicbeasts.MythicBeastsProvider
    api_key: env/MYTHICBEASTS_API_KEY
    api_secret: env/MYTHICBEASTS_API_SECRET
```

### Support Information

#### API Docs

Version 2.0.0+ targets the Mythic Beasts V2 API. Documentation can be found [here](https://www.mythic-beasts.com/support/api/dnsv2).

#### Records

MythicBeastsProvider supports A, AAAA, ALIAS, CNAME, MX, NS, SRV, SSHFP, CAA,TLSA, and TXT

#### Dynamic

MythicBeastsProvider does not support dynamic records.

### Development

See the [/script/](/script/) directory for some tools to help with the development process. They generally follow the [Script to rule them all](https://github.com/github/scripts-to-rule-them-all) pattern. Most useful is `./script/bootstrap` which will create a venv and install both the runtime and development related requirements. It will also hook up a pre-commit hook that covers most of what's run by CI.

Run the full test suite with `./script/cibuild`.

Don't forget to add a changelog entry with `./script/changelog create -t {major|minor|patch} "change description"`
