.gitlab-ci.yml

.gitlab-ci.yml

@@ -0,0 +1,73 @@
+
+image: dahanna/python-alpine-package:tox-alpine
+
+# https://docs.gitlab.com/ee/ci/yaml/includes.html#re-using-a-before_script-template
+include:
+  - project: 'gitlab-ci-yml-components/for-python'
+    file: '.before_script.yml'
+
+
+test:
+  tags:
+  - docker
+  stage: test
+  script:
+  # If using an image that does not include tox, we will
+  # need to pip install tox here.
+  - pip install --upgrade wheel setuptools tox cookiecutter bumpversion
+
+  - git --version || echo "git is not installed."
+  - python --version
+  - python2 --version || echo "python2 is not installed."
+  - virtualenv --version || echo "virtualenv is not installed."
+  - pip --version
+  # When testing locally, we might not want to set tox sitepackages=true,
+  # because the local machine might have all kinds of weird things in the
+  # environment. But for continuous integration, we do want sitepackages=true,
+  # because it allows us to use a Docker image with some packages already
+  # installed to accelerate testing.
+  - tox --version
+  - uname --all
+  - lsb_release --all || echo "lsb_release is not supported on this host."
+
+  - printf "    repo_hosting_domain" >> gitlab.cookiecutterrc
+  - 'printf ":" >> gitlab.cookiecutterrc'
+  - printf "       '$repo_hosting_domain'\n" >> gitlab.cookiecutterrc
+  - echo "might be able to extract it from $CI_SERVER_URL"
+  - 'printf "    repo_username:" >> gitlab.cookiecutterrc'
+  - echo "             '$GITLAB_USER_LOGIN'" >> gitlab.cookiecutterrc
+  - cat gitlab.cookiecutterrc
+  # - git clone -b $CI_COMMIT_BRANCH --single-branch $PYTHON_NAMELESS_REPO
+  # we cannot be sure that branch already exists
+  - git clone $PYTHON_NAMELESS_REPO
+  - cd python-nameless
+  - git checkout $CI_COMMIT_BRANCH || git checkout -b $CI_COMMIT_BRANCH
+  - cd ..
+  - cookiecutter --help
+  - cookiecutter --overwrite-if-exists --no-input --config-file=gitlab.cookiecutterrc .
+  - cd python-nameless
+  - 'sed --in-place "s/fkrull\/multi-python:bionic/dahanna\/python-alpine-package:tox-alpine/" .gitlab-ci.yml'
+  - git status
+  - git diff
+  - git status
+  - git add --all
+  - git config user.email "[email protected]"
+  - git config user.name "Your Name"
+  - git commit --allow-empty -m "Regenerated from cookiecutter."
+  - git push -u origin $CI_COMMIT_BRANCH
+  - sed --help
+  - |
+   for name in py35 py36 py27 pypy3 pypy; do
+    for env in $name ${name}-cover ${name}-nocov; do
+     sed --in-place "s/,$env,/,/" tox.ini
+     sed --in-place "s/$env,//" tox.ini
+     sed --in-place "s/,$env//" tox.ini
+    done
+   done
+  - git diff
+  - git reset --hard
+  - start_tox=$(date +%s)
+  # - tox --sitepackages
+  - echo "tox tests took $(( $(date +%s) - start_tox)) seconds"
+  - echo "Everything after pulling the Docker image took $(( $(date +%s) - right_after_pull_docker_image)) seconds total"
+

README.rst

@@ -347,6 +347,21 @@ You will be asked for these fields:
         <https://pypi.org/project/sphinx_py3doc_enhanced_theme>` for a responsive theme based on
         the Python 3 documentation.
 
+    * - ``docs_require_package``
+      - .. code:: python
+
+            "no"
+      - Set to ``"yes"`` if you want to enable using your package when building documentation.
+        Leave as ``"no"`` if you want your docs to build as quickly as possible, to show live updates.
+        You *can* still use doctests and specify skipif on all of them so that doctests will be run by
+        tox but passed through when just building the documentation.
+
+        Your documentation will absolutely require your package if, for example, your package produces
+        visualizations that you want to include in the documentation. Since those are large binary files,
+        you don't want to add them to git. So you'll generate them on-the-fly when the documentation is
+        built.
+        You should also set this to ``"yes"`` if you want to use GitLab Pages to host your conda package.
+
     * - ``sphinx_doctest``
       - .. code:: python
 

cookiecutter.json

@@ -71,6 +71,7 @@
     "codeclimate" : ["no", "yes"],
     "sphinx_docs": ["yes", "no"],
     "sphinx_theme": ["sphinx-rtd-theme", "sphinx-py3doc-enhanced-theme"],
+    "docs_require_package": ["no", "yes"],
     "sphinx_doctest": ["no", "yes"],
     "sphinx_docs_hosting": "https://{{ cookiecutter.repo_name|replace('.', '') }}.readthedocs.io/",
     "travis": ["yes", "no"],

gitlab.cookiecutterrc

@@ -0,0 +1,42 @@
+# This file exists so you can easily regenerate your project.
+#
+# `cookiepatcher` is a convenient shim around `cookiecutter`
+# for regenerating projects (it will generate a .cookiecutterrc
+# automatically for any template). To use it:
+#
+#    pip install cookiepatcher
+#    cookiepatcher gh:ionelmc/cookiecutter-pylibrary project-path
+#
+# See:
+#    https://pypi.org/project/cookiepatcher
+#
+# Alternatively, you can run:
+#
+#    cookiecutter --overwrite-if-exists --config-file=project-path/.cookiecutterrc gh:ionelmc/cookiecutter-pylibrary
+
+default_context:
+
+    _template:                 'cookiecutter-pylibrary'
+    allow_tests_inside_package: 'yes'
+    appveyor:                  'no'
+    codeclimate:               'no'
+    codecov:                   'no'
+    command_line_interface:    'click'
+    coveralls:                 'no'
+    email:                     '[email protected]'
+    full_name:                 'David A. Hannasch'
+    landscape:                 'no'
+    license:                   'no'
+    linter:                    'flake8'
+    pre_commit:                'yes'
+    pypi_badge:                'no'
+    pypi_disable_upload:       'no'
+    repo_hosting:              'other domain not listed'
+    requiresio:                'no'
+    scrutinizer:               'no'
+    setup_py_uses_setuptools_scm: 'yes'
+    sphinx_docs:               'yes'
+    sphinx_docs_hosting:       'https://www.google.com'
+    travis:                    'no'
+    travis_osx:                'no'
+    website:                   'https://www.google.com'

hooks/post_gen_project.py

@@ -102,6 +102,16 @@ def unlink_if_exists(path):
     unlink_if_exists('.travis.yml')
 {% endif %}
 
+{%- if 'gitlab' not in cookiecutter.repo_hosting_domain %}
+    os.unlink('.gitlab-ci.yml')
+    os.unlink('.before_script.yml')
+    os.unlink('.build_with_kaniko.yml')
+    os.unlink('.dockerignore')
+    os.unlink('dockerfiles/slim.Dockerfile')
+    os.unlink('dockerfiles/test.Dockerfile')
+    os.unlink('conda.recipe/meta.yaml')
+{% endif %}
+
 {%- if cookiecutter.repo_hosting == 'no' %}
     os.unlink('CONTRIBUTING.rst')
 {% endif %}
@@ -130,6 +140,7 @@ def unlink_if_exists(path):
             subprocess.check_call([sys.executable, '-mtox', '-e', 'bootstrap'])
         except Exception:
             subprocess.check_call([sys.executable, join('ci', 'bootstrap.py')])
+            subprocess.check_call([sys.executable, join('ci', 'assembler.py')])
 
     print("""
 ################################################################################