Metadata-Version: 2.1
Name: designate
Version: 22.1.0
Summary: DNS as a Service
Author-email: OpenStack <openstack-discuss@lists.openstack.org>
License: Apache-2.0
Project-URL: Bug Tracker, https://bugs.launchpad.net/designate/
Project-URL: Documentation, https://docs.openstack.org/designate/latest/
Project-URL: Source Code, https://opendev.org/openstack/designate
Classifier: Environment :: OpenStack
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
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: Topic :: Internet :: Name Service (DNS)
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: alembic >=1.8.0
Requires-Dist: Flask !=0.11,>=0.10
Requires-Dist: Jinja2 >=2.10
Requires-Dist: jsonschema >=3.2.0
Requires-Dist: keystoneauth1 >=3.4.0
Requires-Dist: keystonemiddleware >=4.17.0
Requires-Dist: openstacksdk >=0.103.0
Requires-Dist: oslo.config >=6.8.0
Requires-Dist: oslo.concurrency >=4.2.0
Requires-Dist: oslo.messaging >=14.1.0
Requires-Dist: oslo.middleware >=3.31.0
Requires-Dist: oslo.log >=4.3.0
Requires-Dist: oslo.reports >=1.18.0
Requires-Dist: oslo.rootwrap >=5.15.0
Requires-Dist: oslo.serialization >=2.25.0
Requires-Dist: oslo.service[threading] >=4.2.0
Requires-Dist: oslo.upgradecheck >=1.3.0
Requires-Dist: oslo.utils >=4.7.0
Requires-Dist: oslo.versionedobjects >=1.31.2
Requires-Dist: osprofiler >=3.4.0
Requires-Dist: Paste >=2.0.2
Requires-Dist: PasteDeploy >=1.5.0
Requires-Dist: pbr >=3.1.1
Requires-Dist: pecan !=1.0.2,!=1.0.3,!=1.0.4,!=1.2,>=1.0.0
Requires-Dist: python-designateclient >=2.12.0
Requires-Dist: requests >=2.23.0
Requires-Dist: tenacity >=6.0.0
Requires-Dist: SQLAlchemy >=1.4.41
Requires-Dist: stevedore >=1.20.0
Requires-Dist: WebOb >=1.7.1
Requires-Dist: dnspython >=2.2.1
Requires-Dist: oslo.db >=8.3.0
Requires-Dist: oslo.i18n >=3.20.0
Requires-Dist: oslo.context >=4.0.0
Requires-Dist: oslo.policy >=4.5.0
Requires-Dist: tooz >=1.58.0
Requires-Dist: futurist >=1.2.0
Provides-Extra: edgegrid
Requires-Dist: edgegrid-python >=1.1.1 ; extra == 'edgegrid'
Provides-Extra: infoblox
Requires-Dist: infoblox-client >=0.6.0 ; extra == 'infoblox'

===================
OpenStack Designate
===================

.. image:: https://governance.openstack.org/tc/badges/designate.svg

.. Change things from this point on

Designate is an OpenStack project, providing DNSaaS.

IRC: #openstack-dns @ oftc

Installation: https://docs.openstack.org/designate/latest/

API
---

To learn how to use Designate's API, consult the documentation available
online at:

- `DNS API Reference <https://docs.openstack.org/api-ref/dns/>`__

For more information on OpenStack APIs, SDKs and CLIs in general, refer to:

- `OpenStack for App Developers <https://www.openstack.org/appdev/>`__
- `Development resources for OpenStack clouds
  <https://developer.openstack.org/>`__

Development
===========

Designate follows the `OpenStack Gerrit Workflow`_

Setup
-----

Setup a working environment:

.. code-block:: bash

    git clone https://opendev.org/openstack/designate
    cd designate
    virtualenv .venv
    . .venv/bin/activate
    pip install -r requirements.txt -r test-requirements.txt
    pip install -e .

Building Docs
-------------

To build the documentation from the restructured text source, do the following:

.. code-block:: bash

    tox -e docs

Now point your browser at doc/build/html/index.html
(the official documentation is published to `docs.openstack.org`_  by the
maintainers.

Testing
-------

Execute all unit tests

.. code-block:: shell

    tox -e py3

Execute only backend tests

.. code-block:: shell

    tox -e py3 -- unit.backend

Execute only a single test

.. code-block:: shell

    tox -e py3 -- unit.backend.test_pdns4.PDNS4BackendTestCase.test_create_zone_success

Contributing
------------

Install the git-review package to make life easier

.. code-block:: shell

    pip install git-review

Branch, work, & submit:

.. code-block:: shell

    # cut a new branch, tracking master
    git checkout --track -b bug/id origin/master
    # work work work
    git add stuff
    git commit
    # rebase/squash to a single commit before submitting
    git rebase -i
    # submit
    git-review

Other Information
-----------------

* Free software: Apache license
* Documentation: https://docs.openstack.org/designate/latest/
* Release notes: https://docs.openstack.org/releasenotes/designate/
* Source: https://opendev.org/openstack/designate
* Bugs: https://bugs.launchpad.net/designate
* Blueprints: https://blueprints.launchpad.net/designate

.. _OpenStack Gerrit Workflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _docs.openstack.org: https://docs.openstack.org/designate/latest/
