{"id":13448156,"url":"https://github.com/zachwill/dom","last_synced_at":"2025-03-22T08:31:43.619Z","repository":{"id":2267841,"uuid":"3224151","full_name":"zachwill/dom","owner":"zachwill","description":"Check domain name availability from the command line.","archived":false,"fork":false,"pushed_at":"2020-07-08T16:37:18.000Z","size":35,"stargazers_count":214,"open_issues_count":4,"forks_count":24,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-09-20T08:34:59.982Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zachwill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-01-20T05:46:16.000Z","updated_at":"2024-04-17T14:52:02.000Z","dependencies_parsed_at":"2022-08-29T22:52:09.685Z","dependency_job_id":null,"html_url":"https://github.com/zachwill/dom","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachwill%2Fdom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachwill%2Fdom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachwill%2Fdom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachwill%2Fdom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zachwill","download_url":"https://codeload.github.com/zachwill/dom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221826272,"owners_count":16887130,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T05:01:37.211Z","updated_at":"2024-10-28T12:30:23.068Z","avatar_url":"https://github.com/zachwill.png","language":"Python","readme":"dom\n===\n\nAn easy-to-use command line utility for checking domain name\navailability using [Domainr's JSON API](https://rapidapi.com/domainr/api/domainr/).\n\n\n![Example of dom in action](http://i.imgur.com/oijaG.png)\n\nSetup requires two things:\n\n1. Installing dom\n2. Obtaining an API key\n\n\nInstallation\n------------\n\nThe simplest method is to install the package through `pip` by running:\n\n    pip install dom\n\nAlternatively, you can install from source:\n\n1. Clone the repo:\n\n    `$ git clone git@github.com:zachwill/dom.git`  \n    `$ cd dom`\n\n2. Run the following command to install:\n\t`python setup.py install`\n\n\nGet an API key for Domainr\n--------------------------\n\nDue to abuse of their API, Domainr now requires an API key for each user. This key can be obtained through one\nof the following ways:\n\n1. Get a Rapidapi Domainr API key from [Rapidapi](https://rapidapi.com/domainr/api/domainr/)\n    **Note:** While it is free up to 10,000 calls/mo., you are required to submit a valid credit card to cover \n    any requests over the free limit.\n    * You can use something like [Privacy.com](https://privacy.com/) to create a credit temporary card. I've been told that some banks offer a similar feature as well.\n2. Contact Domainr at `partners@domainr.com` to get a personal use client ID, as detailed \n   [here](https://github.com/UltrosBot/Ultros-contrib/issues/29#issuecomment-135285713)\n\nOnce you have obtained one of the two types of keys, insert either the Rapidapi API key or the Client ID into your local environment:\n```\n$ export DOMAINR_RAPIDAPI_KEY={your-rapidapi-key}\n```\nor\n```\n$ export DOMAINR_CLIENT_ID={your-client-id}\n```\n\nYou can do this manually everytime before running dom, or you can search for how to do this on login. Digital Ocean\nhas an excellent guide here: [How To Read and Set Environmental and Shell Variables on a Linux VPS](https://www.digitalocean.com/community/tutorials/how-to-read-and-set-environmental-and-shell-variables-on-a-linux-vps).\n\nNote that in the event that both keys are present, dom will default to using the Rapidapi Key.\n\n\nOptional Flags\n--------------\n\nThe optional `--ascii` flag can be used to look up domain availability without\nthe use of the Unicode characters.\n\n```\ndom --ascii zachwill\n\nX  zachwill.com\nA  zachwill.net\nA  zachwill.org\nA  zachwill.co\nX  za.ch\nX  z.ac\n```\n\nThe `--available` flag only shows domain names that are currently available:\n\n```\ndom --available zachwill\n\n✓  zachwill.net\n✓  zachwill.org\n✓  zachwill.co\n✓  zachwill.io\n✓  zachwill.me\n```\n\nThe `--no-suggest` flag only check the exact domain names that are in query:\n\n```\ndom --no-suggest zachwill.com\n\n✗  zachwill.com\n```\n\nAnd, the `--tld` flag only shows top-level domains:\n\n```\ndom --tld zachwill\n\n✗  zachwill.com\n✓  zachwill.net\n✓  zachwill.org\n```\n\n\nDeploying\n---------\n\nYou won't need to worry about this, but since the Python `upload`\ncommand is so obtuse, I'm going to keep it here:\n\n    python setup.py sdist bdist_egg upload\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzachwill%2Fdom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzachwill%2Fdom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzachwill%2Fdom/lists"}