Refactor packaging (#131)

* Repackage using metadata in setup.cfg
* Use bump2version
* Add towncrier support
* Move tasks to tox
* Fix code formatting
* Add more tests to travis
* Add pull request template
* Update contribution guide

Author: yakky

.github/pull_request_template.md

@@ -0,0 +1,18 @@
+# Description
+
+Describe:
+
+* Content of the pull request
+* Feature added / Problem fixed
+
+## References
+
+Provide any github issue fixed (as in ``Fix #XYZ``)
+
+# Checklist
+
+* [ ] I have read the [contribution guide](https://django-app-helper.readthedocs.io/en/latest/contributing.html)
+* [ ] Code lint checked via `inv lint`
+* [ ] ``changes`` file included (see [docs](https://django-app-helper.readthedocs.io/en/latest/contributing.html#pull-request-guidelines))
+* [ ] Usage documentation added in case of new features
+* [ ] Tests added

.travis.yml

@@ -12,6 +12,7 @@ python:
 env:
   matrix:
   - TOXENV='docs'
+  - TOXENV='pypi-description'
   - TOXENV='pep8'
   - TOXENV='isort'
   - TOXENV='black'
@@ -27,26 +28,24 @@ env:
   - DJANGO='django111' CMS='cms35'
   - DJANGO='django111' CMS='cms34'
 
-before_install:
-  - pip install codecov
 after_success:
   - codecov
   - coveralls
 
-# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
 install:
-  - pip install -U setuptools tox>=1.8 coveralls
+  - pip install -U setuptools tox>=1.8 coveralls codecov
   - "if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then export PYVER=py27; fi"
   - "if [[ $TRAVIS_PYTHON_VERSION == '3.5' ]]; then export PYVER=py35; fi"
   - "if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then export PYVER=py36; fi"
   - "if [[ $TRAVIS_PYTHON_VERSION == '3.7' ]]; then export PYVER=py37; fi"
   - "if [[ ${DJANGO}z != 'z' ]]; then export TOXENV=$PYVER-$DJANGO-$CMS; fi"
 
-# command to run tests, e.g. python setup.py test
 script: COMMAND='coverage run' tox -e$TOXENV
 
 matrix:
   exclude:
+  - python: 2.7
+    env: TOXENV='pypi-description'
   - python: 2.7
     env: TOXENV='docs'
   - python: 2.7
@@ -55,6 +54,8 @@ matrix:
     env: TOXENV='isort'
   - python: 2.7
     env: TOXENV='black'
+  - python: 3.6
+    env: TOXENV='pypi-description'
   - python: 3.6
     env: TOXENV='docs'
   - python: 3.6
@@ -63,6 +64,8 @@ matrix:
     env: TOXENV='isort'
   - python: 3.6
     env: TOXENV='black'
+  - python: 3.5
+    env: TOXENV='pypi-description'
   - python: 3.5
     env: TOXENV='docs'
   - python: 3.5

AUTHORS renamed to AUTHORS.rst

@@ -67,7 +67,7 @@ Ready to contribute? Here's how to set up ``django-app-helper`` for local develo
 
     $ mkvirtualenv django-app-helper
     $ cd django-app-helper/
-    $ python setup.py develop
+    $ pip install -r requirements-test.txt
 
 4. Create a branch for local development::
 
@@ -78,11 +78,9 @@ Now you can make your changes locally.
 5. When you're done making changes, check that your changes pass flake8 and the
 tests, including testing other Python versions with tox::
 
-    $ make lint
-    $ python setup.py test
     $ tox
 
-To get tox, just pip install them into your virtualenv.
+To get tox, pip install them into your virtualenv.
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -98,9 +96,26 @@ Pull Request Guidelines
 Before you submit a pull request, check that it meets these guidelines:
 
 1. The pull request should include tests.
-2. If the pull request adds functionality, the docs should be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work for all python versions declared in tox.ini.
-   Check https://travis-ci.org/nephila/django-app-helper/pull_requests
-   and make sure that the tests pass for all supported Python versions.
+2. If the pull request adds functionality, the docs should be updated.
+   Documentation must be added in ``docs`` directory, and must include usage
+   information for the end user.
+   In case of public API method, add extended docstrings with full parameters
+   description and usage example.
+3. Add a changes file in ``changes`` directory describing the contribution in
+   one line. It will be added automatically to the history file upon release.
+   File must be named as ``<issue-number>.<type>`` with type being:
+
+    * ``.feature``: For new features.
+    * ``.bugfix``: For bug fixes.
+    * ``.doc``: For documentation improvement.
+    * ``.removal``: For deprecation or removal of public API.
+    * ``.misc``: For general issues.
+
+   Check `towncrier`_ documentation for more details.
+
+4. The pull request should work for all python / django / django CMS versions
+   declared in tox.ini.
+   Check the CI and make sure that the tests pass for all supported versions.
+
+
+.. _towncrier: https://pypi.org/project/towncrier/#news-fragments

CONTRIBUTING.rst

@@ -9,110 +9,112 @@ History
 
 * Improved pytest compatibility
 
+.. towncrier release notes start
+
 2.1.0 (2019-12-27)
 ==================
 
-* Reformatted code with black and improved flake8 configuration
-* Added pytest-compatible runner
+* Reformat code with black and improve flake8 configuration
+* Add pytest-compatible runner
 
 2.0.1 (2019-12-22)
 ==================
 
-* Added Django 3.0 preliminary support
+* Add Django 3.0 preliminary support
 
 2.0.0 (2019-10-13)
 ==================
 
-* Renamed application to django-app-helper
+* Rename application to django-app-helper
 
 1.2.5 (2019-08-16)
 ==================
 
-* Added django CMS 3.7
-* Added Django 2.2
+* Add django CMS 3.7
+* Add Django 2.2
 
 1.2.4 (2019-08-08)
 ==================
 
-* Fixed regression introduced by #116
+* Fix regression introduced by #116
 
 1.2.3 (2019-08-05)
 ==================
 
-* Moved pyflakes to extras_require
-* Fixed error in get_request / post_request not preserving current_page
+* Move pyflakes to extras_require
+* Fix error in get_request / post_request not preserving current_page
 
 1.2.2 (2019-07-05)
 ==================
 
-* Improved request generation by adding a more generic request method
+* Improve request generation by adding a more generic request method
 
 1.2.1 (2019-07-04)
 ==================
 
-* Fixed error when creating users with non-writable email attribute
+* Fix error when creating users with non-writable email attribute
 
 1.2.0 (2019-03-22)
 ==================
 
-* Dropped compatiblity with Django <1.11, Python 3.4
-* Added django CMS 3.6
-* Added django 2.0, 2.1
+* Drop compatiblity with Django <1.11, Python 3.4
+* Add django CMS 3.6
+* Add django 2.0, 2.1
 
 1.1.1 (2019-07-03)
 ==================
 
-* Fixed error when creating users with non-writable email attribute
+* Fix error when creating users with non-writable email attribute
 
 1.1.0 (2018-02-20)
 ==================
 
-* Removed Django <1.8, Python 2.6, 3.3 from setup.py
-* Added Django 1.11, Python 3.6
-* Switched to new-style middlewares for Django 1.10+
-* Created static methods to generate images
-* Fixed persistent option behavior with arbitrary commands
-* Added minimal changes to allow third party application to run test on django 2.0
-* Fixed options for channels runserver
-* Removed support for django-nose test runner
+* Remove Django <1.8, Python 2.6, 3.3 from setup.py
+* Add Django 1.11, Python 3.6
+* Switch to new-style middlewares for Django 1.10+
+* Create static methods to generate images
+* Fix persistent option behavior with arbitrary commands
+* Add minimal changes to allow third party application to run test on django 2.0
+* Fix options for channels runserver
+* Remove support for django-nose test runner
 
 1.0.0 (2017-07-25)
 ==================
 
-* Added ApphookReloadMiddleware in server mode
-* Added a default for FILE_UPLOAD_TEMP_DIR
-* Added fix for django CMS 3.4.4 render_plugin
+* Add ApphookReloadMiddleware in server mode
+* Add a default for FILE_UPLOAD_TEMP_DIR
+* Add fix for django CMS 3.4.4 render_plugin
 
 0.9.8 (2017-03-04)
 ==================
 
-* Fixed compatibility with newer channels releases
+* Fix compatibility with newer channels releases
 
 0.9.7 (2016-12-03)
 ==================
 
-* Added support for django-sekizai 0.10
-* Fixed mock dependency in setup.py
-* Fixed issue with server command in Django 1.10
-* Fixed issue with urls.py in Django 1.10
-* Fixed issue in tests with django CMS 3.4
+* Add support for django-sekizai 0.10
+* Fix mock dependency in setup.py
+* Fix issue with server command in Django 1.10
+* Fix issue with urls.py in Django 1.10
+* Fix issue in tests with django CMS 3.4
 
 0.9.6 (2016-08-25)
 ==================
 
-* Added support for channels runserver.
-* Added verbosity level to server command.
-* Added support for Django 1.10.
-* Added support for django CMS 3.4.
+* Add support for channels runserver.
+* Add verbosity level to server command.
+* Add support for Django 1.10.
+* Add support for django CMS 3.4.
 
 0.9.5 (2016-06-06)
 ==================
 
-* Fixed issue with mocked session storage
-* Added verbosity level to tests
-* Fixed user creation
-* Added option to allow parametrizing auto-created user
-* Fixed extra_applications
+* Fix issue with mocked session storage
+* Add verbosity level to tests
+* Fix user creation
+* Add option to allow parametrizing auto-created user
+* Fix extra_applications
 
 0.9.4 (2016-01-20)
 ==================

HISTORY.rst

@@ -1,8 +1,9 @@
-include AUTHORS
+include AUTHORS.rst
 include LICENSE
 include README.rst
 include CONTRIBUTING.rst
 include HISTORY.rst
 include requirements.txt
+include requirements-docs.txt
 include requirements-tests.txt
 recursive-include app_helper *.html *.png *.gif *js *jpg *jpeg *svg *py *mo *po

MANIFEST.in

@@ -1,22 +1,22 @@
-.PHONY: clean-pyc clean-build docs
+.PHONY: clean-pyc clean-build docs bump-dev
 
 help:
-	@echo "clean-build - remove build artifacts"
-	@echo "clean-pyc - remove Python file artifacts"
-	@echo "lint - check style with flake8"
-	@echo "test - run tests quickly with the default Python"
-	@echo "test-all - run tests on every Python version with tox"
-	@echo "coverage - check code coverage quickly with the default Python"
-	@echo "release - package and upload a release"
-	@echo "sdist - package"
+	@echo "clean - Cleanup all artifacts"
+	@echo "clean-build - Remove build artifacts"
+	@echo "clean-pyc - Remove Python file artifacts"
+	@echo "lint - Check code style"
+	@echo "test - Run tests in current environment"
+	@echo "test-all - Run tests on every environment version with tox"
+	@echo "coverage - Check code coverage in current environment"
+	@echo "tag-dev - Create dev release"
 
 clean: clean-build clean-pyc
 
 clean-build:
 	python setup.py clean --all
 	rm -fr build/
 	rm -fr dist/
-	rm -fr *.egg-info
+	rm -fr *.egg*
 
 clean-pyc:
 	find . -name '*.pyc' -exec rm -f {} +
@@ -37,10 +37,5 @@ coverage:
 	coverage run setup.py test
 	coverage report -m
 
-release: clean
-	python setup.py clean --all sdist bdist_wheel
-	twine upload dist/*
-
-sdist: clean
-	python setup.py sdist
-	ls -l dist
+tag-dev:
+	bumpversion --list patch --message="Bump develop version [ci skip]" --no-tag

Makefile

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import, print_function, unicode_literals
 
-__version__ = "2.1.2.dev1"
+__version__ = "2.2.0.dev1"
 __author__ = "Iacopo Spalletti <[email protected]>"
 __all__ = ["runner"]
 

app_helper/__init__.py

@@ -1,4 +1,13 @@
+[build-system]
+requires = ["setuptools>=40.6.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
 [tool.black]
 line-length = 119
 target-version = ["py27"]
 include = 'app_helper/*py'
+
+[tool.towncrier]
+directory = "changes"
+filename = "HISTORY.rst"
+title_format = "{version} ({project_date})"

changes/.directory

@@ -2,9 +2,12 @@
 coverage<5.0
 coveralls
 wheel
+pep517
 tox>=1.8
 aldryn-boilerplates
 https://github.com/divio/django-filer/archive/develop.zip
 pyflakes<2.1
 pytest
 pytest-django
+bump2version
+https://github.com/hawkowl/towncrier/archive/master.zip