################################
Installation
################################

.. _Brad Stancel: https://bradstancel.com/
.. |date| date:: %m/%d/%Y

:Authors: `Brad Stancel`_
:Created:  04/01/2020
:Modified: |date|

.. _doc-system-install-overview:

********************************
Installation Overview
********************************

An overview of the system will go here...

Linux
=======================

First install these dependencies:


.. code-block:: bash

	sudo apt install ca-certificates python3-distutils python-pip-whl
	# Need a role to install Pip and Sphinx
	python3 -V
	sudo apt install -y python3-pip
	sudo apt install build-essential libssl-dev libffi-dev python3-dev

	# Update Python 3 and Pip 3 to be the defaults
	sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10
	# sudo update-alternatives --install /usr/bin/pip pip /usr/bin/pip3 10  *** This did not work


To draw any diagrams, you may also want to have `PlantUML <https://sourceforge.net/projects/plantuml/files/plantuml.jar/download>`_ installed. The JAR file for plantuml should be stored here: ``/opt/plantuml/plantuml.jar``


Mac OS
=======================

Info about Mac OS...

Install either with Pip or Homebrew.


Windows
=======================

Info about Windows here...


Pip Package Manager
=======================

Here we will talk about how to install all of the needed components via the Python Package Management system called Pip.

First you'll need to install Pip.

.. code-block:: bash

	curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
	python get-pip.py
	# This will install pip to: /usr/local/bin/pip
	
	# Or you can try to install it using apt package manager if using a Debian flavor of Linux 
	sudo apt install python-pip


Pip Packages Needed
--------------------------

Now we'll need to install some Pip Packages.

.. code-block:: bash

	pip install docutils sphinx sphinx-autobuild sphinx-intl sphinx_rtd_theme
	pip install rstcheck graphviz sphinxcontrib-inlinesyntaxhighlight sphinxcontrib.youtube recommonmark sphinxcontrib.plantuml




Many more need to be added here...


********************************
Links and References
********************************

Any links or references used in creating this documentation should be listed below.

Windows Setup
=====================

- https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/
- https://www.computerworld.com/article/3218116/how-to-make-shortcuts-to-windows-10-settings-on-your-desktop.html
- https://www.windowscentral.com/how-create-and-run-batch-file-windows-10
- https://windowsloop.com/change-default-console-in-windows-terminal/
- https://www.google.com/search?ei=039FXpykMcGyggfJ9JCQAg&q=windows+10+change+default+editor+to+cmd.exe&oq=windows+10+change+default+editor+to+cmd.exe&gs_l=psy-ab.3...2175.2318..5120...0.0..0.232.675.1j2j1......0....1..gws-wiz.......33i22i29i30j33i10._yGTkJEujDo&ved=0ahUKEwjc2fbN_87nAhVBmeAKHUk6BCIQ4dUDCAs&uact=5


# Ubuntu 18.04 comes with Python 3.6.8  (python3 -V)

sudo apt update
sudo apt install ca-certificates python3-distutils build-essential libssl-dev libffi-dev python3-dev
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py
	(Installs to: /usr/local/bin/pip)
pip install sphinx sphinx-autobuild sphinx-intl sphinx_rtd_theme

# Install Pip modules
pip install sphinx sphinx-autobuild sphinx-intl sphinx_rtd_theme recommonmark pymysql

# Install Graphviz
sudo apt install graphviz graphviz-doc libgraphviz-dev python3-graphviz python3-gv libgv-php7 xdot

# Install Conversion Tools
sudo apt install pandoc 
	-- these can come later if needed dot2tex libxdot4 texlive-pictures

# Update Python 3 and Pip 3 to be the defaults
sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10