# CZDS
[][pypi status]
[][pypi status]
[][pypi status]
[][license]
[][read the docs]
[](https://github.com/MSAdministrator/czds/actions/workflows/tests.yml)
[][codecov]
[][pre-commit]
[][black]
[pypi status]: https://pypi.org/project/czds/
[read the docs]: https://czds.readthedocs.io/
[tests]: https://github.com/MSAdministrator/czds/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/MSAdministrator/czds
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
## What is CZDS?
Each Top Level Domain (TLD) is maintained by a registry operator, who also manages a publicly available list of Second Level Domains (SLDs) and the details needed to resolve those domain names to Internet Protocol (IP) addresses.
The registry operator’s zone data contains the mapping of domain names, associated name server names, and IP addresses for those name servers. These details are updated by the registry operator for its respective TLDs whenever information changes or a domain name is added or removed.
Each registry operator keeps its zone data in a text file called the Zone File which is updated once every 24 hours.
## Features
- Retrieve Centralized Zone Transfer Files from root DNS servers hosted by ICAAN and other agencies
- Download one or all of the zone files and return data in multiple formats; text, json or a file (default)
- You can now retrieve zone files using multi-threading
## Roadmap
The following are some of the features I am planning on adding but would love to hear everyones thoughts as well.
- Add ability to search based on domain and/or TLD
- This may include using algorithms like Levenshtein distance, confusables/idna characters, etc.
- Add ability to derive differences between zone files over time
- Add ability to retrieve other contextual external information like WHOIS
- Add ability to save/store data into a database
## Requirements
- You need a CZDS account with ICAAN. You can sign-up [here](https://czds.icann.org)
- Internet access
## Installation
You can install _CZDS_ via [pip] from [PyPI]:
```console
$ pip install czds
```
If you are using `poetry` (recommended) you can add it to your package using
```console
poetry add czds
```
## Usage
Below is the command line reference but you can also use the current version of czds to retrieve the help by typing ```czds --help```.
```console
NAME
czds - Main class for ICAAN CZDS.
SYNOPSIS
czds GROUP | VALUE | --username=USERNAME --password=PASSWORD --save_directory=SAVE_DIRECTORY
DESCRIPTION
Main class for ICAAN CZDS.
ARGUMENTS
USERNAME
Type: ~AnyStr
PASSWORD
Type: ~AnyStr
SAVE_DIRECTORY
Type: ~AnyStr
GROUPS
GROUP is one of the following:
BASE_HEADERS
links
VALUES
VALUE is one of the following:
AUTH_URL
BASE_URL
OUTPUT_FORMAT
PASSWORD
SAVE_PATH
THREAD_COUNT
USERNAME
connection
```
## Contributing
Contributions are very welcome.
To learn more, see the [Contributor Guide](CONTRIBUTING.md).
## Developmemt
You can clone the repositry and begin development using
```bash
git clone https://github.com/MSAdministrator/czds.git
cd czds
poetry install
```
If you are using `pyenv` to manage your enviroments you can set a config option in poetry to use the set pyenv version of python by running this:
```bash
poetry config virtualenvs.prefer-active-python true
poetry install
```
## License
Distributed under the terms of the [MIT license][LICENSE.md],
_CZDS_ is free and open source software.
## Security
Security concerns are a top priority for us, please review our [Security Policy](SECURITY.md).
## Issues
If you encounter any problems,
please [file an issue](https://github.com/MSAdministrator/czds/issues/new) along with a detailed description.
## Credits
This project was generated from [@MSAdministrator]'s [Hypermodern Python Cookiecutter] template.
[@MSAdministrator]: https://github.com/MSAdministrator
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/MSAdministrator/czds/issues
[pip]: https://pip.pypa.io/
<!-- github-only -->
[license]: https://github.com/MSAdministrator/czds/blob/main/LICENSE
[contributor guide]: https://github.com/MSAdministrator/czds/blob/main/CONTRIBUTING.md
[command-line reference]: https://czds.readthedocs.io/en/latest/usage.html
Raw data
{
"_id": null,
"home_page": "https://github.com/MSAdministrator/czds",
"name": "czds",
"maintainer": "Josh Rickard",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "rickardja@live.com",
"keywords": "ICAAN,CZDS,DNS,Security",
"author": "Josh Rickard",
"author_email": "rickardja@live.com",
"download_url": "https://files.pythonhosted.org/packages/0f/7e/a272d7bf67059b5b3fc248e044b6519df569a1521d5e6b956604715193da/czds-0.1.1.tar.gz",
"platform": null,
"description": "# CZDS\n\n[][pypi status]\n[][pypi status]\n[][pypi status]\n[][license]\n\n[][read the docs]\n[](https://github.com/MSAdministrator/czds/actions/workflows/tests.yml)\n\n[][codecov]\n\n[][pre-commit]\n[][black]\n\n[pypi status]: https://pypi.org/project/czds/\n[read the docs]: https://czds.readthedocs.io/\n[tests]: https://github.com/MSAdministrator/czds/actions?workflow=Tests\n[codecov]: https://app.codecov.io/gh/MSAdministrator/czds\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n\n## What is CZDS?\n\nEach Top Level Domain (TLD) is maintained by a registry operator, who also manages a publicly available list of Second Level Domains (SLDs) and the details needed to resolve those domain names to Internet Protocol (IP) addresses.\n\nThe registry operator\u2019s zone data contains the mapping of domain names, associated name server names, and IP addresses for those name servers. These details are updated by the registry operator for its respective TLDs whenever information changes or a domain name is added or removed.\n\nEach registry operator keeps its zone data in a text file called the Zone File which is updated once every 24 hours.\n\n## Features\n\n- Retrieve Centralized Zone Transfer Files from root DNS servers hosted by ICAAN and other agencies\n- Download one or all of the zone files and return data in multiple formats; text, json or a file (default)\n- You can now retrieve zone files using multi-threading\n\n## Roadmap\n\nThe following are some of the features I am planning on adding but would love to hear everyones thoughts as well.\n\n- Add ability to search based on domain and/or TLD\n - This may include using algorithms like Levenshtein distance, confusables/idna characters, etc.\n- Add ability to derive differences between zone files over time\n- Add ability to retrieve other contextual external information like WHOIS\n- Add ability to save/store data into a database\n\n## Requirements\n\n- You need a CZDS account with ICAAN. You can sign-up [here](https://czds.icann.org)\n- Internet access\n\n## Installation\n\nYou can install _CZDS_ via [pip] from [PyPI]:\n\n```console\n$ pip install czds\n```\n\nIf you are using `poetry` (recommended) you can add it to your package using\n\n```console\npoetry add czds\n```\n\n\n## Usage\n\nBelow is the command line reference but you can also use the current version of czds to retrieve the help by typing ```czds --help```.\n\n```console\nNAME\n czds - Main class for ICAAN CZDS.\n\nSYNOPSIS\n czds GROUP | VALUE | --username=USERNAME --password=PASSWORD --save_directory=SAVE_DIRECTORY\n\nDESCRIPTION\n Main class for ICAAN CZDS.\n\nARGUMENTS\n USERNAME\n Type: ~AnyStr\n PASSWORD\n Type: ~AnyStr\n SAVE_DIRECTORY\n Type: ~AnyStr\n\nGROUPS\n GROUP is one of the following:\n\n BASE_HEADERS\n\n links\n\nVALUES\n VALUE is one of the following:\n\n AUTH_URL\n\n BASE_URL\n\n OUTPUT_FORMAT\n\n PASSWORD\n\n SAVE_PATH\n\n THREAD_COUNT\n\n USERNAME\n\n connection\n```\n\n## Contributing\n\nContributions are very welcome.\nTo learn more, see the [Contributor Guide](CONTRIBUTING.md).\n\n## Developmemt\n\nYou can clone the repositry and begin development using\n\n```bash\ngit clone https://github.com/MSAdministrator/czds.git\ncd czds\npoetry install\n```\n\nIf you are using `pyenv` to manage your enviroments you can set a config option in poetry to use the set pyenv version of python by running this:\n\n```bash\npoetry config virtualenvs.prefer-active-python true\npoetry install\n```\n## License\n\nDistributed under the terms of the [MIT license][LICENSE.md],\n_CZDS_ is free and open source software.\n\n## Security\n\nSecurity concerns are a top priority for us, please review our [Security Policy](SECURITY.md).\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue](https://github.com/MSAdministrator/czds/issues/new) along with a detailed description.\n\n## Credits\n\nThis project was generated from [@MSAdministrator]'s [Hypermodern Python Cookiecutter] template.\n\n[@MSAdministrator]: https://github.com/MSAdministrator\n[pypi]: https://pypi.org/\n[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n[file an issue]: https://github.com/MSAdministrator/czds/issues\n[pip]: https://pip.pypa.io/\n\n<!-- github-only -->\n\n[license]: https://github.com/MSAdministrator/czds/blob/main/LICENSE\n[contributor guide]: https://github.com/MSAdministrator/czds/blob/main/CONTRIBUTING.md\n[command-line reference]: https://czds.readthedocs.io/en/latest/usage.html\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CZDS",
"version": "0.1.1",
"split_keywords": [
"icaan",
"czds",
"dns",
"security"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "127e2f0183aa838e43764327cfd7d2a50c55cae92e4de8147b0d902e9b28b307",
"md5": "fbe73005ed97d9ffb7bad74354cc88bd",
"sha256": "0243d12a82ea579ee325b9d57913113c9e4202d36537c41a36aa1c53f774de83"
},
"downloads": -1,
"filename": "czds-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fbe73005ed97d9ffb7bad74354cc88bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 15546,
"upload_time": "2023-02-10T22:26:53",
"upload_time_iso_8601": "2023-02-10T22:26:53.851029Z",
"url": "https://files.pythonhosted.org/packages/12/7e/2f0183aa838e43764327cfd7d2a50c55cae92e4de8147b0d902e9b28b307/czds-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f7ea272d7bf67059b5b3fc248e044b6519df569a1521d5e6b956604715193da",
"md5": "69b35e5f63a8f2360c88a929496aa360",
"sha256": "fdc28c0ed04fb60cc542290702592f8a74af7ac5d27a2c8fb10d3f98b5fff770"
},
"downloads": -1,
"filename": "czds-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "69b35e5f63a8f2360c88a929496aa360",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 15586,
"upload_time": "2023-02-10T22:26:55",
"upload_time_iso_8601": "2023-02-10T22:26:55.860262Z",
"url": "https://files.pythonhosted.org/packages/0f/7e/a272d7bf67059b5b3fc248e044b6519df569a1521d5e6b956604715193da/czds-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-10 22:26:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "MSAdministrator",
"github_project": "czds",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "czds"
}
JSON
