January 2014 - tor-commits - lists.torproject.org

[bridgedb/master] Bump the Twisted version.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 32e782b204bcc6b23ee1108de2bc2ef897ce4de1 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Oct 3 06:23:54 2013 +0000 Bump the Twisted version. --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 1695106..979417b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,7 +2,7 @@ Babel==0.9.6 BeautifulSoup==3.2.1 Mako==0.8.1 MarkupSafe==0.18 -Twisted>=13.0.0 +Twisted==13.1.0 argparse>=1.2.1 distribute>=0.6.46 ipaddr>=2.1.10

1 0

[bridgedb/master] Remove deprecated distribute dependency.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit b18fa86e214b1afeb5fd150c5806084e98088fd2 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Oct 3 06:24:40 2013 +0000 Remove deprecated distribute dependency. --- requirements.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 979417b..013e608 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,7 +4,6 @@ Mako==0.8.1 MarkupSafe==0.18 Twisted==13.1.0 argparse>=1.2.1 -distribute>=0.6.46 ipaddr>=2.1.10 pyOpenSSL>=0.13 pygeoip>=0.2.6

1 0

[bridgedb/master] Select language and language direction based on order in header
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 34fa53060d93a4709ba8dfd63194cd798427260e Author: Matthew Finkel <Matthew.Finkel(a)gmail.com> Date: Sun Jun 30 05:03:08 2013 +0000 Select language and language direction based on order in header We guess which language gettext will choose by iterating over the languages in the Language header and selecting the first one we support. We assume a user will prioritize languages in their browser. We then render the page using the selected language, or English if it is no available. Bug fix on #9157. (cherry picked from commit a31c592eadd72a659f22497f66e77fb90c6c207b) Signed-off-by: Isis Lovecruft <isis(a)torproject.org> Taken from branch 'sysrqb/bug9157_r2_rebased'. --- lib/bridgedb/HTTPServer.py | 65 +++++++++++++++++++++++++++--- lib/bridgedb/templates/assets/custom.css | 15 ++++++- lib/bridgedb/templates/base.html | 14 +++++++ lib/bridgedb/templates/bridges.html | 8 +++- lib/bridgedb/templates/index.html | 41 ++++++++++++------- 5 files changed, 120 insertions(+), 23 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 6b469cc..ea4dea7 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -19,6 +19,7 @@ import twisted.web.resource from twisted.web.server import Site from twisted.web import static from twisted.web.util import redirectTo +from twisted.python import filepath import bridgedb.Dist import bridgedb.I18n as I18n @@ -38,6 +39,7 @@ from zope.interface import Interface, Attribute, implements template_root = os.path.join(os.path.dirname(__file__),'templates') lookup = TemplateLookup(directories=[template_root], output_encoding='utf-8') +rtl_langs = ('ar', 'he', 'fa', 'gu_IN', 'ku') logging.debug("Set template root to %s" % template_root) @@ -152,7 +154,7 @@ class WebResource(twisted.web.resource.Resource): countryCode = geoip.country_code_by_addr(ip) # set locale - setLocaleFromRequestHeader(request) + rtl = usingRTLLang(request) format = request.args.get("format", None) if format and len(format): format = format[0] # choose the first arg @@ -217,13 +219,13 @@ class WebResource(twisted.web.resource.Resource): return answer else: request.setHeader("Content-Type", "text/html; charset=utf-8") - return lookup.get_template('bridges.html').render(answer=answer) + return lookup.get_template('bridges.html').render(answer=answer, rtl=rtl) class WebRoot(twisted.web.resource.Resource): isLeaf = True def render_GET(self, request): - setLocaleFromRequestHeader(request) - return lookup.get_template('index.html').render() + rtl = usingRTLLang(request) + return lookup.get_template('index.html').render(rtl=rtl) def addWebServer(cfg, dist, sched): """Set up a web server. @@ -277,13 +279,65 @@ def addWebServer(cfg, dist, sched): return site +def usingRTLLang(request): + """ + Check if we should translate the text into a RTL language + + Retrieve the headers from the request. Obtain the Accept-Language header + and decide if we need to translate the text. Install the requisite + languages via gettext, if so. Then, manually check which languages we + support. Choose the first language from the header that we support and + return True if it is a RTL language, else return False. + + :param request twisted.web.server.Request: Incoming request + :returns bool: Language is right-to-left + """ + langs = setLocaleFromRequestHeader(request) + + # Grab only the language (first two characters) so we know if the language + # is read right-to-left + #langs = [ lang[:2] for lang in langs ] + lang = getAssumedChosenLang(langs) + if lang in rtl_langs: + return True + return False + +def getAssumedChosenLang(langs): + """ + Return the first language in ``langs`` and we supprt + + :param langs list: All requested languages + :returns string: Chosen language + """ + i18npath = os.path.join(os.path.dirname(__file__), 'i18n') + path = filepath.FilePath(i18npath) + assert path.isdir() + + lang = 'en-US' + supp_langs = path.listdir() + ['en'] + for l in langs: + if l in supp_langs: + lang = l + break + return lang + def setLocaleFromRequestHeader(request): + """ + Retrieve the languages from the accept-language header and insall + + Parse the languages in the header, if any of them contain locales then + add their languages to the list, also. Then install all of them using + gettext, it will choose the best one. + + :param request twisted.web.server.Request: Incoming request + :returns list: All requested languages + """ langs = request.getHeader('accept-language').split(',') logging.debug("Accept-Language: %s" % langs) localedir=os.path.join(os.path.dirname(__file__), 'i18n/') if langs: - langs = filter(lambda x: re.match('^[a-z\-]{1,5}$', x), langs) + langs = filter(lambda x: re.match('^[a-z\-]{1,5}', x), langs) logging.debug("Languages: %s" % langs) # add fallback languages langs_only = filter(lambda x: '-' in x, langs) @@ -293,3 +347,4 @@ def setLocaleFromRequestHeader(request): lang = gettext.translation("bridgedb", localedir=localedir, languages=langs, fallback=True) lang.install(True) + return langs diff --git a/lib/bridgedb/templates/assets/custom.css b/lib/bridgedb/templates/assets/custom.css index e46ed9b..bc0e2d1 100644 --- a/lib/bridgedb/templates/assets/custom.css +++ b/lib/bridgedb/templates/assets/custom.css @@ -88,4 +88,17 @@ font-weight: 100; font-size: 18px; line-height: 30px; margin-top: 2px; -} \ No newline at end of file +} +.lead_right { + margin-bottom: 20px; + font-size: 21px; + font-weight: 200; + line-height: 30px +} +[class*="bdb_span"] { + min-height: 1px; + margin: 0 20px 22px 20px; +} +.bdb_span7 { + width: 560px +} diff --git a/lib/bridgedb/templates/base.html b/lib/bridgedb/templates/base.html index e9a13b8..629680e 100644 --- a/lib/bridgedb/templates/base.html +++ b/lib/bridgedb/templates/base.html @@ -11,6 +11,20 @@  <link href="/assets/bootstrap.min.css" rel="stylesheet"> <link href="/assets/custom.css" rel="stylesheet"> + +% if rtl: +<style> +span,p,h3,h4 { + text-align: right; + direction: rtl; +} + +span { + float: right; +} +</style> +%endif + </head> <body> <div class="container-narrow"> diff --git a/lib/bridgedb/templates/bridges.html b/lib/bridgedb/templates/bridges.html index 44cd365..7bb0a79 100644 --- a/lib/bridgedb/templates/bridges.html +++ b/lib/bridgedb/templates/bridges.html @@ -7,8 +7,12 @@ <pre> ${answer} </pre> -<br /> -<p>${_("""To use the above lines, go to Vidalia's Network settings page, and click "My ISP blocks connections to the Tor network". Then add each bridge address one at a time.""")} +<br \> +<p> +<p> +${_("""To use the above lines, go to Vidalia's Network settings page, and """ \ + """click "My ISP blocks connections to the Tor network". Then add """ \ + """each bridge address one at a time.""")} </p> % else: <h3> ${_("No bridges currently available")} </h3> diff --git a/lib/bridgedb/templates/index.html b/lib/bridgedb/templates/index.html index 2839e1a..82522c8 100644 --- a/lib/bridgedb/templates/index.html +++ b/lib/bridgedb/templates/index.html @@ -3,23 +3,34 @@ <div class="main-steps"> <div class="step row"> - <div class="span1"> - <p class="lead"><span class="step-title"> ${_("Step 1")} </span></p></div> - <div class="span5 step-text"> - ${_("Get the %s Pluggable Transports Tor Browser Bundle %s") % \ -("""<a href="https://www.torproject.org/projects/obfsproxy.html.en#download">""", "</a>")}</div> + <div class="bdb_span7 step-text"> + <span class="lead"> + <span class="step-title"> + ${_("Step 1")}</span> + <span style="margin-left: 20px;"> + ${_("Get the %s Pluggable Transports Tor Browser Bundle %s") % \ + ("""<a href="https://www.torproject.org/projects/obfsproxy.html.en#download">""", "</a>")}</span> + </span></div> </div> + <div class="step row"> - <div class="span1"> - <p class="lead"><span class="step-title"> ${_("Step 2")} </span></p></div> - <div class="span5 step-text"> - ${_("Get %s bridges %s") % ("""<a href="/bridges">""", "</a>")}</div> + <div class="bdb_span7 step-text"> + <span class="lead"> + <span class="step-title"> + ${_("Step 2")} </span> + <span style="margin-left: 20px;"> + ${_("Get %s bridges %s") % ("""<a href="/bridges">""", "</a>")}</span> + </span></div> </div> + <div class="step row"> - <div class="span1"> - <p class="lead"><span class="step-title"> ${_("Step 3")} </span></p></div> - <div class="span5 step-text"> - ${_("Now %s add the bridges to Tor %s") % \ - ("""<a href="https://www.torproject.org/docs/bridges#UsingBridges">""", "</a>")} - </div> + <div class="bdb_span7 step-text"> + <span class="lead"> + <span class="step-title"> + ${_("Step 3")}</span> + <span style="margin-left: 20px;"> + ${_("Now %s add the bridges to Tor %s") % \ + ("""<a href="https://www.torproject.org/docs/bridges#UsingBridges">""", "</a>")}</span> +</span></div> </div> +

1 0

[bridgedb/master] Start using automatic versioning system.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 7227e6e47c7161d7639a27fd206be64aafae8549 Author: Isis Lovecruft <isis(a)torproject.org> Date: Mon Aug 19 22:14:38 2013 +0000 Start using automatic versioning system. * FIXES part of #9425 (Create and document a better BridgeDB deployment strategy). * ADD versioneer.py to the top level of the project. * USE setuptools explicitly in setup.py, which will also make the project a bit more py3k compatible. * ADD maintainer and maintainer_email fields to setup.py setup() call (with my contact info). * ADD versioneer setup variables and calls to setup.py. Versioneer, as currently configured, will automatically create a package level attribute: >>> import bridgedb >>> print bridgedb.__version__ 0.0.1 Bumping the version number at release time (which, for BridgeDB really means deploy time, as of right now) means doing the following: $ git checkout develop [merge some fix/bug/feature/etc branches] $ git checkout -b release-0.0.2 develop $ git tag -a -s bridgedb-0.0.2 [pip maintainance commands *would* go here, if we ever have any] $ git checkout master $ git merge -S --no-ff release-0.0.2 $ git checkout develop $ git merge -S --no-ff master $ git push <remote> master develop And be sure not to forget to do: $ git push --tags If the currently installed version is *not* from one of the signed tags, the version number attribute created by versioneer will be the short ID of the git commit from which the installation took place, prefixed with the most recent tagged release at that point, i.e.: >>> import bridgedb >>> bridgedb.__version__ 0.0.1-git528ff30c --- .gitattributes | 1 + lib/bridgedb/__init__.py | 4 + lib/bridgedb/_version.py | 197 ++++++++++++++ setup.py | 73 ++++-- versioneer.py | 656 ++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 906 insertions(+), 25 deletions(-) diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..0e02de6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +lib/bridgedb/_version.py export-subst diff --git a/lib/bridgedb/__init__.py b/lib/bridgedb/__init__.py index 1fad2ad..3979b43 100644 --- a/lib/bridgedb/__init__.py +++ b/lib/bridgedb/__init__.py @@ -1,2 +1,6 @@ # This file tells Python that this is an honest to goodness package. + +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions diff --git a/lib/bridgedb/_version.py b/lib/bridgedb/_version.py new file mode 100644 index 0000000..8e9faf1 --- /dev/null +++ b/lib/bridgedb/_version.py @@ -0,0 +1,197 @@ + +IN_LONG_VERSION_PY = True +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (build by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.7+ (https://github.com/warner/python-versioneer) + +# these strings will be replaced by git during git-archive +git_refnames = "$Format:%d$" +git_full = "$Format:%H$" + + +import subprocess +import sys + +def run_command(args, cwd=None, verbose=False): + try: + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen(args, stdout=subprocess.PIPE, cwd=cwd) + except EnvironmentError: + e = sys.exc_info()[1] + if verbose: + print("unable to run %s" % args[0]) + print(e) + return None + stdout = p.communicate()[0].strip() + if sys.version >= '3': + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % args[0]) + return None + return stdout + + +import sys +import re +import os.path + +def get_expanded_variables(versionfile_source): + # the code embedded in _version.py can just fetch the value of these + # variables. When used from setup.py, we don't want to import + # _version.py, so we do it with a regexp instead. This function is not + # used from _version.py. + variables = {} + try: + for line in open(versionfile_source,"r").readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["full"] = mo.group(1) + except EnvironmentError: + pass + return variables + +def versions_from_expanded_variables(variables, tag_prefix, verbose=False): + refnames = variables["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("variables are unexpanded, not using") + return {} # unexpanded, so not in an unpacked git-archive tarball + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + for ref in list(refs): + if not re.search(r'\d', ref): + if verbose: + print("discarding '%s', no digits" % ref) + refs.discard(ref) + # Assume all version tags have a digit. git's %d expansion + # behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us + # distinguish between branches and tags. By ignoring refnames + # without digits, we filter out many common branch names like + # "release" and "stabilization", as well as "HEAD" and "master". + if verbose: + print("remaining refs: %s" % ",".join(sorted(refs))) + for ref in sorted(refs): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return { "version": r, + "full": variables["full"].strip() } + # no suitable tags, so we use the full revision id + if verbose: + print("no suitable tags, using full revision id") + return { "version": variables["full"].strip(), + "full": variables["full"].strip() } + +def versions_from_vcs(tag_prefix, versionfile_source, verbose=False): + # this runs 'git' from the root of the source tree. That either means + # someone ran a setup.py command (and this code is in versioneer.py, so + # IN_LONG_VERSION_PY=False, thus the containing directory is the root of + # the source tree), or someone ran a project-specific entry point (and + # this code is in _version.py, so IN_LONG_VERSION_PY=True, thus the + # containing directory is somewhere deeper in the source tree). This only + # gets called if the git-archive 'subst' variables were *not* expanded, + # and _version.py hasn't already been rewritten with a short version + # string, meaning we're inside a checked out source tree. + + try: + here = os.path.abspath(__file__) + except NameError: + # some py2exe/bbfreeze/non-CPython implementations don't do __file__ + return {} # not always correct + + # versionfile_source is the relative path from the top of the source tree + # (where the .git directory might live) to this file. Invert this to find + # the root from __file__. + root = here + if IN_LONG_VERSION_PY: + for i in range(len(versionfile_source.split("/"))): + root = os.path.dirname(root) + else: + root = os.path.dirname(here) + if not os.path.exists(os.path.join(root, ".git")): + if verbose: + print("no .git in %s" % root) + return {} + + GIT = "git" + if sys.platform == "win32": + GIT = "git.cmd" + stdout = run_command([GIT, "describe", "--tags", "--dirty", "--always"], + cwd=root) + if stdout is None: + return {} + if not stdout.startswith(tag_prefix): + if verbose: + print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix)) + return {} + tag = stdout[len(tag_prefix):] + stdout = run_command([GIT, "rev-parse", "HEAD"], cwd=root) + if stdout is None: + return {} + full = stdout.strip() + if tag.endswith("-dirty"): + full += "-dirty" + return {"version": tag, "full": full} + + +def versions_from_parentdir(parentdir_prefix, versionfile_source, verbose=False): + if IN_LONG_VERSION_PY: + # We're running from _version.py. If it's from a source tree + # (execute-in-place), we can work upwards to find the root of the + # tree, and then check the parent directory for a version string. If + # it's in an installed application, there's no hope. + try: + here = os.path.abspath(__file__) + except NameError: + # py2exe/bbfreeze/non-CPython don't have __file__ + return {} # without __file__, we have no hope + # versionfile_source is the relative path from the top of the source + # tree to _version.py. Invert this to find the root from __file__. + root = here + for i in range(len(versionfile_source.split("/"))): + root = os.path.dirname(root) + else: + # we're running from versioneer.py, which means we're running from + # the setup.py in a source tree. sys.argv[0] is setup.py in the root. + here = os.path.abspath(sys.argv[0]) + root = os.path.dirname(here) + + # Source tarballs conventionally unpack into a directory that includes + # both the project name and a version string. + dirname = os.path.basename(root) + if not dirname.startswith(parentdir_prefix): + if verbose: + print("guessing rootdir is '%s', but '%s' doesn't start with prefix '%s'" % + (root, dirname, parentdir_prefix)) + return None + return {"version": dirname[len(parentdir_prefix):], "full": ""} + +tag_prefix = "bridgedb-" +parentdir_prefix = "bridgedb-" +versionfile_source = "lib/bridgedb/_version.py" + +def get_versions(default={"version": "unknown", "full": ""}, verbose=False): + variables = { "refnames": git_refnames, "full": git_full } + ver = versions_from_expanded_variables(variables, tag_prefix, verbose) + if not ver: + ver = versions_from_vcs(tag_prefix, versionfile_source, verbose) + if not ver: + ver = versions_from_parentdir(parentdir_prefix, versionfile_source, + verbose) + if not ver: + ver = default + return ver + diff --git a/setup.py b/setup.py index ae1e126..3a1f737 100644 --- a/setup.py +++ b/setup.py @@ -6,8 +6,8 @@ import subprocess from distutils.command.install_data import install_data as _install_data import os +import setuptools import sys -from setuptools import setup, Command, find_packages # Fix circular dependency with setup.py install try: @@ -16,6 +16,30 @@ try: except ImportError: compile_catalog = extract_messages = init_catalog = update_catalog = None +# setup automatic versioning (see top-level versioneer.py file): +import versioneer +versioneer.versionfile_source = 'lib/bridgedb/_version.py' +versioneer.versionfile_build = 'bridgedb/_version.py' +versioneer.tag_prefix = 'bridgedb-' # tags should be like 'bridgedb-0.1.0' +versioneer.parentdir_prefix = 'bridgedb-' # tarballs unpack to 'bridgedb-0.1.0' + +def get_cmdclass(): + """Get our cmdclass dictionary for use in setuptool.setup(). + + This must be done outside the call to setuptools.setup() because we need + to add our own classes to the cmdclass dictionary, and then update that + dictionary with the one returned from versioneer.get_cmdclass(). + """ + cmdclass={'test' : runTests, + 'compile_catalog': compile_catalog, + 'extract_messages': extract_messages, + 'init_catalog': init_catalog, + 'update_catalog': update_catalog, + 'install_data': installData} + cmdclass.update(versioneer.get_cmdclass()) + return cmdclass + + class installData(_install_data): def run(self): self.data_files = [] @@ -28,7 +52,7 @@ class installData(_install_data): self.data_files.append( (lang_dir, [lang_file]) ) _install_data.run(self) -class runTests(Command): +class runTests(setuptools.Command): # Based on setup.py from mixminion, which is based on setup.py # from Zooko's pyutil package, which is in turn based on # http://mail.python.org/pipermail/distutils-sig/2002-January/002714.html @@ -53,27 +77,26 @@ class runTests(Command): finally: sys.path = old_path -setup(name='BridgeDB', - version='0.1', - description='Bridge disbursal tool for use with Tor anonymity network', - author='Nick Mathewson', - author_email='nickm at torproject dot org', - url='https://www.torproject.org', - package_dir= {'' : 'lib'}, - packages=find_packages('lib'), - py_modules=['TorBridgeDB'], - cmdclass={'test' : runTests, - 'compile_catalog': compile_catalog, - 'extract_messages': extract_messages, - 'init_catalog': init_catalog, - 'update_catalog': update_catalog, - 'install_data': installData}, - include_package_data=True, - package_data={'bridgedb': ['i18n/*/LC_MESSAGES/*.mo', - 'templates/*.html', - 'templates/assets/*']}, - message_extractors = {'lib/bridgedb': [ - ('**.py', 'python', None), - ('templates/**.html', 'mako', None), - ('public/**', 'ignore', None)]}, + +setuptools.setup( + name='bridgedb', + version=versioneer.get_version(), + description='Backend systems for distribution of Tor bridge relays', + author='Nick Mathewson', + author_email='nickm at torproject dot org', + maintainer='Isis Agora Lovecruft', + maintainer_email='isis(a)torproject.org 0xA3ADB67A2CDB8B35', + url='https://www.torproject.org', + package_dir= {'' : 'lib'}, + packages=setuptools.find_packages('lib'), + py_modules=['TorBridgeDB'], + cmdclass=get_cmdclass(), + include_package_data=True, + package_data={'bridgedb': ['i18n/*/LC_MESSAGES/*.mo', + 'templates/*.html', + 'templates/assets/*']}, + message_extractors = {'lib/bridgedb': [ + ('**.py', 'python', None), + ('templates/**.html', 'mako', None), + ('public/**', 'ignore', None)]}, ) diff --git a/versioneer.py b/versioneer.py new file mode 100644 index 0000000..57d9941 --- /dev/null +++ b/versioneer.py @@ -0,0 +1,656 @@ +#! /usr/bin/python + +"""versioneer.py + +(like a rocketeer, but for versions) + +* https://github.com/warner/python-versioneer +* Brian Warner +* License: Public Domain +* Version: 0.7+ + +This file helps distutils-based projects manage their version number by just +creating version-control tags. + +For developers who work from a VCS-generated tree (e.g. 'git clone' etc), +each 'setup.py version', 'setup.py build', 'setup.py sdist' will compute a +version number by asking your version-control tool about the current +checkout. The version number will be written into a generated _version.py +file of your choosing, where it can be included by your __init__.py + +For users who work from a VCS-generated tarball (e.g. 'git archive'), it will +compute a version number by looking at the name of the directory created when +te tarball is unpacked. This conventionally includes both the name of the +project and a version number. + +For users who work from a tarball built by 'setup.py sdist', it will get a +version number from a previously-generated _version.py file. + +As a result, loading code directly from the source tree will not result in a +real version. If you want real versions from VCS trees (where you frequently +update from the upstream repository, or do new development), you will need to +do a 'setup.py version' after each update, and load code from the build/ +directory. + +You need to provide this code with a few configuration values: + + versionfile_source: + A project-relative pathname into which the generated version strings + should be written. This is usually a _version.py next to your project's + main __init__.py file. If your project uses src/myproject/__init__.py, + this should be 'src/myproject/_version.py'. This file should be checked + in to your VCS as usual: the copy created below by 'setup.py + update_files' will include code that parses expanded VCS keywords in + generated tarballs. The 'build' and 'sdist' commands will replace it with + a copy that has just the calculated version string. + + versionfile_build: + Like versionfile_source, but relative to the build directory instead of + the source directory. These will differ when your setup.py uses + 'package_dir='. If you have package_dir={'myproject': 'src/myproject'}, + then you will probably have versionfile_build='myproject/_version.py' and + versionfile_source='src/myproject/_version.py'. + + tag_prefix: a string, like 'PROJECTNAME-', which appears at the start of all + VCS tags. If your tags look like 'myproject-1.2.0', then you + should use tag_prefix='myproject-'. If you use unprefixed tags + like '1.2.0', this should be an empty string. + + parentdir_prefix: a string, frequently the same as tag_prefix, which + appears at the start of all unpacked tarball filenames. If + your tarball unpacks into 'myproject-1.2.0', this should + be 'myproject-'. + +To use it: + + 1: include this file in the top level of your project + 2: make the following changes to the top of your setup.py: + import versioneer + versioneer.versionfile_source = 'src/myproject/_version.py' + versioneer.versionfile_build = 'myproject/_version.py' + versioneer.tag_prefix = '' # tags are like 1.2.0 + versioneer.parentdir_prefix = 'myproject-' # dirname like 'myproject-1.2.0' + 3: add the following arguments to the setup() call in your setup.py: + version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass(), + 4: run 'setup.py update_files', which will create _version.py, and will + append the following to your __init__.py: + from _version import __version__ + 5: modify your MANIFEST.in to include versioneer.py + 6: add both versioneer.py and the generated _version.py to your VCS +""" + +import os, sys, re +from distutils.core import Command +from distutils.command.sdist import sdist as _sdist +from distutils.command.build import build as _build + +versionfile_source = None +versionfile_build = None +tag_prefix = None +parentdir_prefix = None + +VCS = "git" +IN_LONG_VERSION_PY = False + + +LONG_VERSION_PY = ''' +IN_LONG_VERSION_PY = True +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (build by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.7+ (https://github.com/warner/python-versioneer) + +# these strings will be replaced by git during git-archive +git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" +git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" + + +import subprocess +import sys + +def run_command(args, cwd=None, verbose=False): + try: + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen(args, stdout=subprocess.PIPE, cwd=cwd) + except EnvironmentError: + e = sys.exc_info()[1] + if verbose: + print("unable to run %%s" %% args[0]) + print(e) + return None + stdout = p.communicate()[0].strip() + if sys.version >= '3': + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %%s (error)" %% args[0]) + return None + return stdout + + +import sys +import re +import os.path + +def get_expanded_variables(versionfile_source): + # the code embedded in _version.py can just fetch the value of these + # variables. When used from setup.py, we don't want to import + # _version.py, so we do it with a regexp instead. This function is not + # used from _version.py. + variables = {} + try: + for line in open(versionfile_source,"r").readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["full"] = mo.group(1) + except EnvironmentError: + pass + return variables + +def versions_from_expanded_variables(variables, tag_prefix, verbose=False): + refnames = variables["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("variables are unexpanded, not using") + return {} # unexpanded, so not in an unpacked git-archive tarball + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + for ref in list(refs): + if not re.search(r'\d', ref): + if verbose: + print("discarding '%%s', no digits" %% ref) + refs.discard(ref) + # Assume all version tags have a digit. git's %%d expansion + # behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us + # distinguish between branches and tags. By ignoring refnames + # without digits, we filter out many common branch names like + # "release" and "stabilization", as well as "HEAD" and "master". + if verbose: + print("remaining refs: %%s" %% ",".join(sorted(refs))) + for ref in sorted(refs): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %%s" %% r) + return { "version": r, + "full": variables["full"].strip() } + # no suitable tags, so we use the full revision id + if verbose: + print("no suitable tags, using full revision id") + return { "version": variables["full"].strip(), + "full": variables["full"].strip() } + +def versions_from_vcs(tag_prefix, versionfile_source, verbose=False): + # this runs 'git' from the root of the source tree. That either means + # someone ran a setup.py command (and this code is in versioneer.py, so + # IN_LONG_VERSION_PY=False, thus the containing directory is the root of + # the source tree), or someone ran a project-specific entry point (and + # this code is in _version.py, so IN_LONG_VERSION_PY=True, thus the + # containing directory is somewhere deeper in the source tree). This only + # gets called if the git-archive 'subst' variables were *not* expanded, + # and _version.py hasn't already been rewritten with a short version + # string, meaning we're inside a checked out source tree. + + try: + here = os.path.abspath(__file__) + except NameError: + # some py2exe/bbfreeze/non-CPython implementations don't do __file__ + return {} # not always correct + + # versionfile_source is the relative path from the top of the source tree + # (where the .git directory might live) to this file. Invert this to find + # the root from __file__. + root = here + if IN_LONG_VERSION_PY: + for i in range(len(versionfile_source.split("/"))): + root = os.path.dirname(root) + else: + root = os.path.dirname(here) + if not os.path.exists(os.path.join(root, ".git")): + if verbose: + print("no .git in %%s" %% root) + return {} + + GIT = "git" + if sys.platform == "win32": + GIT = "git.cmd" + stdout = run_command([GIT, "describe", "--tags", "--dirty", "--always"], + cwd=root) + if stdout is None: + return {} + if not stdout.startswith(tag_prefix): + if verbose: + print("tag '%%s' doesn't start with prefix '%%s'" %% (stdout, tag_prefix)) + return {} + tag = stdout[len(tag_prefix):] + stdout = run_command([GIT, "rev-parse", "HEAD"], cwd=root) + if stdout is None: + return {} + full = stdout.strip() + if tag.endswith("-dirty"): + full += "-dirty" + return {"version": tag, "full": full} + + +def versions_from_parentdir(parentdir_prefix, versionfile_source, verbose=False): + if IN_LONG_VERSION_PY: + # We're running from _version.py. If it's from a source tree + # (execute-in-place), we can work upwards to find the root of the + # tree, and then check the parent directory for a version string. If + # it's in an installed application, there's no hope. + try: + here = os.path.abspath(__file__) + except NameError: + # py2exe/bbfreeze/non-CPython don't have __file__ + return {} # without __file__, we have no hope + # versionfile_source is the relative path from the top of the source + # tree to _version.py. Invert this to find the root from __file__. + root = here + for i in range(len(versionfile_source.split("/"))): + root = os.path.dirname(root) + else: + # we're running from versioneer.py, which means we're running from + # the setup.py in a source tree. sys.argv[0] is setup.py in the root. + here = os.path.abspath(sys.argv[0]) + root = os.path.dirname(here) + + # Source tarballs conventionally unpack into a directory that includes + # both the project name and a version string. + dirname = os.path.basename(root) + if not dirname.startswith(parentdir_prefix): + if verbose: + print("guessing rootdir is '%%s', but '%%s' doesn't start with prefix '%%s'" %% + (root, dirname, parentdir_prefix)) + return None + return {"version": dirname[len(parentdir_prefix):], "full": ""} + +tag_prefix = "%(TAG_PREFIX)s" +parentdir_prefix = "%(PARENTDIR_PREFIX)s" +versionfile_source = "%(VERSIONFILE_SOURCE)s" + +def get_versions(default={"version": "unknown", "full": ""}, verbose=False): + variables = { "refnames": git_refnames, "full": git_full } + ver = versions_from_expanded_variables(variables, tag_prefix, verbose) + if not ver: + ver = versions_from_vcs(tag_prefix, versionfile_source, verbose) + if not ver: + ver = versions_from_parentdir(parentdir_prefix, versionfile_source, + verbose) + if not ver: + ver = default + return ver + +''' + + +import subprocess +import sys + +def run_command(args, cwd=None, verbose=False): + try: + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen(args, stdout=subprocess.PIPE, cwd=cwd) + except EnvironmentError: + e = sys.exc_info()[1] + if verbose: + print("unable to run %s" % args[0]) + print(e) + return None + stdout = p.communicate()[0].strip() + if sys.version >= '3': + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % args[0]) + return None + return stdout + + +import sys +import re +import os.path + +def get_expanded_variables(versionfile_source): + # the code embedded in _version.py can just fetch the value of these + # variables. When used from setup.py, we don't want to import + # _version.py, so we do it with a regexp instead. This function is not + # used from _version.py. + variables = {} + try: + for line in open(versionfile_source,"r").readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["full"] = mo.group(1) + except EnvironmentError: + pass + return variables + +def versions_from_expanded_variables(variables, tag_prefix, verbose=False): + refnames = variables["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("variables are unexpanded, not using") + return {} # unexpanded, so not in an unpacked git-archive tarball + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + for ref in list(refs): + if not re.search(r'\d', ref): + if verbose: + print("discarding '%s', no digits" % ref) + refs.discard(ref) + # Assume all version tags have a digit. git's %d expansion + # behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us + # distinguish between branches and tags. By ignoring refnames + # without digits, we filter out many common branch names like + # "release" and "stabilization", as well as "HEAD" and "master". + if verbose: + print("remaining refs: %s" % ",".join(sorted(refs))) + for ref in sorted(refs): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return { "version": r, + "full": variables["full"].strip() } + # no suitable tags, so we use the full revision id + if verbose: + print("no suitable tags, using full revision id") + return { "version": variables["full"].strip(), + "full": variables["full"].strip() } + +def versions_from_vcs(tag_prefix, versionfile_source, verbose=False): + # this runs 'git' from the root of the source tree. That either means + # someone ran a setup.py command (and this code is in versioneer.py, so + # IN_LONG_VERSION_PY=False, thus the containing directory is the root of + # the source tree), or someone ran a project-specific entry point (and + # this code is in _version.py, so IN_LONG_VERSION_PY=True, thus the + # containing directory is somewhere deeper in the source tree). This only + # gets called if the git-archive 'subst' variables were *not* expanded, + # and _version.py hasn't already been rewritten with a short version + # string, meaning we're inside a checked out source tree. + + try: + here = os.path.abspath(__file__) + except NameError: + # some py2exe/bbfreeze/non-CPython implementations don't do __file__ + return {} # not always correct + + # versionfile_source is the relative path from the top of the source tree + # (where the .git directory might live) to this file. Invert this to find + # the root from __file__. + root = here + if IN_LONG_VERSION_PY: + for i in range(len(versionfile_source.split("/"))): + root = os.path.dirname(root) + else: + root = os.path.dirname(here) + if not os.path.exists(os.path.join(root, ".git")): + if verbose: + print("no .git in %s" % root) + return {} + + GIT = "git" + if sys.platform == "win32": + GIT = "git.cmd" + stdout = run_command([GIT, "describe", "--tags", "--dirty", "--always"], + cwd=root) + if stdout is None: + return {} + if not stdout.startswith(tag_prefix): + if verbose: + print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix)) + return {} + tag = stdout[len(tag_prefix):] + stdout = run_command([GIT, "rev-parse", "HEAD"], cwd=root) + if stdout is None: + return {} + full = stdout.strip() + if tag.endswith("-dirty"): + full += "-dirty" + return {"version": tag, "full": full} + + +def versions_from_parentdir(parentdir_prefix, versionfile_source, verbose=False): + if IN_LONG_VERSION_PY: + # We're running from _version.py. If it's from a source tree + # (execute-in-place), we can work upwards to find the root of the + # tree, and then check the parent directory for a version string. If + # it's in an installed application, there's no hope. + try: + here = os.path.abspath(__file__) + except NameError: + # py2exe/bbfreeze/non-CPython don't have __file__ + return {} # without __file__, we have no hope + # versionfile_source is the relative path from the top of the source + # tree to _version.py. Invert this to find the root from __file__. + root = here + for i in range(len(versionfile_source.split("/"))): + root = os.path.dirname(root) + else: + # we're running from versioneer.py, which means we're running from + # the setup.py in a source tree. sys.argv[0] is setup.py in the root. + here = os.path.abspath(sys.argv[0]) + root = os.path.dirname(here) + + # Source tarballs conventionally unpack into a directory that includes + # both the project name and a version string. + dirname = os.path.basename(root) + if not dirname.startswith(parentdir_prefix): + if verbose: + print("guessing rootdir is '%s', but '%s' doesn't start with prefix '%s'" % + (root, dirname, parentdir_prefix)) + return None + return {"version": dirname[len(parentdir_prefix):], "full": ""} + +import sys + +def do_vcs_install(versionfile_source, ipy): + GIT = "git" + if sys.platform == "win32": + GIT = "git.cmd" + run_command([GIT, "add", "versioneer.py"]) + run_command([GIT, "add", versionfile_source]) + run_command([GIT, "add", ipy]) + present = False + try: + f = open(".gitattributes", "r") + for line in f.readlines(): + if line.strip().startswith(versionfile_source): + if "export-subst" in line.strip().split()[1:]: + present = True + f.close() + except EnvironmentError: + pass + if not present: + f = open(".gitattributes", "a+") + f.write("%s export-subst\n" % versionfile_source) + f.close() + run_command([GIT, "add", ".gitattributes"]) + + +SHORT_VERSION_PY = """ +# This file was generated by 'versioneer.py' (0.7+) from +# revision-control system data, or from the parent directory name of an +# unpacked source archive. Distribution tarballs contain a pre-generated copy +# of this file. + +version_version = '%(version)s' +version_full = '%(full)s' +def get_versions(default={}, verbose=False): + return {'version': version_version, 'full': version_full} + +""" + +DEFAULT = {"version": "unknown", "full": "unknown"} + +def versions_from_file(filename): + versions = {} + try: + f = open(filename) + except EnvironmentError: + return versions + for line in f.readlines(): + mo = re.match("version_version = '([^']+)'", line) + if mo: + versions["version"] = mo.group(1) + mo = re.match("version_full = '([^']+)'", line) + if mo: + versions["full"] = mo.group(1) + return versions + +def write_to_version_file(filename, versions): + f = open(filename, "w") + f.write(SHORT_VERSION_PY % versions) + f.close() + print("set %s to '%s'" % (filename, versions["version"])) + + +def get_best_versions(versionfile, tag_prefix, parentdir_prefix, + default=DEFAULT, verbose=False): + # returns dict with two keys: 'version' and 'full' + # + # extract version from first of _version.py, 'git describe', parentdir. + # This is meant to work for developers using a source checkout, for users + # of a tarball created by 'setup.py sdist', and for users of a + # tarball/zipball created by 'git archive' or github's download-from-tag + # feature. + + variables = get_expanded_variables(versionfile_source) + if variables: + ver = versions_from_expanded_variables(variables, tag_prefix) + if ver: + if verbose: print("got version from expanded variable %s" % ver) + return ver + + ver = versions_from_file(versionfile) + if ver: + if verbose: print("got version from file %s %s" % (versionfile, ver)) + return ver + + ver = versions_from_vcs(tag_prefix, versionfile_source, verbose) + if ver: + if verbose: print("got version from git %s" % ver) + return ver + + ver = versions_from_parentdir(parentdir_prefix, versionfile_source, verbose) + if ver: + if verbose: print("got version from parentdir %s" % ver) + return ver + + if verbose: print("got version from default %s" % ver) + return default + +def get_versions(default=DEFAULT, verbose=False): + assert versionfile_source is not None, "please set versioneer.versionfile_source" + assert tag_prefix is not None, "please set versioneer.tag_prefix" + assert parentdir_prefix is not None, "please set versioneer.parentdir_prefix" + return get_best_versions(versionfile_source, tag_prefix, parentdir_prefix, + default=default, verbose=verbose) +def get_version(verbose=False): + return get_versions(verbose=verbose)["version"] + +class cmd_version(Command): + description = "report generated version string" + user_options = [] + boolean_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def run(self): + ver = get_version(verbose=True) + print("Version is currently: %s" % ver) + + +class cmd_build(_build): + def run(self): + versions = get_versions(verbose=True) + _build.run(self) + # now locate _version.py in the new build/ directory and replace it + # with an updated value + target_versionfile = os.path.join(self.build_lib, versionfile_build) + print("UPDATING %s" % target_versionfile) + os.unlink(target_versionfile) + f = open(target_versionfile, "w") + f.write(SHORT_VERSION_PY % versions) + f.close() + +class cmd_sdist(_sdist): + def run(self): + versions = get_versions(verbose=True) + self._versioneer_generated_versions = versions + # unless we update this, the command will keep using the old version + self.distribution.metadata.version = versions["version"] + return _sdist.run(self) + + def make_release_tree(self, base_dir, files): + _sdist.make_release_tree(self, base_dir, files) + # now locate _version.py in the new base_dir directory (remembering + # that it may be a hardlink) and replace it with an updated value + target_versionfile = os.path.join(base_dir, versionfile_source) + print("UPDATING %s" % target_versionfile) + os.unlink(target_versionfile) + f = open(target_versionfile, "w") + f.write(SHORT_VERSION_PY % self._versioneer_generated_versions) + f.close() + +INIT_PY_SNIPPET = """ +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions +""" + +class cmd_update_files(Command): + description = "modify __init__.py and create _version.py" + user_options = [] + boolean_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def run(self): + ipy = os.path.join(os.path.dirname(versionfile_source), "__init__.py") + print(" creating %s" % versionfile_source) + f = open(versionfile_source, "w") + f.write(LONG_VERSION_PY % {"DOLLAR": "$", + "TAG_PREFIX": tag_prefix, + "PARENTDIR_PREFIX": parentdir_prefix, + "VERSIONFILE_SOURCE": versionfile_source, + }) + f.close() + try: + old = open(ipy, "r").read() + except EnvironmentError: + old = "" + if INIT_PY_SNIPPET not in old: + print(" appending to %s" % ipy) + f = open(ipy, "a") + f.write(INIT_PY_SNIPPET) + f.close() + else: + print(" %s unmodified" % ipy) + do_vcs_install(versionfile_source, ipy) + +def get_cmdclass(): + return {'version': cmd_version, + 'update_files': cmd_update_files, + 'build': cmd_build, + 'sdist': cmd_sdist, + }

1 0

[bridgedb/master] Change/Move file lib/TorBridgeDB.py to scripts/bridgedb.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 8a79e30ffaa53ccaa82787c2b6f5392612f16dac Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Aug 20 00:09:30 2013 +0000 Change/Move file lib/TorBridgeDB.py to scripts/bridgedb. It isn't actually a module, it's a two-line script. Installing it as a script is better, because: 1) We don't need to do `python -m TorBridgeDB […]`. Instead, we just do `bridgedb […]` and we also get all the benefits of shell autocompletion. 2) Setuptools will automatically replace the #! in the installed script to point to the location of the Python interpreter which was used to install it, making it work with alternate interpreters as well as within virtualenvs. * MOVE lib/TorBridgeDB.py → scripts/bridgedb. * ADD 'scripts' arguments to setuptools.setup() call. * UPDATE the README with instructions on how to run bridgedb now. --- README | 2 +- lib/TorBridgeDB.py | 4 ---- scripts/bridgedb | 4 ++++ setup.py | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README b/README index 6d390e4..5e5c296 100644 --- a/README +++ b/README @@ -224,7 +224,7 @@ Enter the following commands at the ```sqlite>``` prompt: ## Running BridgeDB To run BridgeDB, simply make any necessary changes to bridgedb.conf, and do: - python -m TorBridgeDB -c bridgedb.conf + bridgedb -c bridgedb.conf When you have new lists of bridges, replace the old files and send the process a SIGHUP. diff --git a/lib/TorBridgeDB.py b/lib/TorBridgeDB.py deleted file mode 100644 index 3739254..0000000 --- a/lib/TorBridgeDB.py +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/python - -import bridgedb.Main -bridgedb.Main.run() diff --git a/scripts/bridgedb b/scripts/bridgedb new file mode 100644 index 0000000..3739254 --- /dev/null +++ b/scripts/bridgedb @@ -0,0 +1,4 @@ +#!/usr/bin/python + +import bridgedb.Main +bridgedb.Main.run() diff --git a/setup.py b/setup.py index 2f72b9d..d93bd05 100644 --- a/setup.py +++ b/setup.py @@ -105,8 +105,8 @@ setuptools.setup( maintainer_email='isis(a)torproject.org 0xA3ADB67A2CDB8B35', url='https://www.torproject.org', package_dir= {'' : 'lib'}, - packages=setuptools.find_packages('lib'), - py_modules=['TorBridgeDB'], + packages=['bridgedb'], + scripts=['scripts/bridgedb',], cmdclass=get_cmdclass(), include_package_data=True, install_requires=get_requirements(),

1 0

[bridgedb/master] Add extra data_files to setup.py installations without MANIFEST.in.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 6609e34ce55583095335c437a5bce9a629e23df7 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Aug 20 00:30:19 2013 +0000 Add extra data_files to setup.py installations without MANIFEST.in. --- MANIFEST.in | 1 - setup.py | 14 +++++++++++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 07728ed..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1 +0,0 @@ -include README TODO diff --git a/setup.py b/setup.py index d93bd05..b043720 100644 --- a/setup.py +++ b/setup.py @@ -56,10 +56,22 @@ def get_requirements(): return requirements +def get_data_files(): + """Returns our hard-coded data_files which should be distributed. + + This is necessary for the :class:`installData` class to determine which + files we should include in the packaged distribution. + + see http://docs.python.org/2/distutils/setupscript.html#installing-additional-f… + """ + data_files=[(os.path.join('share', 'doc', 'bridgedb'), + ['README', 'TODO', 'LICENSE', 'requirements.txt'])] + return data_files + class installData(_install_data): def run(self): - self.data_files = [] + self.data_files = get_data_files() for lang in os.listdir('build/locale/'): if lang.endswith('templates'): continue

1 0

[bridgedb/master] Add 'tests' and dependencies to extras_require in setup.py.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit c4ada14e74fd0b77e2c88519695438e729deade6 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Oct 3 06:16:38 2013 +0000 Add 'tests' and dependencies to extras_require in setup.py. --- setup.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/setup.py b/setup.py index 9482539..2c7588e 100644 --- a/setup.py +++ b/setup.py @@ -133,6 +133,8 @@ setuptools.setup( package_dir= {'' : 'lib'}, packages=['bridgedb'], scripts=['scripts/bridgedb',], + extras_require={'test': ["sure>=0.4.5", + "trialcoverage>=0.3.12"]}, cmdclass=get_cmdclass(), include_package_data=True, install_requires=get_requirements(),

1 0

[bridgedb/master] Merge branch 'master' into develop
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 549f80db27e6ed6c4d3e152907968c7711b195a5 Merge: 6609e34 0be47e0 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Aug 20 01:28:59 2013 +0000 Merge branch 'master' into develop

1 0

[bridgedb/master] Add more documentation about how to use the automatic versioning.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 0ad67d767bd258b177f26e2ad95aa3f3894ec1e8 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Oct 3 06:15:14 2013 +0000 Add more documentation about how to use the automatic versioning. --- setup.py | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index b043720..9482539 100644 --- a/setup.py +++ b/setup.py @@ -22,8 +22,22 @@ except ImportError: import versioneer versioneer.versionfile_source = 'lib/bridgedb/_version.py' versioneer.versionfile_build = 'bridgedb/_version.py' -versioneer.tag_prefix = 'bridgedb-' # tags should be like 'bridgedb-0.1.0' -versioneer.parentdir_prefix = 'bridgedb-' # tarballs unpack to 'bridgedb-0.1.0' + +# when creating a release, tags should be prefixed with 'bridgedb-', like so: +# +# git checkout -b release-6.6.6 develop +# [do some stuff, merge whatever, test things] +# git tag -S bridgedb-6.6.6 +# git push tpo-common --tags +# git checkout master +# git merge -S --no-ff release-6.6.6 +# git checkout develop +# git merge -S --no-ff master +# git branch -d release-6.6.6 +# +versioneer.tag_prefix = 'bridgedb-' +# source tarballs should unpack to a directory like 'bridgedb-6.6.6' +versioneer.parentdir_prefix = 'bridgedb-' def get_cmdclass(): """Get our cmdclass dictionary for use in setuptool.setup().

1 0

[bridgedb/master] Add maintainer instructions to README for now.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit ea1c8683765b032dbf02a25f204e4e4fa782af04 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Aug 20 01:29:43 2013 +0000 Add maintainer instructions to README for now. * TODO We need a separate place (and preferably git repo for maintainer docs, scripts, etc.). I've started putting these things in maint/ in the top-level of bridgedb.git, but since I think that service maintainance should be kept separate from the software maintainance, I haven't committed them yet. That said, here are the instructions for bumping versions, for lack of a better place to put them. --- README | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README b/README index 5e5c296..3dda4f9 100644 --- a/README +++ b/README @@ -256,3 +256,34 @@ equal to "get bridges" will get answered, assuming the domain is okay. ### Support Send your questions to isis (A) torproject (circle) org. + +### Maintainer's Notes + +#### Bumping the version number + +Bumping the version number at release time (which, for BridgeDB really means +deploy time, as of right now) means doing the following: + + $ git checkout develop + [merge some fix/bug/feature/etc branches] + $ git checkout -b release-0.0.2 develop + $ git tag -a -s bridgedb-0.0.2 + [pip maintainance commands *would* go here, if we ever have any] + $ git checkout master + $ git merge -S --no-ff release-0.0.2 + $ git checkout develop + $ git merge -S --no-ff master + $ git push <remote> master develop + +And be sure not to forget to do: + + $ git push --tags + +If the currently installed version is *not* from one of the signed tags, the +version number attribute created by versioneer will be the short ID of the git +commit from which the installation took place, prefixed with the most recent +tagged release at that point, i.e.: + + >>> import bridgedb + >>> bridgedb.__version__ + 0.0.1-git528ff30c

1 0