Added a lot of config files

Author: Jan Schaffranek

.coveragerc

@@ -0,0 +1,27 @@
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+[paths]
+source =
+    fastvector/
+    tests/
+
+[coverage:run]
+omit =
+    setup.py
+

.editorconfig

@@ -0,0 +1,24 @@
+# -*- mode: conf-unix; -*-
+
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+# defaults
+[*]
+insert_final_newline = true     
+
+# 4 space indentation
+[*.{ini,py,py.tpl,rst}]
+indent_style = space
+indent_size = 4
+
+# 4-width tabbed indentation
+[*.{sh,bat.tpl,Makefile.tpl}]
+indent_style = tab
+indent_size = 4
+
+# and travis does its own thing
+[.travis.yml]
+indent_style = space
+indent_size = 2

.gitignore

@@ -1,11 +1,19 @@
+################################
+########### FOLDERS ############
+################################
+# directories
+source/
+.vscode/
+
+################################
+########### PYTHON  ############
+################################
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
-
 # C extensions
 *.so
-
 # Distribution / packaging
 .Python
 build/
@@ -26,17 +34,14 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
-
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec
-
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
-
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -50,57 +55,44 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
-
 # Translations
 *.mo
 *.pot
-
 # Django stuff:
 *.log
 local_settings.py
 db.sqlite3
 db.sqlite3-journal
-
 # Flask stuff:
 instance/
 .webassets-cache
-
 # Scrapy stuff:
 .scrapy
-
 # Sphinx documentation
 documentation/_build/
-
 # PyBuilder
 target/
-
 # Jupyter Notebook
 .ipynb_checkpoints
-
 # IPython
 profile_default/
 ipython_config.py
-
 # pyenv
 .python-version
-
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
 #   However, in case of collaboration, if having platform-specific dependencies or dependencies
 #   having no cross-platform support, pipenv may install dependencies that don't work, or not
 #   install all needed dependencies.
 #Pipfile.lock
-
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
-
 # Celery stuff
 celerybeat-schedule
 celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
-
 # Environments
 .env
 .venv
@@ -109,21 +101,27 @@ venv/
 ENV/
 env.bak/
 venv.bak/
-
 # Spyder project settings
 .spyderproject
 .spyproject
-
 # Rope project settings
 .ropeproject
-
 # mkdocs documentation
 /site
-
 # mypy
 .mypy_cache/
 .dmypy.json
 dmypy.json
-
 # Pyre type checker
 .pyre/
+
+################################
+########### VS CODE ############
+################################
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+.history/

.isort.cfg

@@ -0,0 +1,14 @@
+[settings]
+line_length = 120
+indent = '    '
+skip = .tox, .venv, build, dist
+known_standard_library = StringIO, __builtin__
+known_setuptools = setuptools, pkg_resources
+known_test = pytest
+known_first_party = fastvector
+sections = FUTURE, STDLIB,SETUPTOOLS, TEST, THIRDPARTY, FIRSTPARTY, LOCALFOLDER
+default_section = THIRDPARTY
+multi_line_output = 3
+include_trailing_comma = True
+force_grid_wrap = 0
+use_parentheses = True

.travis.yml

@@ -0,0 +1,12 @@
+language: python
+python:
+  - "3.7"
+sudo: false
+# command to install dependencies
+install:
+  - pip install -r requirements.txt
+# command to run tests
+script:
+  - make test code-style code-lint
+after_success:
+  - coveralls

Makefile

@@ -0,0 +1,73 @@
+SRC_APP=app
+SRC_CORE=fastvector
+SRC_TEST=tests
+SRC_DOC=documentation
+
+ifeq ($(OS), Windows_NT)
+	PYTHON=python
+	PIP=pip
+	RM=del /Q
+	FixPath=$(subst /,\,$1)
+else
+	PYTHON=python3
+	PIP=pip3
+	RM=rm -f
+	FixPath=$1
+endif
+
+help:
+	@echo "Some available commands:"
+	@echo " * run          		- Run code."
+	@echo " * test         		- Run unit tests and test coverage."
+	@echo " * doc          		- Document code (pydoc)."
+	@echo " * clean        		- Cleanup (e.g. pyc files)."
+	@echo " * code-pylint  		- Check code pylint."
+	@echo " * code-flake8  		- Check code flake8."
+	@echo " * code-mypy    		- Check code mypy"
+	@echo " * code-lint    		- Check code lints (pylint, flake8, mypy)."
+	@echo " * code-isort   		- Sort the import statements."
+	@echo " * code-autopep8 	- Auto format the code for pep8."
+	@echo " * code-format   	- Format code (isort, autopep8)."
+	@echo " * deps-install 		- Install dependencies (see requirements.txt)."
+	@echo " * deps-dev-install 	- Install dev. dependencies (see requirements-dev.txt)."
+
+run:
+	@$(PYTHON) $(SRC_APP)/main.py
+
+test:
+	@coverage run --source . -m $(SRC_TEST).test_vector
+	@coverage report
+
+doc:
+	@build_docs.bat
+
+clean:
+	@$(RM) $(call FixPath,$(SRC_CORE)/*.pyc)
+	@$(RM) $(call FixPath,$(SRC_CORE)/__pycache__)
+	@$(RM) $(call FixPath,$(SRC_TEST)/*.pyc)
+	@$(RM) $(call FixPath,$(SRC_TEST)/__pycache__)
+
+code-pylint: 
+	@pylint $(SRC_CORE)
+
+code-mypy:
+	@mypy $(SRC_CORE)
+
+code-lint: code-pylint code-mypy
+
+code-isort:
+	cd $(SRC_CORE)
+	@isort --recursive .
+	cd $(SRC_TEST)
+	@isort --recursive .
+
+code-pep8:
+	@autopep8 -i -r $(SRC_CORE)
+
+code-format: code-isort code-pep8
+
+deps-install:
+	@$(PIP) install -r requirements.txt
+
+deps-dev-install:
+	@$(PIP) install -r requirements-dev.txt

README.md

@@ -20,6 +20,7 @@ This is a template for Python projects. What you get:
 ``` text
 ├── setup.py
 └── documentation
+│   └── Makefile
 ├── fastvector
 │   └── __init__.py
 │   └── vector.py

app/main.py

@@ -0,0 +1,10 @@
+from fastvector import VectorND
+
+
+def main():
+    print("Hello world!")
+    vec = VectorND(1, 2, 3)
+    print(vec)
+
+if __name__ == "__main__":
+    main()

GenerateDoc.bat build_docs.batGenerateDoc.bat renamed to build_docs.bat

@@ -0,0 +1,4 @@
+cd documentation
+sphinx-apidoc -o source/ ../fastvector/
+make html
+cd ..