Merge pull request #3 from josephjcontreras/core

Merge core branch restructuring core items

Author: JJCoding01

.flake8

@@ -0,0 +1,17 @@
+[flake8]
+ignore =
+    W503,  # line break before binary operator
+    E731,  # do not assign a lambda expression, use a def
+    E203,  # whitespace before ':'
+
+exclude =
+    .git
+    docs
+    __pycache__
+    .mypy_cache
+    .pytest_cache
+    env
+    htmlcov
+
+max-complexity = 10
+max-line-length = 88

.gitignore

@@ -23,3 +23,6 @@ htmlcov/*
 
 # ignore build files for docs
 docs/build/*
+
+# ignore type checking cache
+**/.mypy_cache/*

.python-version

@@ -0,0 +1 @@
+femethods

.travis.yml

@@ -3,7 +3,7 @@ language: python
 python: 3.7.0
 install:
   - pip install -r requirements_dev.txt
-  - pip install -e .
+
 script:
   - pytest
 after_success:

CHANGELOG.md

@@ -1,11 +1,17 @@
 # Change Log
 
+## v0.1.7a2
+- Move common/private functionality into core module
+- Add some type hints for mypy
+- Restructure tests to use pytest fixtures and parametrized tests
+- Add make commands for building and publishing to PyPi
+
 ## v0.1.7a1
 - Update `Beam.plot` method to allow customization of plots generated
 - Added tests for `Beam.plot`
 - Added depreciation warning to `Beam.bending_stress` method
 
-### Backwards Incompatible Changes
+### Backwards Incompatible Changes 
 - Removed `bending_stress` parameter from `Beam.plot` method
 
 

Makefile

@@ -1,6 +1,7 @@
 PACKAGE_NAME=femethods
 
 .PHONY: install docs lint-html tests
+.PHONY: build
 
 docs:
 	cd docs && make html
@@ -23,3 +24,10 @@ tests:
 
 tests-ci:
 	pytest --cov-report html --cov=$(PACKAGE_NAME) tests/$(PACKAGE_NAME) -v
+
+build:
+	python setup.py sdist
+	python setup.py bdist_wheel
+
+upload:
+	twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

docs/source/intro.rst

@@ -4,6 +4,8 @@ Introduction
 This is the introduction to FEmethods. It will introduce Finite Element Methods
 in general, and then give a few examples of how to use FEmethods.
 
+The code can be found on `github.com <https://github.com/josephjcontreras/FEmethods>`_
+
 Installation
 ------------
 
@@ -12,6 +14,12 @@ FEmethods is hosted on PyPi, so installation is straightforward.
 
         >>>pip install femethods
 
+It can also be installed from source.
+    .. code-block:: python
+
+        >>>git clone https://github.com/josephjcontreras/FEmethods.git
+
+
 Then to test that the installation worked properly, you can try this simple
 example case of a simply supported beam with a single, centered point load.
 
@@ -44,15 +52,4 @@ example case of a simply supported beam with a single, centered point load.
                Force: 50.0
               Moment: 0.0
 
-Platform
---------
-
-FEmethods has only been tested on Windows 10, with python 3.7. Further testing
-with some linux distros is planned.
-
-
-Finite Element Methods
-----------------------
 
-Include a brief intro to general finite element methods. Generally, how it works
-what are some advantages and disadvantages, etc.

femethods/__init__.py

@@ -1,5 +1,5 @@
 __name__ = "femethods"
-__version__ = "0.1.7a1"
+__version__ = "0.1.7a2"
 __author__ = "Joseph Contreras Jr."
 __license__ = "MIT"
-__copyright__ = "Copyright 2019 Joseph Contreras Jr."
+__copyright__ = "Copyright 2020 Joseph Contreras Jr."