1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
|
from paver.easy import *
from paver.release import setup_meta
import paver.doctools
import paver.virtual
import paver.misctasks
from paver.setuputils import setup
options = environment.options
setup(**setup_meta)
options(
minilib=Bunch(
extra_files=['doctools', 'virtual'],
versioned_name=False,
),
sphinx=Bunch(
builddir="build",
sourcedir="source"
),
virtualenv=Bunch(
packages_to_install=["nose", "Sphinx>=0.6b1", "docutils", "virtualenv"],
install_paver=False,
script_name='bootstrap.py',
paver_command_line=None,
dest_dir="virtualenv"
),
cog=Bunch(
includedir="docs/samples",
beginspec="<==",
endspec="==>",
endoutput="<==end==>"
),
deploy=Bunch(
deploydir="blueskyonmars.com/projects/paver"
)
)
# not only does paver bootstrap itself, but it should work even with just
# distutils
if paver.setuputils.has_setuptools:
old_sdist = "setuptools.command.sdist"
options.setup.update(dict(
install_requires=[],
test_suite='nose.collector',
zip_safe=False,
entry_points="""
[console_scripts]
paver = paver.tasks:main
"""
))
else:
old_sdist = "distutils.command.sdist"
options.setup.scripts = ['distutils_scripts/paver']
options.setup.package_data=paver.setuputils.find_package_data("paver", package="paver",
only_in_packages=False)
if paver.doctools.has_sphinx:
@task
@needs('cog', 'paver.doctools.html')
def html():
"""Build Paver's documentation and install it into paver/docs"""
builtdocs = path("docs") / options.sphinx.builddir / "html"
destdir = path("paver") / "docs"
destdir.rmtree_p()
builtdocs.move(destdir)
@task
@needs('html', "minilib", "generate_setup", old_sdist)
def sdist():
"""Builds the documentation and the tarball."""
pass
if paver.virtual.has_virtualenv:
@task
def bootstrap():
"""Build a virtualenv bootstrap for developing paver."""
# we have to pull some private api shenanigans that normal people don't
# because we're bootstrapping paver itself.
paver.virtual._create_bootstrap(options.script_name,
options.packages_to_install,
options.paver_command_line,
options.install_paver,
more_text=""" subprocess.call([join("""
"""bin_dir, 'python'), '-c', """
"""'import sys; sys.path.append("."); """
"""import paver.command; paver.command.main()', """
"""'develop'])""",
dest_dir=options.virtualenv.dest_dir)
@task
def clean():
"""Cleans up this paver directory. Removes the virtualenv traces and
the build directory."""
path("build").rmtree_p()
path("bin").rmtree_p()
path("lib").rmtree_p()
path(".Python").remove_p()
@task
@needs("uncog")
@consume_args
def commit(args):
"""Removes the generated code from the docs and then commits to bzr."""
sh("git commit " + ' '.join(args))
@task
@cmdopts([
("branch=", "b", "Branch from which to publish"),
("docs-branch=", "d", "Docs branch to commit/push to"),
("git-repo=", "g", "Github repository to use"),
("deploy-key=", "k", "Deploy key to use"),
])
def publish_docs(options):
"""Publish current docs/site do paver.github.com"""
# we are going to mess around with files, so do it in temporary place
import os
from subprocess import check_call, CalledProcessError
from tempfile import mkdtemp, mkstemp
current_repo = path(os.curdir).abspath()
branch = getattr(options, 'branch', 'master')
docs_branch = getattr(options, 'docs_branch', 'gh-pages')
repo = getattr(options, 'git_repo', 'git@github.com:paver/paver.git')
try:
safe_clone = path(mkdtemp(prefix='paver-clone-'))
docs_repo = path(mkdtemp(prefix='paver-docs-'))
fd, git = mkstemp(prefix='tmp-git-ssh-')
# TODO: I strongly believe there have to be better way to provide custom
# identity file for git, but cannot find one...so, workaround
f = os.fdopen(fd, 'w')
f.writelines(["#!/bin/sh", os.linesep, "ssh%s $*" % (" -i "+options.deploy_key if getattr(options, "deploy_key", None) else "")])
f.close()
os.chmod(git, int('777', 8))
safe_clone.chdir()
sh('git init')
check_call(['git', 'remote', 'add', '-t', branch, '-f', 'origin', 'file://'+str(current_repo)], env={"GIT_SSH" : git})
check_call(['git', 'checkout', branch], env={"GIT_SSH" : git})
check_call(['python', os.path.join(str(current_repo), "distutils_scripts", "paver"), 'html'], env={
'PYTHONPATH' : os.path.join(str(current_repo))
})
docs_repo.chdir()
sh('git init')
check_call(['git', 'remote', 'add', '-t', docs_branch, '-f', 'origin', repo], env={"GIT_SSH" : git})
check_call(['git', 'checkout', docs_branch], env={"GIT_SSH" : git})
check_call(['rsync', '-av', os.path.join(str(safe_clone), 'paver', 'docs')+'/', str(docs_repo)])
sh('git add *')
#TODO: '...from revision abc'
try:
check_call(['git', 'commit', '-a', '-m', "Commit auto-generated documentation"])
except CalledProcessError:
# usually 'working directory clean'
pass
else:
check_call(['git', 'push', 'origin', '%s:%s' % (docs_branch, docs_branch)], env={"GIT_SSH" : git})
finally:
safe_clone.rmtree_p()
docs_repo.rmtree_p()
os.remove(git)
@task
def release():
""" Release new version of Paver """
# To avoid dirty workdirs and various artifacts, offload complete environment
# to temporary directory located outside of current worktree
import os
from subprocess import check_call, CalledProcessError
from tempfile import mkdtemp, mkstemp
release_clone = path(mkdtemp(prefix='paver-release-'))
current_repo = path(os.curdir).abspath()
branch = getattr(options, 'branch', 'master')
# clone current branch to temporary directory
try:
release_clone.chdir()
sh('git init')
check_call(['git', 'remote', 'add', '-t', branch, '-f', 'origin', 'file://'+str(current_repo)])
check_call(['git', 'checkout', '-b', branch, "origin/%s" % branch])
# install release requirements to be sure we are generating everything properly
sh('pip install -r release-requirements.txt')
# build documentation
sh('paver html')
# create source directory
sh('paver sdist')
# create source directory and upload it to PyPI
sh('paver sdist upload')
# also upload sphinx documentation
sh('paver upload_sphinx --upload-dir=paver/docs')
finally:
release_clone.rmtree_p()
@task
@consume_args
def bump(args):
import paver.version
version = map(int, paver.version.VERSION.split('.')[0:3])
if len(args) > 0 and args[0] == 'major':
version[1] += 1
else:
version[2] += 1
version = map(str, version)
module_content = "VERSION='%s'\n" % '.'.join(version)
# bump version in paver
with open(path('paver/version.py'), 'w') as f:
f.write(module_content)
# bump version in sphinx
conf = []
with open(path('docs/source/conf.py'), 'r') as f:
for line in f.readlines():
if line.startswith('version = '):
line = "version = '%s'\n" % '.'.join(version[0:2])
elif line.startswith('release = '):
line = "release = '%s'" % '.'.join(version[0:3])
conf.append(line)
with open(path('docs/source/conf.py'), 'w') as f:
f.writelines(conf)
|