Simplify project

Author: Shai Geva

.gitignore

@@ -24,3 +24,6 @@ __pycache__
 
 .coverage
 .env
+
+# pyenv
+.python-version

Pipfile

@@ -1,2 +1,23 @@
 # Codium code examples
 These are code examples intended for serving as reference while evaluating Codium.
+
+# How to use
+Install packages:
+```
+pip install -r requirements.txt
+```
+
+# What to test
+Try creating tests for these files:
+```
+src/bank_account/bank_account.py
+src/colors/colors.py
+```
+
+# Run sanity tests
+These are sanity tests that make sure the envirmont is set up correctly.
+The don't check anything, just make sure imports work.
+
+```
+pytest
+```

Pipfile.lock

@@ -0,0 +1,8 @@
+from .bank_account import BankAccount
+
+def test_bank_account_env_setup_correct():
+    """
+    This is a sanity test to make sure that imports and paths work.
+    Just create an instance of the class.
+    """
+    BankAccount("foo bar", True)

README.md

@@ -1,7 +1,7 @@
 from __future__ import absolute_import, print_function
 import sys
 
-from src.colors.colors_utils import *
+from examples.colors.colors_utils import *
 
 _PY2 = sys.version_info[0] == 2
 

src/__init__.py examples/__init__.py

@@ -1,7 +1,8 @@
 from .colors import to_terminal_color
 
-def test_to_terminal_color():
+def test_to_terminal_color_env_setup_correct():
     """
     This is a sanity test to make sure that imports and paths work.
+    Just run the function.
     """
-    assert to_terminal_color("foo", fg="red") == "\x1b[31mfoo\x1b[0m"
+    to_terminal_color("foo", fg="red")

src/bank_account/__init__.py examples/bank_account/__init__.py

@@ -0,0 +1,3 @@
+pytest
+text-unidecode == 1.3
+Unidecode == 1.1.1