Merge pull request #9 from loicteixeira/release/v0.1

Release v0.1

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased](https://github.com/tomdyson/wagtail-netlify/compare/v0.1...HEAD)
+
+## [v0.1](https://github.com/tomdyson/wagtail-netlify/compare/f8f45701f43e28e238fc64aceea07dd1900343fc...v0.1)
+
+Initial Release

MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE *.md
+graft wagtailnetlify
+global-exclude __pycache__
+global-exclude *.py[co]

Makefile

@@ -0,0 +1,23 @@
+.PHONY: build help publish publish-test
+.DEFAULT_GOAL := help
+
+help: ## See what commands are available.
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36mmake %-15s\033[0m # %s\n", $$1, $$2}'
+
+build: ## Build the package.
+	@echo '== Cleanup =='
+	rm dist/* 2>/dev/null || true
+	@echo '== Build project =='
+	python setup.py sdist
+
+publish: build ## Publishes a new version to PyPI.
+	@echo '== Publish project to PyPi =='
+	twine upload dist/*
+	@echo '== Success =='
+	@echo 'Go to https://pypi.org/project/wagtailnetlify/ and check that all is well.'
+
+publish-test: build ## Publishes a new version to TestPyPI.
+	@echo '== Publish project to PyPi [TEST] =='
+	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+	@echo '== Success =='
+	@echo 'Go to https://test.pypi.org/project/wagtailnetlify/ and check that all is well.'

README.md

@@ -12,7 +12,7 @@ Deploy your Wagtail site on Netlify. Features include:
 
 1. Install and configure [Wagtail Bakery](https://github.com/moorinteractive/wagtail-bakery), if you haven't already
 2. Install [Netlify](https://www.netlify.com/docs/cli/#installation), if you haven't already
-3. `pip install git+https://github.com/tomdyson/wagtail-netlify.git`
+3. Install the project with `pip install wagtailnetlify`.
 
 ## Configure
 
@@ -46,9 +46,16 @@ url(r'^netlify/', netlify_views.success_hook, name='netlify'),
 
 In Netlify's admin interface for your app, add http://yourdomain/netlify/success as a URL to notify for the outgoing webhook on 'Deploy succeeded' events (in Settings / Build & deploy / Deploy notifications).
 
-## Todo
+## Development
 
-- [x] Provide an admin view for reporting on deployments
-- [ ] Allow adminstrators to trigger deploys manually
-- [ ] Allow developers to replace `Threading` with Celery or similar, for more robust async behaviour.
-- [ ] Tests
+### Releases
+
+1. Ensure you have the latest versions of `pip`, `setuptools` and `twine` installed in your virtual environment.
+1. Create a new branch (e.g. `release/v1.1.3`) for the release of the new version.
+1. Update the version number in `wagtailnetlify/__init__.py` following [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+1. Update `CHANGELOG.md`.
+1. On GitHub, create a pull request and squash merge it.
+1. Checkout and pull the `master` branch locally.
+1. (Optional) If you need to verify anything, use `make publish-test` to upload to https://test.pypi.org and enter your PyPi *test* credentials as needed.
+1. Use `make publish` and enter your PyPi credentials as needed.
+1. On GitHub, create a release and a tag for the new version.

setup.py

@@ -1,22 +1,28 @@
 from setuptools import setup, find_packages
 from wagtailnetlify import __version__
 
+with open('README.md', 'r') as fh:
+    long_description = fh.read()
+
 setup(
     name='wagtailnetlify',
     version=__version__,
     description='Deploy Wagtail sites to Netlify',
-    long_description='See https://github.com/tomdyson/wagtail-netlify for details',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     url='https://github.com/tomdyson/wagtail-netlify',
     author='Tom Dyson',
     author_email='[email protected]',
     license='MIT',
     classifiers=[
         "Environment :: Web Environment",
         "Framework :: Django",
+        "Framework :: Wagtail",
+        "Framework :: Wagtail :: 1",
         "Intended Audience :: Developers",
         "Operating System :: OS Independent",
         "Programming Language :: Python",
-        'Topic :: Internet :: WWW/HTTP',
+        "Topic :: Internet :: WWW/HTTP",
         "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
     ],
     keywords='development',
@@ -27,4 +33,4 @@
         "wagtail>=1.6",
         "wagtail-bakery>=0.1.0"
     ],
-)
+)