Merge pull request #3 from iAbdullahMughal/testpypi_r1

Added project on pip

.gitignore

@@ -129,3 +129,5 @@ dmypy.json
 .pyre/
 
 .idea/
+
+.pypirc

README.md

@@ -18,32 +18,39 @@ Starting a simple project around information gathering related to domain / url /
 for educational means, so what is in this project right now ...
 
 ## ✨ Highlights
+
 ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
 ![PyCharm](https://img.shields.io/badge/pycharm-143?style=for-the-badge&logo=pycharm&logoColor=black&color=black&labelColor=green)
 
-Read Docs 
-
-- https://readthedocs.org/projects/domain-trails/
-- https://iabdullahmughal.github.io/domain-trails/
-
+### Work completed
 
 Following services are supported
 
 - ☑️ Domain Availability Check
 - 📜 Domain Hosting History (based on dns)
 - 📇️Domain DNS Information
 
+### Work in progress
 
-Work in progress 
 - 🔄 Whois information (include history)
 - 🔄 Web Technologies
 - 🔄 Information over internet
 
+## 🔽 Download and Install
+
+The recommended way to download and install/update the latest stable release of oletools is to use pip:
+
+- On Linux/Mac: ``sudo -H pip install -U domaintrails``
+- On Windows: ``pip install -U domaintrails``
+
+
 ## 📋 Output
+
 Following console output
-````commandline
-$ portal.py -d www.king.com
--------------------------------------------------------------------------------
+
+````shell
+$ domaintrails -d www.king.com
+  -------------------------------------------------------------------------------
       ____                            _           ______              _  __     
      / __ \ ____   ____ ___   ____ _ (_)____     /_  __/_____ ____ _ (_)/ /_____
     / / / // __ \ / __ `__ \ / __ `// // __ \     / /  / ___// __ `// // // ___/
@@ -121,5 +128,7 @@ king.com.  TXT   IN     86254  "v=spf1 include:spf1.king.com include:spf2.king.c
 
 ## Documentation
 
+You can find documents on following links
 
-### 🚧 Learning, searching, coding and hunting in progress ... 
+- https://readthedocs.org/projects/domain-trails/
+- https://iabdullahmughal.github.io/domain-trails/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,33 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../../'))
+
+project = 'Domain Trails'
+copyright = '2021, iAbdullahMughal'
+author = 'iAbdullahMughal'
+release = '1.0.0'
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+    'm2r2',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+autosummary_generate = True
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+source_suffix = ['.rst', '.md']

docs/source/domaintrails.core.parser.rst

@@ -0,0 +1,21 @@
+domaintrails.core.parser package
+================================
+
+Submodules
+----------
+
+domaintrails.core.parser.html\_parser module
+--------------------------------------------
+
+.. automodule:: domaintrails.core.parser.html_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: domaintrails.core.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/domaintrails.core.recon.rst

@@ -0,0 +1,37 @@
+domaintrails.core.recon package
+===============================
+
+Submodules
+----------
+
+domaintrails.core.recon.dns\_history module
+-------------------------------------------
+
+.. automodule:: domaintrails.core.recon.dns_history
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+domaintrails.core.recon.dnslg module
+------------------------------------
+
+.. automodule:: domaintrails.core.recon.dnslg
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+domaintrails.core.recon.domain\_available module
+------------------------------------------------
+
+.. automodule:: domaintrails.core.recon.domain_available
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: domaintrails.core.recon
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/domaintrails.core.rst

@@ -0,0 +1,30 @@
+domaintrails.core package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   domaintrails.core.parser
+   domaintrails.core.recon
+
+Submodules
+----------
+
+domaintrails.core.resources module
+----------------------------------
+
+.. automodule:: domaintrails.core.resources
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: domaintrails.core
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/domaintrails.rst

@@ -0,0 +1,29 @@
+domaintrails package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   domaintrails.core
+
+Submodules
+----------
+
+domaintrails.portal module
+--------------------------
+
+.. automodule:: domaintrails.portal
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: domaintrails
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/index.rst

@@ -0,0 +1,39 @@
+=============
+domain-trails
+=============
+
+Welcome to domain-trails docs.
+domain-trails is open source intelligence
+gathering tool. This tool collect information related to urls.
+Working as educational project and trying to complete the project
+with native python code.
+
+Readme
+===========
+.. toctree::
+   :maxdepth: 2
+   :caption: Readme
+
+   readme
+
+Guide
+===========
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorial
+
+   start
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Code Documentation
+
+   modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+domaintrails
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   domaintrails

docs/source/readme.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../README.md