Improved project organization

Author: ellmetha

.gitignore

@@ -11,4 +11,5 @@ docs/_build/
 public/
 .tox
 tests/_testdata/media/
-.cache/
+.cache/
+.pytest_cache/

.travis.yml

@@ -18,9 +18,13 @@ matrix:
   exclude:
   - python: "2.7"
     env: DJANGO="django>=2.0,<2.1"
+
 install:
-  - "pip install $DJANGO"
+  - pip install pip pipenv -U
+  - pipenv install $DJANGO --skip-lock
+  - pipenv install --dev --skip-lock
 script:
-  - make travis
+  - make qa
+  - make coverage
 after_success:
   - codecov

Makefile

@@ -1,26 +1,58 @@
-.PHONY: install upgrade lint coverage travis docs
+.PHONY: init install qa lint tests spec coverage docs
 
-install:
-	pip install -r dev-requirements.txt
-	pip install -e .
 
-upgrade:
-	pip install -r dev-requirements.txt -U
-	pip install -e . -U
+init:
+	pipenv install --three --dev
 
+
+# DEVELOPMENT
+# ~~~~~~~~~~~
+# The following rules can be used during development in order to compile generate locales, build
+# documentation, etc.
+# --------------------------------------------------------------------------------------------------
+
+# Generate the project's .po files.
+messages:
+	cd precise_bbcode && pipenv run python -m django makemessages -a
+
+# Compiles the project's .po files.
+compiledmessages:
+	cd precise_bbcode && pipenv run python -m django compilemessages
+
+# Builds the documentation.
+docs:
+	cd docs && rm -rf _build && pipenv run make html
+
+
+# QUALITY ASSURANCE
+# ~~~~~~~~~~~~~~~~~
+# The following rules can be used to check code quality, import sorting, etc.
+# --------------------------------------------------------------------------------------------------
+
+qa: lint isort
+
+# Code quality checks (eg. flake8, eslint, etc).
 lint:
-	flake8
+	pipenv run flake8
 
+# Import sort checks.
 isort:
-	isort --check-only --recursive precise_bbcode tests
+	pipenv run isort --check-only --recursive --diff precise_bbcode tests
 
-coverage:
-	py.test --cov-report term-missing --cov precise_bbcode
 
-spec:
-	py.test --spec
+# TESTING
+# ~~~~~~~
+# The following rules can be used to trigger tests execution and produce coverage reports.
+# --------------------------------------------------------------------------------------------------
 
-travis: install lint coverage isort
+# Just runs all the tests!
+tests:
+	pipenv run py.test
 
-docs:
-	cd docs && make html
+# Collects code coverage data.
+coverage:
+	pipenv run py.test --cov-report term-missing --cov precise_bbcode
+
+# Run the tests in "spec" mode.
+spec:
+	pipenv run py.test --spec -p no:sugar

Pipfile

@@ -0,0 +1,28 @@
+[[source]]
+
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+
+[dev-packages]
+
+ipython = "*"
+pytest = "*"
+pytest-cov = "*"
+pytest-django = "*"
+pytest-pythonpath = "*"
+pytest-spec = "*"
+codecov = "*"
+"flake8" = "*"
+isort = "*"
+transifex-client = "*"
+django-debug-toolbar = "*"
+factory-boy = "*"
+sphinx = "*"
+sphinx-rtd-theme = "*"
+
+
+[packages]
+
+"e1839a8" = {path = ".", editable = true}