add wheel to build, include a requirements_dev.txt and document (#35)

* add wheel to build, include a requirements_dev.txt and document

* update requirements

.github/workflows/CI.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install black pyflakes mypy
+          pip install -r requirements_dev.txt
       - name: Check black formatter and pyflakes
         run: |
           black forestplot/ --check -l 95
@@ -36,8 +36,6 @@ jobs:
           mypy
       - name: Generate coverage report
         run: |
-          pip install pytest coverage
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi        
           coverage run -m pytest
       - name: Upload Coverage to Codecov
         uses: codecov/codecov-action@v2          
@@ -58,8 +56,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install -r requirements_dev.txt
     - name: Test with pytest
       run: |
         pytest -v --disable-warnings
@@ -80,8 +77,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install -r requirements_dev.txt
     - name: Test with pytest
       run: |
         pytest -v --disable-warnings
@@ -102,8 +98,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest
-        pip install -r requirements.txt
+        pip install -r requirements_dev.txt
     - name: Test with pytest
       run: |
         pytest -v --disable-warnings

Makefile

@@ -29,7 +29,7 @@ prepack:
 	@echo "+ $@"
 	@rm -rf dist/ forestplot.egg-info/
 	@rm -rf dist/ pyforestplot.egg-info/
-	@python setup.py sdist
+	@python setup.py sdist bdist_wheel
 	twine check dist/*
 
 PACKAGE_FILES := build/ dist/ *.egg-info/ *.egg-info *.egg

README.md

@@ -63,6 +63,17 @@ git clone https://github.com/LSYS/forestplot.git
 cd forestplot
 pip install .
 ```
+
+Developer installation<br>
+```bash
+git clone https://github.com/LSYS/forestplot.git
+cd forestplot
+pip install -r requirements_dev.txt
+
+make lint
+make test
+```
+
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 

requirements_dev.txt

@@ -0,0 +1,16 @@
+-r requirements.txt
+
+# build
+wheel
+
+# test
+coverage
+pytest
+
+# lint
+black
+flake8
+mypy
+
+# package in local install
+-e .