streamline local dev

Author: mckaymatt

.gitignore

@@ -63,6 +63,8 @@ target/
 
 # virtualenv
 .venv/
+venv/
+
 
 # Wheelhouse
 wheelhouse/

HISTORY.rst

@@ -2,7 +2,7 @@
 History
 =======
 
-0.1.0 (2017-05-27)
+0.1.0 (2017-06-04)
 ------------------
 
 * First release on PyPI.

MANIFEST.in

@@ -13,7 +13,7 @@ recursive-exclude * *.py[co]
 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
 
 # we only want "release" artifacts, not "debug" artifacts
-recursive-include trust_pypi_example/rust/target/release *.so *.dylib *.dll *.lib  
+recursive-include trust_pypi_example/rust/target/release *.so *.dylib *.dll *.lib
 recursive-include trust_pypi_example *.h *.c
 
 # inclusing the .rs and .toml files isn't necessary so feel free to remove them. 

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean clean-test clean-pyc clean-build docs help 
+.PHONY: clean clean-test clean-pyc clean-build clean-venv docs help install dist release test test-all 
 .DEFAULT_GOAL := help
 define BROWSER_PYSCRIPT
 import os, webbrowser, sys
@@ -28,16 +28,17 @@ BROWSER := python -c "$$BROWSER_PYSCRIPT"
 help:
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
-clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+clean: clean-build clean-pyc clean-test clean-venv ## remove all build, test, coverage, Python artifacts and virtualenv
 
 
 clean-build: ## remove build artifacts
 	rm -fr build/
 	rm -fr dist/
 	rm -fr trust_pypi_example/rust/target
 	rm -fr .eggs/
+	rm -f *.so *.dylib *.dll 
 	find . -name '*.egg-info' -exec rm -fr {} +
-	find . -name '*.egg' -exec rm -f {} +
+	find . -name '*.egg' -exec rm -fr {} +
 
 clean-pyc: ## remove Python file artifacts
 	find . -name '*.pyc' -exec rm -f {} +
@@ -50,52 +51,53 @@ clean-test: ## remove test and coverage artifacts
 	rm -f .coverage
 	rm -fr htmlcov/
 
-lint: ## check style with flake8
-	flake8 trust_pypi_example tests
-
-test: ## run tests quickly with the default Python
-	py.test
-	
+clean-venv:
+	rm -rf venv
 
+lint: venv ## check style with flake8
+	venv/bin/flake8 trust_pypi_example tests
 
-cargo-test: ## build rust lib for local testing. DO NOT USE ON TRAVIS. Cross needs to build for the target
-	cargo test --manifest-path trust_pypi_example/rust/Cargo.toml --release
+test: venv ## This will use py.test because of pytest-runner
+	venv/bin/python setup.py check
+	venv/bin/python setup.py test
 
-cargo-build: ## build rust lib for local testing. DO NOT USE ON TRAVIS. Cross needs to build for the target
-	cargo build --manifest-path trust_pypi_example/rust/Cargo.toml --release
+venv:  ## set up a virtualenv that will by python and install dependencies
+	python -m virtualenv venv || python -m venv venv
+	venv/bin/pip install -r requirements_dev.txt
 
-cross-build: clean
-	cross build --manifest-path trust_pypi_example/rust/Cargo.toml --target $$TARGET --release
 
-test-all: ## run tests on every Python version with tox
-	tox
+test-all: venv ## run tests on every Python version with tox
+	venv/bin/tox
 
-coverage: ## check code coverage quickly with the default Python
-	coverage run --source trust_pypi_example -m pytest
+coverage: venv ## check code coverage quickly with the default Python
+	venv/bin/coverage run --source trust_pypi_example -m pytest
 
-		coverage report -m
-		coverage html
+		venv/bin/coverage report -m
+		venv/bin/coverage html
 		$(BROWSER) htmlcov/index.html
 
-docs: ## generate Sphinx HTML documentation, including API docs
+docs: venv ## generate Sphinx HTML documentation, including API docs
 	rm -f docs/trust_pypi_example.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ trust_pypi_example
+	venv/bin/sphinx-apidoc -o docs/ trust_pypi_example
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html
 
-servedocs: docs ## compile the docs watching for changes
-	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+servedocs: venv docs ## compile the docs watching for changes
+	venv/bin/watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 
-release: clean ## package and upload a release
-	python setup.py sdist upload
-	python setup.py bdist_wheel upload
+release: venv clean ## package and upload a release
+	venv/bin/python setup.py sdist upload
+	venv/bin/python setup.py bdist_wheel upload
 
-dist: clean ## builds source and wheel package
-	python setup.py sdist
-	python setup.py bdist_wheel
+dist: venv clean ## builds source and wheel package
+	venv/bin/python setup.py sdist
+	venv/bin/python setup.py bdist_wheel
 	ls -l dist
 
-install: clean ## install the package to the active Python's site-packages
-	python setup.py install
+install: venv clean ## install the package to the active Python's site-packages
+	venv/bin/python setup.py install
+
+
+local-test: clean test coverage dist install 

README.rst

@@ -18,7 +18,22 @@ trust_pypi_example
      :alt: Updates
 
 
-This package was created with Cookiecutter_ and the `mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish`_ project template. It is meant to show how `mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish`_ can be used to produce a Python Wheel with an embedded Rust module.
+Python Boilerplate contains all the boilerplate you need to create a Python wheel with Rust.
+
+
+* Free software: Apache Software License 2.0
+* Documentation: https://trust-pypi-example.readthedocs.io.
+
+
+Features
+--------
+
+* TODO
+
+Credits
+---------
+
+This package was created with Cookiecutter_ and the `mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish`_ project template.
 
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _`mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish`: https://github.com/mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish

appveyor.yml

@@ -64,9 +64,9 @@ build_script:
 
 test_script:
   - "%PYTHON_DIR%\\python -m ci test"
-  - ps: >-  
+  - ps: >-
       Get-ChildItem .\dist\
-  - ps: >-  
+  - ps: >-
       Get-ChildItem -R trust_pypi_example\
 
 

trust_pypi_example/trust_pypi_example.py

@@ -16,12 +16,15 @@
     DYNAMIC_LIB_FORMAT = '%s.dll'
 elif sys.platform == 'darwin':
     DYNAMIC_LIB_FORMAT = 'lib%s.dylib'
-# FIXME: Does this need to check for other values of `sys.platform`?
-else:
+elif "linux" in sys.platform:
     DYNAMIC_LIB_FORMAT = 'lib%s.so'
+else:
+    raise NotImplementedError('No implementation for "{}".'
+                              ' Supported platforms are '
+                              '"win32", "darwin", and "linux"'
+                              ''.format(sys.platform))
 
 DLPATH = os.path.join(
-    # FIXME: path is hard-coded
     # If the crate is built without the "--release" flag
     # the path will be 'rust/target/debug' and this will
     # cause OSError