Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
16 changes: 16 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -191,3 +191,19 @@ jobs:
name: coverage-python${{ matrix.python-version }}-fast
path: .coverage
include-hidden-files: true

Build-Packages:
name: Build Package Check
needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix, Tests ]
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 lint:build-packages
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/>`_.
1 change: 1 addition & 0 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ PROJECT_CONFIG = Config(python_versions=(...), exasol_versions=(...), create_maj

* #465: Created BaseConfig class to better synchronize attributes needed for the PTB's
growing functionalities
* #494: Created check of built packages
10 changes: 10 additions & 0 deletions exasol/toolbox/nox/_lint.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,13 @@ def import_lint(session: Session) -> None:
"Please make sure you have a configuration file for the importlinter"
)
_import_lint(session=session, path=path)


@nox.session(name="lint:build-packages", python=False)
def dist_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/*")
16 changes: 16 additions & 0 deletions exasol/toolbox/templates/github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -188,3 +188,19 @@ jobs:
name: coverage-python${{ matrix.python-version }}-fast
path: .coverage
include-hidden-files: true

Build-Packages:
name: Build Package Check
needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix, Tests ]
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 lint:build-packages
Loading
Loading