PrivyDNS 0.1.2

A Python library for secure DNS resolution (DoH, DoT, mTLS) with sync & async support.

PrivyDNS

PrivyDNS is a Python library designed to securely query DNS records over encrypted protocols including DNS over HTTPS (DoH), DNS over TLS (DoT), DNS over Mutual TLS (mTLS), and DNSCrypt. It supports both synchronous and asynchronous DNS queries with features such as caching, retry mechanisms, logging, and encryption. It provides developers with an easy-to-use interface to enhance DNS security, reliability, and performance.

Features

• Protocols Supported:
  • DNS over HTTPS (DoH)
  • DNS over TLS (DoT)
  • DNS over Mutual TLS (mTLS)
  • DNSCrypt
• Cache Support: Caches DNS responses to improve performance.
• Retry Mechanism: Automatically retries failed DNS queries.
• Logging: Provides detailed logs for better debugging.
• Async & Sync Support: Supports both asynchronous and synchronous operations.

Architecture

You can learn more about the architecture, protocols, and features of PrivyDNS in the ARCHITECTURE.md file.

Background

For an in-depth explanation of DNS over HTTPS (DoH), DNS over TLS (DoT), and DNSCrypt, refer to the BACKGROUND.md file.

Installation

pip install privydns

Usage

DNS Query

import asyncio
from privydns import DNSResolver

async def main():
    resolver = DNSResolver()
    response = await resolver.query("example.com", protocol="doh")
    print(response)

asyncio.run(main())

DNSCrypt Query

from privydns import DNSCryptResolver

crypt_resolver = DNSCryptResolver()
response = crypt_resolver.query("example.com")
print(response)

Testing

To run the tests, install the required packages and run the following command:

pip install -r requirements.txt
pytest .

Running Tests in Docker 🐳

This project includes a Dockerfile and docker-compose.yml file to run the tests inside a Docker container. It was build to mimic the GitHub Actions workflow.

To build the Docker image, run the following command:

docker compose build

To run the tests inside the Docker container, execute the following command:

docker compose up

Publishing to PyPI

To publish this project to PyPI, follow these steps:

1. Install Required Tools Ensure you have the latest versions of setuptools, wheel, and twine installed.

   pip install --upgrade setuptools wheel twine build
   

2. Build the Distribution Files Run the following command to build the source distribution (.tar.gz) and the wheel distribution (.whl).

   python -m build
   

   The distribution files will be available in the dist directory.

3. Upload to Test PyPI (Optional) Before uploading to the official PyPI, you can test the package on Test PyPI:

   twine upload --repository testpypi dist/*
   

   You can verify your package at the Test PyPI URL (https://test.pypi.org/project/your-package-name).

4. Upload to PyPI If everything looks good, upload the package to the official PyPI repository:

   twine upload dist/*
   

   Make sure you have your PyPI credentials ready—refer to the PyPI website documentation if needed.

5. Verify the Package After publishing, verify that your package is listed on PyPI. You can install it like any other package to confirm the installation is working:

   pip install privydns
   

6. Important Notes:

   • Ensure the setup.py file has all required metadata filled in (e.g., name, version, author, description, etc.).
   • Keep the version number updated for every new release.

License

This project is licensed under the MIT License—see the LICENSE file for details.