go all in on venv for local development

(and clean up the imports in the tests accordingly)

Author: kcr

.coveragerc

@@ -7,7 +7,5 @@ omit =
     */site-packages/ordereddict.py
     */site-packages/nose/*
     */unittest2/*
-    ../lib/*
-    lib/*
     tests/*
     snipe/_roost_python/*.py

.gitignore

@@ -10,9 +10,12 @@ parser.out
 cover/
 .coverage
 htmlcov/
-lib/
+
+.mypy_cache/
 
 venv/
 
 snipe_im.egg-info/
 
+venv-stamp
+

Makefile

@@ -1,25 +1,46 @@
-NOSE=nosetests3
+VBIN=venv/bin
+FLAKE8=$(VBIN)/flake8
+NOSE=$(VBIN)/nosetests
+MYPY=$(VBIN)/mypy
+COVERAGE=$(VBIN)/coverage
+
 NOSETESTS=TZ=GMT $(NOSE) -v -w tests
 
 all check: flake8 mypy nosetests 
 
-flake8:
-	flake8 rooster.py setup.py snipe.py swearing.py snipe tests
+flake8: venv
+	$(FLAKE8) rooster.py setup.py snipe.py swearing.py snipe tests
 
-nosetests:
+nosetests: venv
 	$(NOSETESTS) --processes=8 --process-timeout=300
 
-mypy:
-	mypy --ignore-missing-imports rooster.py setup.py swearing.py snipe tests
+mypy: venv
+	$(MYPY) --ignore-missing-imports rooster.py setup.py swearing.py snipe tests
 
-coverage:
-	python3-coverage erase
+coverage: venv
+	$(COVERAGE) erase
 	$(NOSETESTS) --with-coverage
-	python3-coverage html
+	$(COVERAGE) html
+
+clean::
+	$(RM) -r .coverage profiling htmlcov parser.out snipe/parser.out tests/parser.out
+
+venv:	venv-stamp
+
+venv-stamp:
+	$(MAKE) venv-clean
+	python3 -m venv venv
+	venv/bin/pip install -U pip
+	venv/bin/pip install -r ./requirements.txt
+	venv/bin/pip install mypy flake8 nose coverage
+	venv/bin/pip install -e .
+	touch venv-stamp
+
+venv-clean:
+	$(RM) -rf venv venv-stamp
 
-clean:
-	$(RM) -r .coverage profiling htmlcov parser.out tests/parser.out
+clean:: venv-clean
 
 install:
 
-.PHONY: all clean install check flake8 nosetests
+.PHONY: all clean install check flake8 nosetests venv venv-clean

README.md

@@ -11,7 +11,7 @@ client intended for services with persistence.  One such service is
 [zephyr](https://github.com/zephyr-im).  snipe is also has
 minimal support for [IRCCloud](https://www.irccloud.com).
 
-I've decided that supporting anything earlier thant python 3.6 isn't
+I've decided that supporting anything earlier than python 3.6 isn't
 worth it.
 
 M-g in the messager window requires
@@ -27,6 +27,11 @@ It is known that there are bugs and missing features everywhere.  I
 would mostly characterize this as "demoable" but not yet "usable".  As
 always, if it breaks you get to keep both pieces.
 
+Running snipe (or the tests) in situ is best done with a virtualenv;
+run `make venv` to create one with the appropriate dependencies, or
+just `make` to do so and run the tests.  Once the venv is set up you
+can run `venv/bin/snipe`.
+
 Keybindings
 -----------
 

snipe.py

@@ -33,12 +33,8 @@
 '''
 
 import unittest
-import sys
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-import snipe._rooster as rooster  # noqa: E402,F401
+import snipe._rooster as rooster  # noqa: F401
 
 
 class TestRooster(unittest.TestCase):

tests/_rooster_tests.py

@@ -33,12 +33,8 @@
 '''
 
 import unittest
-import sys
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-from snipe.chunks import Chunk  # noqa: E402
+from snipe.chunks import Chunk
 
 
 class TestChunk(unittest.TestCase):

tests/chunks_tests.py

@@ -34,14 +34,10 @@
 
 import os
 import logging
-import sys
 import unittest
 import tempfile
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-import snipe.context as context  # noqa: E402,F401
+import snipe.context as context
 
 
 class TestContext(unittest.TestCase):

tests/context_tests.py

@@ -37,17 +37,13 @@
 import array
 import itertools
 import random
-import sys
 import unittest
 
 import mocks
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-import snipe.imbroglio  # noqa: E402
-import snipe.chunks     # noqa: E402
-import snipe.editor     # noqa: E402
+import snipe.chunks
+import snipe.editor
+import snipe.imbroglio
 
 
 class TestEditor(unittest.TestCase):

tests/editor_tests.py

@@ -35,19 +35,16 @@
 '''
 
 import re
-import sys
 import unittest
 
 import mocks
 
-sys.path.append('..')
-sys.path.append('../lib')
+import snipe.filters
 
-import snipe.filters                                           # noqa: E402
 from snipe.filters import (
     And, Compare, Identifier, Lexer, No, Not, Or, Parser, RECompare,
     SnipeFilterError, Truth, Yes, Xor, makefilter,
-    )                                                          # noqa: E402
+    )
 
 
 class TestFilters(unittest.TestCase):

tests/filter_tests.py

@@ -32,14 +32,11 @@
 Unit tests for help system
 '''
 
-import sys
 import unittest
 
-sys.path.append('..')
-sys.path.append('../lib')
+import snipe.help as help
 
-import snipe.help as help             # noqa: E402,F401
-from snipe.chunks import Chunk, View  # noqa: E402,F401
+from snipe.chunks import (Chunk, View)
 
 
 class TestHelp(unittest.TestCase):

tests/help_tests.py

@@ -33,12 +33,8 @@
 '''
 
 import unittest
-import sys
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-import snipe.interactive as interactive  # noqa: E402,F401
+import snipe.interactive as interactive  # noqa: F401
 
 
 class TestInteractive(unittest.TestCase):

tests/interactive_tests.py

@@ -34,17 +34,14 @@
 
 import os
 import unittest
-import sys
 
 import mocks
 
-sys.path.append('..')
-sys.path.append('../lib')
+import snipe.context as context
+import snipe.irccloud as irccloud
+import snipe.messages as messages
 
-from snipe.chunks import Chunk     # noqa: E402,F401
-import snipe.context as context    # noqa: E402,F401
-import snipe.irccloud as irccloud  # noqa: E402,F401
-import snipe.messages as messages  # noqa: E402,F401
+from snipe.chunks import (Chunk)
 
 
 class TestIRCCloudDecor(unittest.TestCase):

tests/irccloud_tests.py

@@ -35,13 +35,9 @@
 
 
 import curses
-import sys
 import unittest
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-import snipe.keymap  # noqa: E402
+import snipe.keymap
 
 
 class TestKeymap(unittest.TestCase):

tests/keymap_tests.py

@@ -33,12 +33,8 @@
 '''
 
 import unittest
-import sys
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-import snipe.main as main   # noqa: E402,F401
+import snipe.main as main
 
 
 class TestMain(unittest.TestCase):

tests/main_tests.py

@@ -37,21 +37,16 @@
 import io
 import math
 import os
-import sys
 import unittest
 import unittest.mock as mock
 
 import mocks
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-
-import snipe.chunks as chunks        # noqa: E402,F401
-import snipe.filters as filters      # noqa: E402,F401
-import snipe.imbroglio as imbroglio  # noqa: E402,F401
-import snipe.messager as messager    # noqa: E402,F401
-import snipe.util as util            # noqa: E402,F401
+import snipe.chunks as chunks
+import snipe.filters as filters
+import snipe.imbroglio as imbroglio
+import snipe.messager as messager
+import snipe.util as util
 
 
 class TestMessager(unittest.TestCase):

tests/messager_tests.py

@@ -36,20 +36,16 @@
 import datetime
 import itertools
 import os
-import sys
 import time
 import unittest
 
 import mocks
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-import snipe.chunks as chunks        # noqa: E402
-import snipe.filters as filters      # noqa: E402
-import snipe.imbroglio as imbroglio  # noqa: E402
-import snipe.messages as messages    # noqa: E402
-import snipe.util as util            # noqa: E402
+import snipe.chunks as chunks
+import snipe.filters as filters
+import snipe.imbroglio as imbroglio
+import snipe.messages as messages
+import snipe.util as util
 
 
 class TestSnipeAddress(unittest.TestCase):

tests/messages_tests.py

@@ -41,14 +41,11 @@
 
 from typing import (Dict, Any, List, Optional, Tuple)
 
-sys.path.append('..')
-sys.path.append('../lib')
-
-import snipe.chunks    # noqa: E402
-import snipe.filters   # noqa: E402
-import snipe.ttycolor  # noqa: E402
-import snipe.ttyfe     # noqa: E402
-import snipe.window    # noqa: E402
+import snipe.chunks
+import snipe.filters
+import snipe.ttycolor
+import snipe.ttyfe
+import snipe.window
 
 
 class Backend: