Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zachwill/dom
Check domain name availability from the command line.
https://github.com/zachwill/dom
Last synced: about 2 months ago
JSON representation
Check domain name availability from the command line.
- Host: GitHub
- URL: https://github.com/zachwill/dom
- Owner: zachwill
- Created: 2012-01-20T05:46:16.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-07-08T16:37:18.000Z (about 4 years ago)
- Last Synced: 2024-07-21T06:39:56.259Z (2 months ago)
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 214
- Watchers: 11
- Forks: 24
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
dom
===
An easy-to-use command line utility for checking domain name
availability using [Domainr's JSON API](https://rapidapi.com/domainr/api/domainr/).
Setup requires two things:
1. Installing dom
2. Obtaining an API key
Installation
------------
The simplest method is to install the package through `pip` by running:
pip install dom
Alternatively, you can install from source:
1. Clone the repo:
`$ git clone [email protected]:zachwill/dom.git`
`$ cd dom`
2. Run the following command to install:
`python setup.py install`
Get an API key for Domainr
--------------------------
Due to abuse of their API, Domainr now requires an API key for each user. This key can be obtained through one
of the following ways:
1. Get a Rapidapi Domainr API key from [Rapidapi](https://rapidapi.com/domainr/api/domainr/)
**Note:** While it is free up to 10,000 calls/mo., you are required to submit a valid credit card to cover
any requests over the free limit.
* 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.
2. Contact Domainr at `[email protected]` to get a personal use client ID, as detailed
[here](https://github.com/UltrosBot/Ultros-contrib/issues/29#issuecomment-135285713)
Once you have obtained one of the two types of keys, insert either the Rapidapi API key or the Client ID into your local environment:
```
$ export DOMAINR_RAPIDAPI_KEY={your-rapidapi-key}
```
or
```
$ export DOMAINR_CLIENT_ID={your-client-id}
```
You can do this manually everytime before running dom, or you can search for how to do this on login. Digital Ocean
has 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).
Note that in the event that both keys are present, dom will default to using the Rapidapi Key.
Optional Flags
--------------
The optional `--ascii` flag can be used to look up domain availability without
the use of the Unicode characters.
```
dom --ascii zachwill
X zachwill.com
A zachwill.net
A zachwill.org
A zachwill.co
X za.ch
X z.ac
```
The `--available` flag only shows domain names that are currently available:
```
dom --available zachwill
✓ zachwill.net
✓ zachwill.org
✓ zachwill.co
✓ zachwill.io
✓ zachwill.me
```
The `--no-suggest` flag only check the exact domain names that are in query:
```
dom --no-suggest zachwill.com
✗ zachwill.com
```
And, the `--tld` flag only shows top-level domains:
```
dom --tld zachwill
✗ zachwill.com
✓ zachwill.net
✓ zachwill.org
```
Deploying
---------
You won't need to worry about this, but since the Python `upload`
command is so obtuse, I'm going to keep it here:
python setup.py sdist bdist_egg upload