Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,25 @@ jobs:
- name: Run format check
run: poetry run -- nox -s project:format

Build-Packages:
name: Build Package Check
needs: [ Documentation, Lint, Type-Check, Security, Format ]
runs-on: ubuntu-24.04
permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment

- name: Run Distribution Check
run: poetry run -- nox -s package:check

Tests:
name: Unit-Tests (Python-${{ matrix.python-version }})
needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix ]
needs: [ Build-Packages, build-matrix ]
runs-on: ubuntu-24.04
permissions:
contents: read
Expand Down
59 changes: 0 additions & 59 deletions README.md

This file was deleted.

62 changes: 62 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
Exasol Toolbox
==============

Your one-stop solution for managing all standard tasks and core workflows of your Python project.

.. image:: https://github.com/exasol/python-toolbox/actions/workflows/ci.yml/badge.svg?branch=main
:target: https://github.com/exasol/python-toolbox/actions/workflows/ci.yml
:alt: Checks Main

.. image:: https://img.shields.io/pypi/l/exasol-toolbox
:target: https://opensource.org/licenses/MIT
:alt: License

.. image:: https://img.shields.io/pypi/dm/exasol-toolbox
:target: https://pypi.org/project/exasol-toolbox/
:alt: Downloads

.. image:: https://img.shields.io/pypi/pyversions/exasol-toolbox
:target: https://pypi.org/project/exasol-toolbox/
:alt: Supported Python Versions

.. image:: https://img.shields.io/pypi/v/exasol-toolbox
:target: https://pypi.org/project/exasol-toolbox/
:alt: PyPi Package

🚀 Features
-----------

- Centrally managed standard tasks:
- code formatting & upgrading
- linting
- type-checking
- unit-tests
- integration-tests
- coverage
- documentation

- Centrally managed core workflows:
- workspace/project verification
- build and publish releases
- build and publish documentation

- Configurable & Extensible:
- Project configuration
- Event hooks

🔌️ Prerequisites
-----------------

- `Python <https://www.python.org/>`__ >= 3.9

💾 Installation
---------------

.. code-block:: shell

pip install exasol-toolbox

📚 Documentation
----------------

For further details, check out the latest `documentation <https://exasol.github.io/python-toolbox/>`_.
4 changes: 4 additions & 0 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Unreleased

## Feature

* #494: Created check of built packages with nox session `package:check`
16 changes: 16 additions & 0 deletions exasol/toolbox/nox/_package.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
from __future__ import annotations

import nox
from nox import Session

from noxconfig import PROJECT_CONFIG


@nox.session(name="package:check", python=False)
def package_check(session: Session) -> None:
"""Checks whether your distribution’s long description will render correctly on PyPI

This has more robust checks for rst documentation than markdown.
"""
session.run("poetry", "build", "--project", PROJECT_CONFIG.root)
session.run("twine", "check", PROJECT_CONFIG.root / "./dist/*")
2 changes: 2 additions & 0 deletions exasol/toolbox/nox/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,7 @@ def check(session: Session) -> None:

from exasol.toolbox.nox._package_version import version_check

from exasol.toolbox.nox._package import package_check

# isort: on
# fmt: on
18 changes: 17 additions & 1 deletion exasol/toolbox/templates/github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,25 @@ jobs:
- name: Run format check
run: poetry run -- nox -s project:format

Build-Packages:
name: Build Package Check
needs: [ Documentation, Lint, Type-Check, Security, Format ]
runs-on: ubuntu-24.04
permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@v1

- name: Run Distribution Check
run: poetry run -- nox -s package:check

Tests:
name: Unit-Tests (Python-${{ matrix.python-version }})
needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix ]
needs: [ Build-Packages, build-matrix ]
runs-on: ubuntu-24.04
permissions:
contents: read
Expand Down
Loading