Moved test module inside Django Ledger Application.

Created dev_env with a simple development environment. README.md Update
EzzalddeenAli · Oct 18, 2021 · 79b0934 · 79b0934
1 parent 9cd44f7
commit 79b0934
Show file tree

Hide file tree

Showing 15 changed files with 48 additions and 13 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -11,7 +11,7 @@ Django Ledger was created by [Miguel Sanda](https://github.com/elarroba).
 * Miguel Sanda [@elarroba](https://github.com/elarroba)
 * Michael Noel [@mnooel](https://github.com/mnooel)
 
-### Accountants & Bookkeepers
+### Accountants, CPAs & Bookkeepers
 * Miguel Sanda [@elarroba](https://github.com/elarroba)
 * Albert Salazar [@Beachwood619](https://github.com/Beachwood619)
-* Michael Noel [@mnooel](https://github.com/mnooel) 
+* Michael Noel, CPA [@mnooel](https://github.com/mnooel) 
diff --git a/README.md b/README.md
@@ -97,8 +97,44 @@ urlpatterns = [
 ]
 ```
 
-# Screenshots
+# How To Set Up Django Ledger for Development
+Django Ledger comes with a basic development environments already configured under __dev_env/__ folder not to be used
+for production environments. If you want to contribute to the project perform the following steps:
+
+1. Navigate to your projects directory.
+2. Clone the repo from github and CD into project.
+```shell
+git clone https://github.com/arrobalytics/django-ledger.git
+cd django-ledger
+```
+3. Install PipEnv, if not already installed:
+```shell
+pip install -U pipenv
+```
+4. Create virtual environment.
+```shell
+pipenv install
+```
+If using a specific version of Python you may specify the path.
+```shell
+pipenv install --python PATH_TO_INTERPRETER
+```
+5. Activate environment.
+```shell
+pipenv shell
+```
+7. Run development server.
+```shell
+python manage.py runserver
+```
 
+# Run Test Suite
+After setting up your development environment you may run tests.
+```shell
+python manage.py test django_ledger
+```
+
+# Screenshots
 ![django ledger entity dashboard](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_entity_dashboard.png)
 ![django ledger balance sheet](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_income_statement.png)
 ![django ledger income statement](https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_balance_sheet.png)

diff --git a/tests/__init__.py → dev_env/__init__.py b/tests/__init__.py → dev_env/__init__.py
diff --git a/tests/asgi.py → dev_env/asgi.py b/tests/asgi.py → dev_env/asgi.py
@@ -2,6 +2,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tests.settings')
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'dev_env.settings')
 
 application = get_asgi_application()
diff --git a/tests/settings.py → dev_env/settings.py b/tests/settings.py → dev_env/settings.py
@@ -14,8 +14,8 @@
     'django.contrib.messages',
     'django.contrib.staticfiles',
 
-    'tests',
     'django_ledger'
+
 ]
 
 MIDDLEWARE = [
@@ -28,7 +28,7 @@
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 ]
 
-ROOT_URLCONF = 'tests.urls'
+ROOT_URLCONF = 'dev_env.urls'
 
 TEMPLATES = [
     {
@@ -47,7 +47,7 @@
     },
 ]
 
-WSGI_APPLICATION = 'tests.wsgi.application'
+WSGI_APPLICATION = 'dev_env.wsgi.application'
 
 # Database
 # https://docs.djangoproject.com/en/2.2/ref/settings/#databases

diff --git a/tests/urls.py → dev_env/urls.py b/tests/urls.py → dev_env/urls.py
diff --git a/tests/wsgi.py → dev_env/wsgi.py b/tests/wsgi.py → dev_env/wsgi.py
@@ -2,6 +2,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tests.settings')
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'dev_env.settings')
 
 application = get_wsgi_application()
diff --git a/tests_bdd/__init__.py → django_ledger/tests/__init__.py b/tests_bdd/__init__.py → django_ledger/tests/__init__.py
diff --git a/tests/base.py → django_ledger/tests/base.py b/tests/base.py → django_ledger/tests/base.py
diff --git a/django_ledger/tests/bdd/__init__.py b/django_ledger/tests/bdd/__init__.py
diff --git a/tests_bdd/features/README.feature → ..._ledger/tests/bdd/features/README.feature b/tests_bdd/features/README.feature → ..._ledger/tests/bdd/features/README.feature
diff --git a/tests_bdd/features/steps/README.py → ...ledger/tests/bdd/features/steps/README.py b/tests_bdd/features/steps/README.py → ...ledger/tests/bdd/features/steps/README.py
diff --git a/tests/test_auth.py → django_ledger/tests/test_auth.py b/tests/test_auth.py → django_ledger/tests/test_auth.py
@@ -1,7 +1,7 @@
 from django.urls import reverse
 
-from tests.base import DjangoLedgerBaseTest
-from tests.settings import LOGIN_URL
+from django_ledger.tests.base import DjangoLedgerBaseTest
+from dev_env.settings import LOGIN_URL
 
 
 class AuthTest(DjangoLedgerBaseTest):
@@ -73,4 +73,3 @@ def test_user_can_logout(self):
 
         response = self.client.get(logout_url)
         self.assertRedirects(response, expected_url=login_url)
-
diff --git a/tests/tests_entity.py → django_ledger/tests/tests_entity.py b/tests/tests_entity.py → django_ledger/tests/tests_entity.py
@@ -211,7 +211,7 @@ def test_entity_views(self):
                                     text=reverse('django_ledger:entity-delete',
                                                  kwargs={
                                                      'entity_slug': entity_model.slug
-                                                 }))        # ENTITY-LIST VIEW...
+                                                 }))  # ENTITY-LIST VIEW...
 
         # # HOME VIEW
         # with self.assertNumQueries(3):

diff --git a/tests/manage.py → manage.py b/tests/manage.py → manage.py
@@ -6,7 +6,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tests.settings')
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'dev_env.settings')
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc: