From fbdfa0a8ae40ccfa9fcfd3808beef77de9cc7c67 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Mon, 15 Mar 2021 18:24:46 +0100 Subject: [PATCH] Refresh the development enviroment When using Python 3.9, setting up the development environment croaked. Because "bootstrap.py" was a workaround in pre-pip times, this patch completely gets rid of it. At the same time, it modernizes some more dependency definitions. --- .github/workflows/main.yml | 8 +- .gitignore | 3 +- DEVELOP.rst | 20 ++-- LICENSE | 55 ---------- bootstrap.py | 210 ------------------------------------- docs/requirements.txt | 15 +-- tox.ini | 2 +- versions.cfg | 53 +++++----- 8 files changed, 46 insertions(+), 320 deletions(-) delete mode 100644 bootstrap.py diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index c01c1160c..16a4db8f0 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -34,7 +34,11 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - python bootstrap.py + + # Workaround needed for Python 3.5 + python -m pip install --upgrade "setuptools>=31,<51" + + pip install zc.buildout==2.13.4 # replace SQLAlchemy version sed -ir 's/SQLAlchemy.*/SQLAlchemy = ${{ matrix.sqla-version }}/g' versions.cfg @@ -48,7 +52,7 @@ jobs: sed -ir 's/crate_server.*/crate_server = ${{ matrix.crate-version }}/g' versions.cfg fi - bin/buildout -n -c base.cfg + buildout -n -c base.cfg - name: Test run: | diff --git a/.gitignore b/.gitignore index 109796e3a..8b47ff2d6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ -.coverage/ +.venv* +.coverage .idea/ .installed.cfg .tox/ diff --git a/DEVELOP.rst b/DEVELOP.rst index f1abb77ab..74cda70ce 100644 --- a/DEVELOP.rst +++ b/DEVELOP.rst @@ -7,34 +7,36 @@ Setup This project uses buildout_ to set up the development environment. -To start things off, run:: +To start things off, create a Python virtualenv and install buildout:: - $ python bootstrap.py + python3 -m venv .venv + source .venv/bin/activate + pip install zc.buildout==2.13.4 Then, run:: - $ ./bin/buildout -N + buildout -N Running Tests ============= The tests are run using the zope.testrunner_:: - $ ./bin/test + ./bin/test -This will run all tests using the Python interpreter that was used to -bootstrap buildout. +This will run all tests using the Python interpreter that was used when +creating the Python virtualenv. You can run the tests against multiple Python interpreters with tox_:: - $ ./bin/tox + ./bin/tox To do this, you will need ``python2.7``, ``python3.3``, and ``pypy`` on your ``$PATH``. To run against a single interpreter, you can also do:: - $ ./bin/tox -e py33 + ./bin/tox -e py37 *Note*: before running tests make sure to stop all CrateDB instances which listening on the default CrateDB transport port to avoid side effects with the @@ -90,7 +92,7 @@ The docs are written written with ReStructuredText_ and processed with Sphinx_. Build the docs by running:: - $ bin/sphinx + ./bin/sphinx The output can then be found in the ``out/html`` directory. diff --git a/LICENSE b/LICENSE index ff9c7bc03..75570724a 100644 --- a/LICENSE +++ b/LICENSE @@ -203,61 +203,6 @@ limitations under the License. -=============================================================================== - -For the `bootstrap.py` file: - -Buildout - -Copyright (c) 2006 Zope Foundation and Contributors. -All Rights Reserved. - -Zope Public License (ZPL) Version 2.1 - -A copyright notice accompanies this license document that identifies the -copyright holders. - -This license has been certified as open source. It has also been designated as -GPL compatible by the Free Software Foundation (FSF). - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions in source code must retain the accompanying copyright -notice, this list of conditions, and the following disclaimer. - -2. Redistributions in binary form must reproduce the accompanying copyright -notice, this list of conditions, and the following disclaimer in the -documentation and/or other materials provided with the distribution. - -3. Names of the copyright holders must not be used to endorse or promote -products derived from this software without prior written permission from the -copyright holders. - -4. The right to distribute this software or to use it for any purpose does not -give you the right to use Servicemarks (sm) or Trademarks (tm) of the -copyright -holders. Use of them is covered by separate agreement with the copyright -holders. - -5. If any files are modified, you must cause the modified files to carry -prominent notices stating that you changed the files and the date of any -change. - -Disclaimer - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED -OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES -OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO -EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, -INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR -PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING -NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, -EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - - =============================================================================== For the `docs` directory: diff --git a/bootstrap.py b/bootstrap.py deleted file mode 100644 index 1f59b2137..000000000 --- a/bootstrap.py +++ /dev/null @@ -1,210 +0,0 @@ -############################################################################## -# -# Copyright (c) 2006 Zope Foundation and Contributors. -# All Rights Reserved. -# -# This software is subject to the provisions of the Zope Public License, -# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. -# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED -# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS -# FOR A PARTICULAR PURPOSE. -# -############################################################################## -"""Bootstrap a buildout-based project - -Simply run this script in a directory containing a buildout.cfg. -The script accepts buildout command-line options, so you can -use the -c option to specify an alternate configuration file. -""" - -import os -import shutil -import sys -import tempfile - -from optparse import OptionParser - -__version__ = '2015-07-01' -# See zc.buildout's changelog if this version is up to date. - -tmpeggs = tempfile.mkdtemp(prefix='bootstrap-') - -usage = '''\ -[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options] - -Bootstraps a buildout-based project. - -Simply run this script in a directory containing a buildout.cfg, using the -Python that you want bin/buildout to use. - -Note that by using --find-links to point to local resources, you can keep -this script from going over the network. -''' - -parser = OptionParser(usage=usage) -parser.add_option("--version", - action="store_true", default=False, - help=("Return bootstrap.py version.")) -parser.add_option("-t", "--accept-buildout-test-releases", - dest='accept_buildout_test_releases', - action="store_true", default=False, - help=("Normally, if you do not specify a --buildout-version, " - "the bootstrap script and buildout gets the newest " - "*final* versions of zc.buildout and its recipes and " - "extensions for you. If you use this flag, " - "bootstrap and buildout will get the newest releases " - "even if they are alphas or betas.")) -parser.add_option("-c", "--config-file", - help=("Specify the path to the buildout configuration " - "file to be used.")) -parser.add_option("-f", "--find-links", - help=("Specify a URL to search for buildout releases")) -parser.add_option("--allow-site-packages", - action="store_true", default=False, - help=("Let bootstrap.py use existing site packages")) -parser.add_option("--buildout-version", - help="Use a specific zc.buildout version") -parser.add_option("--setuptools-version", - help="Use a specific setuptools version") -parser.add_option("--setuptools-to-dir", - help=("Allow for re-use of existing directory of " - "setuptools versions")) - -options, args = parser.parse_args() -if options.version: - print("bootstrap.py version %s" % __version__) - sys.exit(0) - - -###################################################################### -# load/install setuptools - -try: - from urllib.request import urlopen -except ImportError: - from urllib2 import urlopen - -ez = {} -if os.path.exists('ez_setup.py'): - exec(open('ez_setup.py').read(), ez) -else: - exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez) - -if not options.allow_site_packages: - # ez_setup imports site, which adds site packages - # this will remove them from the path to ensure that incompatible versions - # of setuptools are not in the path - import site - # inside a virtualenv, there is no 'getsitepackages'. - # We can't remove these reliably - if hasattr(site, 'getsitepackages'): - for sitepackage_path in site.getsitepackages(): - # Strip all site-packages directories from sys.path that - # are not sys.prefix; this is because on Windows - # sys.prefix is a site-package directory. - if sitepackage_path != sys.prefix: - sys.path[:] = [x for x in sys.path - if sitepackage_path not in x] - -setup_args = dict(to_dir=tmpeggs, download_delay=0) - -if options.setuptools_version is not None: - setup_args['version'] = options.setuptools_version -if options.setuptools_to_dir is not None: - setup_args['to_dir'] = options.setuptools_to_dir - -ez['use_setuptools'](**setup_args) -import setuptools -import pkg_resources - -# This does not (always?) update the default working set. We will -# do it. -for path in sys.path: - if path not in pkg_resources.working_set.entries: - pkg_resources.working_set.add_entry(path) - -###################################################################### -# Install buildout - -ws = pkg_resources.working_set - -setuptools_path = ws.find( - pkg_resources.Requirement.parse('setuptools')).location - -# Fix sys.path here as easy_install.pth added before PYTHONPATH -cmd = [sys.executable, '-c', - 'import sys; sys.path[0:0] = [%r]; ' % setuptools_path + - 'from setuptools.command.easy_install import main; main()', - '-mZqNxd', tmpeggs] - -find_links = os.environ.get( - 'bootstrap-testing-find-links', - options.find_links or - ('http://downloads.buildout.org/' - if options.accept_buildout_test_releases else None) - ) -if find_links: - cmd.extend(['-f', find_links]) - -requirement = 'zc.buildout' -version = options.buildout_version -if version is None and not options.accept_buildout_test_releases: - # Figure out the most recent final version of zc.buildout. - import setuptools.package_index - _final_parts = '*final-', '*final' - - def _final_version(parsed_version): - try: - return not parsed_version.is_prerelease - except AttributeError: - # Older setuptools - for part in parsed_version: - if (part[:1] == '*') and (part not in _final_parts): - return False - return True - - index = setuptools.package_index.PackageIndex( - search_path=[setuptools_path]) - if find_links: - index.add_find_links((find_links,)) - req = pkg_resources.Requirement.parse(requirement) - if index.obtain(req) is not None: - best = [] - bestv = None - for dist in index[req.project_name]: - distv = dist.parsed_version - if _final_version(distv): - if bestv is None or distv > bestv: - best = [dist] - bestv = distv - elif distv == bestv: - best.append(dist) - if best: - best.sort() - version = best[-1].version -if version: - requirement = '=='.join((requirement, version)) -cmd.append(requirement) - -import subprocess -if subprocess.call(cmd) != 0: - raise Exception( - "Failed to execute command:\n%s" % repr(cmd)[1:-1]) - -###################################################################### -# Import and run buildout - -ws.add_entry(tmpeggs) -ws.require(requirement) -import zc.buildout.buildout - -if not [a for a in args if '=' not in a]: - args.append('bootstrap') - -# if -c was provided, we push it back into args for buildout' main function -if options.config_file is not None: - args[0:0] = ['-c', options.config_file] - -zc.buildout.buildout.main(args) -shutil.rmtree(tmpeggs) diff --git a/docs/requirements.txt b/docs/requirements.txt index 71f3d818c..ced14fe99 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,14 +1 @@ -# don't pin crate version numbers so the latest will always be pulled when you -# set up your environment from scratch - -crate-docs-theme>=0.7 - -# packages for local dev - -sphinx-autobuild==0.6.0 - -# the next section should mirror the RTD environment - -alabaster>=0.7,<0.8,!=0.7.5 -setuptools<41 -sphinx==1.8.5 +crate-docs-theme diff --git a/tox.ini b/tox.ini index e5b1fdacb..7a5ba8055 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py{py,34,35,36,37,38}-sa_{1_0,1_1,1_2,1_3} +envlist = py{py3,35,36,37,38,39}-sa_{1_0,1_1,1_2,1_3} [testenv] usedevelop = True diff --git a/versions.cfg b/versions.cfg index 40d8dc673..1ff59bf64 100644 --- a/versions.cfg +++ b/versions.cfg @@ -1,32 +1,29 @@ [versions] -crate_server = 4.3.0 +crate_server = 4.4.2 flake8 = 3.7.9 mccabe = 0.6.1 pep8 = 1.7.1 pyflakes = 2.1.1 -Jinja2 = 2.7.3 -MarkupSafe = 0.23 -Pygments = 1.6 -Sphinx = 1.2.3 -SQLAlchemy = 1.3.17 +Jinja2 = 2.11.3 +MarkupSafe = 1.1.1 +Pygments = 2.8.1 +Sphinx = 3.5.2 +SQLAlchemy = 1.3.23 geojson = 2.5.0 -coverage = 5.0.3 -crate-docs-theme = 0.5.0 +coverage = 5.5 +crate-docs-theme = 0.13.3 createcoverage = 1.5 -docutils = 0.12 -hexagonit.recipe.download = 1.7 -py = 1.4.26 -tox = 3.7.0 -twine = 1.8.1 -virtualenv = 15.1.0 -wheel = 0.24.0 -pkginfo = 1.4.1 -zc.buildout = 2.11.2 +docutils = 0.16 +hexagonit.recipe.download = 1.7.1 +py = 1.10.0 +tox = 3.23.0 +twine = 3.4.0 +pkginfo = 1.7.0 zc.customdoctests = 1.0.1 -zc.recipe.egg = 2.0.1 -zc.recipe.testrunner = 2.0.0 -zope.testing = 4.1.3 +zc.recipe.egg = 2.0.7 +zc.recipe.testrunner = 2.2 +zope.testing = 4.9 # Required by: # clint==0.5.1 @@ -38,30 +35,30 @@ clint = 0.5.1 # Required by: # zope.testrunner==4.4.3 -six = 1.11.0 +six = 1.15.0 # Required by: # crate-docs-theme==0.3.6 -sphinxcontrib-plantuml = 0.5 +sphinxcontrib-plantuml = 0.19 # Required by: # crate==0.12.3 -urllib3 = 1.9.1 +urllib3 = 1.26.4 # Required by: # zope.testing==4.1.3 # zope.testrunner==4.4.3 -zope.exceptions = 4.0.7 +zope.exceptions = 4.4 # Required by: # zope.testing==4.1.3 # zope.testrunner==4.4.3 -zope.interface = 4.1.1 +zope.interface = 5.2.0 # Required by: # zc.recipe.testrunner==2.0.0 -zope.testrunner = 4.9.1 +zope.testrunner = 5.2 gp.recipe.tox = 0.4 -requests = 2.5.0 -requests-toolbelt = 0.5.1 +requests = 2.25.1 +requests-toolbelt = 0.9.1