Skip to content

Commit

Permalink
Adopt modern packaging
Browse files Browse the repository at this point in the history
- drop python 2 / Django < 2.2 / django CMS < 3.7
- bumpversion
- towncrier
- github actions
- pre-commit
- github templates
  • Loading branch information
yakky committed Jul 15, 2020
1 parent 53fc9ff commit 74ae104
Show file tree
Hide file tree
Showing 23 changed files with 367 additions and 181 deletions.
20 changes: 17 additions & 3 deletions .coveragerc
@@ -1,20 +1,34 @@
[run]
source = djangocms_installer
branch = True
source = djangocms_installer
omit =
djangocms_installer/share/*
djangocms_installer/__main__.py
djangocms_installer/main.py
djangocms_installer/compat.py
djangocms_installer/config/urls_i18n.py
djangocms_installer/config/urls_noi18n.py
djangocms_installer/config/settings.py
tests/*

[report]
omit = *migrations*,*tests*,*test_utils*
# Regexes for lines to exclude from consideration
exclude_lines =
# Have to re-enable the standard pragma
pragma: no cover

# Don't complain about missing debug-only code:
def __repr__
if self\.debug

# Don't complain if tests don't hit defensive assertion code:
raise AssertionError
raise NotImplementedError

# Don't complain if non-runnable code isn't run:
if 0:
if __name__ == .__main__.:

ignore_errors = True

[html]
directory = coverage_html
6 changes: 3 additions & 3 deletions .editorconfig
Expand Up @@ -8,13 +8,13 @@ end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = 80
max_line_length = 120

[*.md]
trim_trailing_whitespace = false

[*.rst]
max_line_length = 80
max_line_length = 120

[*.py]
max_line_length = 120
Expand All @@ -28,7 +28,7 @@ max_line_length = 120
indent_size = 2
max_line_length = 120

[*.yml]
[*.{yml,yaml}]
indent_size = 2

[Makefile]
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/---bug-report.md
Expand Up @@ -17,7 +17,7 @@ Please fill in each section to help maintainers to be helpful and quick to respo
Describe issue in general terms.
-->

## Steps to reproduce
## Steps to reproduce

<!--
Provide clear steps to reproduce the issue.
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Expand Up @@ -11,8 +11,8 @@ Provide any github issue fixed (as in ``Fix #XYZ``)

# Checklist

* [ ] I have read the [contribution guide](https://django-app-helper.readthedocs.io/en/latest/contributing.html)
* [ ] I have read the [contribution guide](https://djangocms-installer.readthedocs.io/en/latest/contributing.html)
* [ ] Code lint checked via `inv lint`
* [ ] ``changes`` file included (see [docs](https://django-app-helper.readthedocs.io/en/latest/contributing.html#pull-request-guidelines))
* [ ] ``changes`` file included (see [docs](https://djangocms-installer.readthedocs.io/en/latest/contributing.html#pull-request-guidelines))
* [ ] Usage documentation added in case of new features
* [ ] Tests added
41 changes: 41 additions & 0 deletions .github/workflows/lint.yml
@@ -0,0 +1,41 @@
name: Code quality

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
if: "!contains(github.event.head_commit.message, '[skip ci]')"
strategy:
matrix:
python-version: [3.8]
toxenv: [pep8, isort, black, pypi-description, docs, towncrier]
steps:
- uses: actions/checkout@v2
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.pull_request.head.ref }}
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: Cache pip
uses: actions/cache@v1
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.toxenv }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.toxenv }}
- name: Cache tox
uses: actions/cache@v1
with:
path: .tox
key: ${{ runner.os }}-lint-${{ matrix.toxenv }}-${{ hashFiles('setup.cfg') }}
restore-keys: |
${{ runner.os }}-lint-${{ matrix.toxenv }}-
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools tox>=1.8
- name: Test with tox
run: |
tox -e${{ matrix.toxenv }}
49 changes: 8 additions & 41 deletions .github/workflows/test.yml
@@ -1,42 +1,8 @@
name: Linting - Tests
name: Tox tests

on: [push]
on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
if: "!contains(github.event.head_commit.message, '[skip ci]')"
strategy:
matrix:
python-version: [3.8]
toxenv: [pep8, isort, black, pypi-description, docs]
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: Cache pip
uses: actions/cache@v1
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.toxenv }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.toxenv }}
- name: Cache tox
uses: actions/cache@v1
with:
path: .tox
key: ${{ runner.os }}-lint-${{ matrix.toxenv }}-${{ hashFiles('setup.cfg') }}
restore-keys: |
${{ runner.os }}-lint-${{ matrix.toxenv }}-
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools tox>=1.8
- name: Test with tox
run: |
tox -e${{ matrix.toxenv }}
test:
if: "!contains(github.event.head_commit.message, '[skip ci]')"
runs-on: ubuntu-latest
Expand Down Expand Up @@ -66,16 +32,17 @@ jobs:
- name: Install dependencies
run: |
sudo apt-get install gettext sqlite3
python -m pip install --upgrade pip setuptools tox>=1.8 coveralls>=2 codecov coverage>=5
python -m pip install --upgrade pip tox>=3.5
- name: Test with tox
env:
TOX_ENV: ${{ format('{{py{0}}}', matrix.python-version) }}
TOX_ENV: py
COMMAND: coverage run
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COVERALLS_SERVICE_NAME: github
run: |
tox -e$TOX_ENV
python -mcoverage xml
coveralls
.tox/$TOX_ENV/bin/coverage xml
.tox/$TOX_ENV/bin/coveralls
- uses: codecov/codecov-action@v1
with:
token: ${{ secrets.CODECOV_TOKEN }}
Expand Down
36 changes: 31 additions & 5 deletions .pre-commit-config.yaml
@@ -1,9 +1,9 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
exclude: '(.idea|node_modules|.tox)'
exclude: "(.idea|node_modules|.tox)"
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.5.0
rev: v3.1.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
Expand All @@ -17,20 +17,46 @@ repos:
args:
- --remove
- repo: https://github.com/timothycrosley/isort
rev: '4.3.21'
rev: "5.0.2"
hooks:
- id: isort
- repo: https://github.com/psf/black
rev: 19.10b0
hooks:
- id: black
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.0a2
rev: 3.8.3
hooks:
- id: flake8
additional_dependencies:
- flake8-broken-line
- flake8-bugbear
- flake8-builtins
- flake8-coding
- flake8-commas
- flake8-comprehensions
- flake8-eradicate
- flake8-quotes
- flake8-tidy-imports
- pep8-naming
- repo: https://github.com/econchick/interrogate
rev: 1.2.0
hooks:
- id: interrogate
args:
- "-cpyproject.toml"
- "--quiet"
- repo: https://github.com/asottile/pyupgrade
rev: v2.2.1
rev: v2.6.2
hooks:
- id: pyupgrade
args:
- --py3-plus
- repo: local
hooks:
- id: towncrier
name: towncrier
entry: inv towncrier-check
language: system
pass_filenames: false
always_run: true
7 changes: 7 additions & 0 deletions .pyup.yml
@@ -0,0 +1,7 @@
update: all
pin: False
branch:
schedule: "every day"
search: True
branch_prefix: pyup/
close_prs: True
15 changes: 15 additions & 0 deletions .readthedocs.yml
@@ -0,0 +1,15 @@
version: 2

sphinx:
configuration: docs/conf.py
fail_on_warning: true

formats:
- epub
- pdf

python:
version: 3.7
install:
- requirements: requirements-test.txt
system_packages: false

0 comments on commit 74ae104

Please sign in to comment.