XN Twist

https://img.shields.io/pypi/v/xn-twist.svg https://travis-ci.org/xn-twist/xn-twist.svg?branch=master https://codecov.io/gh/xn-twist/xn-twist/branch/master/graph/badge.svg Codacy Badge Documentation Status Updates

Find Unicode domain squats

Installation

Stable release

To install XN Twist, run this command in your terminal:

pip install xn-twist

This is the preferred method to install XN Twist, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for XN Twist can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/xn-twist/xn-twist

Or download the tarball:

$ curl  -OL https://github.com/xn-twist/xn-twist/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

Via Python

You can use XN-Twist in a script as follows:

from xn_twist.xn_twist import XNTwist
xn = XNTwist()
domain_twist_results = xn.twist("example.com")

Via Command Line

You can use XN-Twist from the command line as follows:

xntwist example.com

The usage for the command line form of XN-Twist is as follows:

Run Tests

After cloning the repo, you can test it using the following commands from the base directory of this repository:

make test

Data, Data, Everywhere...

This project relies on a dataset. More details on how to access the dataset and even how to help us build it coming soon!

Credits

This package was created with Cookiecutter and the fhightower/python-project-template project template.