Skip to content

Latest commit

 

History

History
109 lines (89 loc) · 3.14 KB

DEVGUIDE.md

File metadata and controls

109 lines (89 loc) · 3.14 KB
Raw

DEVELOPMENT GUIDELINES

  • workplace setup
  • makefile targets
  • release process

WORKPLACE SETUP

Development can be done with a pure text editor and a terminal session.

VSCode setup

Use python and mypy extensions for Visual Studio Code (from Microsoft).

The make targets are defaulting to tests with python3.6 but the mypy plugin for vscode requires atleast python3.8. All current Linux distros provide an additional package with a higher version number, e.g "zypper install python311". Be sure to also install "python311-mypy" or compile "pip3 install mypy". Implant the paths to those tools into the workspace settings = .vscode/settings.json

{
    "mypy-type-checker.reportingScope": "workspace",
    "mypy-type-checker.interpreter": [
            "/usr/bin/python3.11"
    ],
    "mypy-type-checker.path": [
            "mypy-3.11"
    ],
    "mypy-type-checker.args": [
            "--strict",
            "--show-error-codes",
            "--show-error-context",
            "--no-warn-unused-ignores",
            "--ignore-missing-imports",
            "--exclude=build"
    ],
    "python.defaultInterpreterPath": "python3"
}

Makefile setup

Common distro packages are:

  • zypper install python3 python3-pip # atleast python3.6
  • zypper install python3-wheel python3-twine
  • zypper install python3-coverage python3-unittest-xml-reporting
  • zypper install python3-mypy python3-mypy_extensions python3-typing_extensions
  • zypper install python3-autopep8

For ubuntu you can check the latest Github workflows under

  • grep apt-get .github/workflows/*.yml

Makefile targets

static code checking

  • make type
  • make style

testing targets

  • make check
  • make install and make uninstall

release targets

  • make version
  • make build

RELEASE PROCESS

  • make type
  • make style
  • make check
  • make check4 # (--docker=podman) and optionally make check5 (--force)
  • make coverage
  • update number of tests and coverage in README.md shields-badge
  • make docker
  • docker run --rm docker-copyedit --help
  • make uninstall # may fail as "not installed"
  • make install
  • make uninstall
  • make version # or make version FOR=tomorrow
  • update long description in README.md
  • update short description in setup.cfg
  • make build
  • make install
  • make uninstall
  • make commit # uses version from setup.cfg
    • run shown git commit v1.x
  • git push # if necessary
  • wait for github workflows to be okay
  • prepare a tmp.changes.txt
  • make tag # uses version from setup.cfg
    • run shown git tag -F tmp.changes.txt v1.x
  • git push --tags
  • git checkout v1
  • git merge master
  • git push
  • git checkout master
  • update the short description on github
  • make build
    • run shown twine upload