Updated README to include development env

This patch shows how to setup a development environment.

Please use the steps as laid out and install the pre-commit
hooks to ensure the code is clean prior to commit.

ChangeLog

@@ -4,6 +4,7 @@ CHANGES
 v1.5.0
 ------
 
+* Updated README to include development env
 * Added pre-commit hooks
 * Update Changelog for v1.5.0
 * Added QueryPlugin resend all delayed msgs or Flush

README.rst

@@ -337,10 +337,17 @@ AND... ping, fortune, time.....
 
 
 Development
------------
+===========
+
+* git clone git@github.com:craigerl/aprsd.git
+* cd aprsd
+* virtualenv .venv
+* source .venv/bin/activate
+* pip install -e .
+* pre-commit install
 
 Workflow
-========
+--------
 
 While working aprsd, The workflow is as follows
 
@@ -348,11 +355,11 @@ While working aprsd, The workflow is as follows
 * run tox -epep8
 * run tox -efmt
 * run tox -p
-* git commit
+* git commit  ( This will run the pre-commit hooks which does checks too )
 
 
 Release
-=======
+-------
 
 To do release to pypi:
 
@@ -382,7 +389,7 @@ Docker Container
 ----------------
 
 Building
-========
+--------
 
 There are 2 versions of the container Dockerfile that can be used.
 The main Dockerfile, which is for building the official release container
@@ -391,18 +398,18 @@ which is used for building a container based off of a git branch of
 the repo.
 
 Official Build
-==============
+--------------
 
  docker build -t hemna6969/aprsd:latest .
 
 Development Build
-=================
+-----------------
 
  docker build -t hemna6969/aprsd:latest -f Dockerfile-dev .
 
 
 Running the container
-=====================
+---------------------
 
 There is a docker-compose.yml file that can be used to run your container.
 There are 2 volumes defined that can be used to store your configuration

requirements.in

@@ -9,3 +9,4 @@ requests
 thesmuggler
 aprslib
 py3-validate-email
+pre-commit

requirements.txt

@@ -4,23 +4,71 @@
 #
 #    pip-compile
 #
-aprslib==0.6.47           # via -r requirements.in
+appdirs==1.4.4
-certifi==2020.12.5        # via requests
+    # via virtualenv
-chardet==4.0.0            # via requests
+aprslib==0.6.47
-click-completion==0.5.2   # via -r requirements.in
+    # via -r requirements.in
-click==7.1.2              # via -r requirements.in, click-completion
+certifi==2020.12.5
-dnspython==2.0.0          # via py3-validate-email
+    # via requests
-filelock==3.0.12          # via py3-validate-email
+cfgv==3.2.0
-idna==2.10                # via py3-validate-email, requests
+    # via pre-commit
-imapclient==2.1.0         # via -r requirements.in
+chardet==4.0.0
-jinja2==2.11.2            # via click-completion
+    # via requests
-markupsafe==1.1.1         # via jinja2
+click-completion==0.5.2
-pbr==5.5.1                # via -r requirements.in
+    # via -r requirements.in
-pluggy==0.13.1            # via -r requirements.in
+click==7.1.2
-py3-validate-email==0.2.12  # via -r requirements.in
+    # via
-pyyaml==5.3.1             # via -r requirements.in
+    #   -r requirements.in
-requests==2.25.1          # via -r requirements.in
+    #   click-completion
-shellingham==1.3.2        # via click-completion
+distlib==0.3.1
-six==1.15.0               # via -r requirements.in, click-completion, imapclient
+    # via virtualenv
-thesmuggler==1.0.1        # via -r requirements.in
+dnspython==2.0.0
-urllib3==1.26.2           # via requests
+    # via py3-validate-email
+filelock==3.0.12
+    # via
+    #   py3-validate-email
+    #   virtualenv
+identify==1.5.11
+    # via pre-commit
+idna==2.10
+    # via
+    #   py3-validate-email
+    #   requests
+imapclient==2.1.0
+    # via -r requirements.in
+jinja2==2.11.2
+    # via click-completion
+markupsafe==1.1.1
+    # via jinja2
+nodeenv==1.5.0
+    # via pre-commit
+pbr==5.5.1
+    # via -r requirements.in
+pluggy==0.13.1
+    # via -r requirements.in
+pre-commit==2.9.3
+    # via -r requirements.in
+py3-validate-email==0.2.12
+    # via -r requirements.in
+pyyaml==5.3.1
+    # via
+    #   -r requirements.in
+    #   pre-commit
+requests==2.25.1
+    # via -r requirements.in
+shellingham==1.3.2
+    # via click-completion
+six==1.15.0
+    # via
+    #   -r requirements.in
+    #   click-completion
+    #   imapclient
+    #   virtualenv
+thesmuggler==1.0.1
+    # via -r requirements.in
+toml==0.10.2
+    # via pre-commit
+urllib3==1.26.2
+    # via requests
+virtualenv==20.2.2
+    # via pre-commit