MAINT: Merged project template improvements.

Author: rmax

.bumpversion.cfg

@@ -1,10 +1,10 @@
 [bumpversion]
-current_version = 0.6.3dev
-commit = True
+current_version = 0.6.3-dev
+commit = False
 tag = False
-parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?P<release>dev)?
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>\w+))?
 serialize = 
-	{major}.{minor}.{patch}{release}
+	{major}.{minor}.{patch}-{release}
 	{major}.{minor}.{patch}
 
 [bumpversion:part:release]
@@ -13,9 +13,9 @@ values =
 	dev
 	placeholder
 
-[bumpversion:file:setup.py]
-search = version='{current_version}'
-replace = version='{new_version}'
+[bumpversion:file:VERSION]
+search = {current_version}
+replace = {new_version}
 
 [bumpversion:file:src/scrapy_redis/__init__.py]
 search = __version__ = '{current_version}'
@@ -25,3 +25,9 @@ replace = __version__ = '{new_version}'
 search = version: {current_version}
 replace = version: {new_version}
 
+[bumpversion:file:HISTORY.rst]
+search = .. comment:: bumpversion marker
+replace = .. comment:: bumpversion marker
+
+	{new_version} ({now:%Y-%m-%d})
+	------------------

.cookiecutterrc

@@ -4,17 +4,16 @@ cookiecutter:
     email: rolando at rmax.io
     full_name: Rolando Espinoza
     github_username: rolando
-    project_name: scrapy-redis
+    project_name: Scrapy-Redis
     project_package: scrapy_redis
     project_short_description: Redis-based components for Scrapy.
     project_slug: scrapy-redis
     pypi_username: rolando
-    release_date: '2011-09-01'
     use_codecov: y
     use_cython: n
     use_landscape: y
     use_pypi_deployment_with_travis: n
     use_pytest: y
     use_requiresio: y
-    version: 0.6.3dev
+    version: 0.6.3-dev
     year: 2011-2016

CONTRIBUTING.rst

@@ -38,8 +38,8 @@ is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-scrapy-redis could always use more documentation, whether as part of the
-official scrapy-redis docs, in docstrings, or even on the web in blog posts,
+Scrapy-Redis could always use more documentation, whether as part of the
+official Scrapy-Redis docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback

HISTORY.rst

@@ -2,9 +2,10 @@
 History
 =======
 
-0.6.3dev (Y-m-d)
-----------------
-* TODO
+.. comment:: bumpversion marker
+
+0.6.3-dev (unreleased)
+----------------------
 
 0.6.2 (2016-06-26)
 ------------------

MANIFEST.in

@@ -9,6 +9,7 @@ include *.rst
 include *.txt
 
 include LICENSE
+include VERSION
 include Makefile
 
 global-exclude __pycache__ *.py[cod]

Makefile

@@ -1,5 +1,5 @@
 .PHONY: clean-so clean-test clean-pyc clean-build clean-docs clean
-.PHONY: docs check check-manifest check-setup lint
+.PHONY: docs check check-manifest check-setup check-history lint
 .PHONY: test test-all coverage
 .PHONY: compile-reqs install-reqs
 .PHONY: release dist install build-inplace
@@ -21,6 +21,7 @@ help:
 	@echo "check - check setup, code style, setup, etc"
 	@echo "check-manifest - check manifest"
 	@echo "check-setup - check setup"
+	@echo "check-history - check history"
 	@echo "clean - remove all build, test, coverage and Python artifacts"
 	@echo "clean-build - remove build artifacts"
 	@echo "clean-docs - remove docs artifacts"
@@ -39,14 +40,20 @@ help:
 	@echo "develop - install package in develop mode"
 	@echo "install - install the package to the active Python's site-packages"
 
-check: check-setup check-manifest lint
+check: check-setup check-manifest check-history lint
 
 check-setup:
+	@echo "Checking package metadata (name, description, etc)"
 	python setup.py check --strict --metadata --restructuredtext
 
 check-manifest:
+	@echo "Checking MANIFEST.in"
 	check-manifest --ignore ".*"
 
+check-history:
+	@echo "Checking latest version in HISTORY"
+	VERSION=`cat VERSION`; grep "^$${VERSION}\b" HISTORY.rst
+
 clean: clean-build clean-docs clean-pyc clean-test clean-so
 
 clean-build:
@@ -95,7 +102,7 @@ coverage: develop
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
-docs:
+docs: develop
 	rm -f docs/scrapy_redis.rst
 	rm -f docs/modules.rst
 	sphinx-apidoc -o docs/ src/scrapy_redis
@@ -106,7 +113,10 @@ docs:
 servedocs: docs
 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 
-release: check dist
+release: clean check dist
+	# Tagging release.
+	VERSION=`cat VERSION`; git tag -a v$$VERSION
+	git push --follow-tags
 	twine upload dist/*
 
 dist: clean
@@ -124,6 +134,10 @@ requirements%.txt: requirements%.in
 	pip-compile -v $< -o $@
 
 REQUIREMENTS_TXT := $(REQUIREMENTS_IN:.in=.txt)
+ifndef REQUIREMENTS_TXT
+REQUIREMENTS_TXT := $(wildcard requirements*.txt)
+endif
+
 compile-reqs: $(REQUIREMENTS_TXT)
 	@test -z "$$REQUIREMENTS_TXT" && echo "No 'requirements*.in' files. Nothing to do"
 

VERSION

@@ -0,0 +1 @@
+0.6.3-dev

docs/conf.py

@@ -13,8 +13,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import re
 
 # If extensions (or modules to document with autodoc) are in another
 # directory, add these directories to sys.path here. If the directory is
@@ -23,15 +23,7 @@
 #sys.path.insert(0, os.path.abspath('.'))
 
 # Get the project root dir, which is the parent dir of this
-cwd = os.getcwd()
-project_root = os.path.dirname(cwd)
-
-# Insert the project root dir as the first element in the PYTHONPATH.
-# This lets us ensure that the source package is imported, and that its
-# version is used.
-sys.path.insert(0, project_root)
-
-import scrapy_redis
+project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
 # -- General configuration ---------------------------------------------
 
@@ -59,17 +51,17 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'scrapy-redis'
+project = u'Scrapy-Redis'
 copyright = u'2011-2016, Rolando Espinoza'
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout
 # the built documents.
 #
-# The short X.Y version.
-version = scrapy_redis.__version__
 # The full version, including alpha/beta/rc tags.
-release = scrapy_redis.__version__
+release = open(os.path.join(project_root, 'VERSION')).read().strip()
+# The short X.Y version.
+version = re.findall(r'\d+\.\d+\.\d+', release)[0]
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -213,7 +205,7 @@
 # [howto/manual]).
 latex_documents = [
     ('index', 'scrapy_redis.tex',
-     u'scrapy-redis Documentation',
+     u'Scrapy-Redis Documentation',
      u'Rolando Espinoza', 'manual'),
 ]
 
@@ -244,7 +236,7 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'scrapy_redis',
-     u'scrapy-redis Documentation',
+     u'Scrapy-Redis Documentation',
      [u'Rolando Espinoza'], 1)
 ]
 
@@ -259,7 +251,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     ('index', 'scrapy_redis',
-     u'scrapy-redis Documentation',
+     u'Scrapy-Redis Documentation',
      u'Rolando Espinoza',
      'scrapy-redis',
      'One line description of project.',

docs/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to scrapy-redis's documentation!
+Welcome to Scrapy-Redis's documentation!
 ======================================
 
 Contents:

docs/installation.rst

@@ -8,7 +8,7 @@ Installation
 Stable release
 --------------
 
-To install scrapy-redis, run this command in your terminal:
+To install Scrapy-Redis, run this command in your terminal:
 
 .. code-block:: console
 
@@ -24,7 +24,7 @@ you through the process.
 From sources
 ------------
 
-The sources for scrapy-redis can be downloaded from the `Github repo`_.
+The sources for Scrapy-Redis can be downloaded from the `Github repo`_.
 
 You can either clone the public repository:
 

setup.py

@@ -13,7 +13,15 @@ def find_packages(path):
 
 def read_file(filename):
     with open(filename) as fp:
-        return fp.read()
+        return fp.read().strip()
+
+
+def read_rst(filename):
+    return "".join(
+        line for line in read_file(filename).splitlines()
+        # Ignore unsupported directives by pypi.
+        if not line.startswith('.. comment::')
+    )
 
 
 def read_requirements(filename):
@@ -25,9 +33,9 @@ def read_requirements(filename):
 
 setup(
     name='scrapy-redis',
-    version='0.6.3dev',
+    version=read_file('VERSION'),
     description="Redis-based components for Scrapy.",
-    long_description=read_file('README.rst') + '\n\n' + read_file('HISTORY.rst'),
+    long_description=read_rst('README.rst') + '\n\n' + read_rst('HISTORY.rst'),
     author="Rolando Espinoza",
     author_email='rolando at rmax.io',
     url='https://github.com/rolando/scrapy-redis',

src/scrapy_redis/__init__.py

@@ -7,4 +7,4 @@
 
 __author__ = 'Rolando Espinoza'
 __email__ = 'rolando at rmax.io'
-__version__ = '0.6.3dev'
+__version__ = '0.6.3-dev'