Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python Toolbox Talk #235

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions talk/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
python-toolbox.html
6 changes: 6 additions & 0 deletions talk/00-metadata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: 🔧 Python-Toolbox
subtitle: A Vision of a Better Future
author: Nicola Coretti
date: 2024-??-??
---
22 changes: 22 additions & 0 deletions talk/01-why.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Why?

## Why This Talk?

Align vision and understanding of common project- setup & management

::: notes
At least on the usage side, ideally on usage + impl
:::

## Why the Toolbox?
* 35+ Python projects, and the number still is increasing 😮‍💨
* Reduce complexity by having common set of tools
* Reduce complexity by hiding unecessary parts of common tools
* Minimize/reduce cognitive overhead.
* Provide a "central" place for project maintenance knowledge.
* Simplify future changes/transitions (e.g., pylint/ruff, black/ruff-fmt).

::: notes
* The Integration Team has 35+ Python projects, and the number still increases 😮‍💨.
Add revised version of design document with learnings and adjustments to documentation
:::
38 changes: 38 additions & 0 deletions talk/10-vision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Vision

## Principles
* Should run locally and in CI
* ...

## Adoption

### New Projects
* Cookiecutter

### Old Projects
* Helpers ?

::: notes
Not to much effort this will hopefully go away over time
:::

## Tasks

* Test(s)
- Unit
- Integration
* Checks
- Typecheck
- Linting
- Security
- Licences
- ...
* Release & Publish
* Reporting


## Worflows (CI & Co.)

## Custumization

## Auto Update/Upgrade
23 changes: 23 additions & 0 deletions talk/20-current-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Where We Are At

## Pre Conditions
* poetry
* pypi
* nox

## New Projects

## Old Projects

## Reporting

## Release support

## Publish Support

## CI & CD

## Testing

## Plugins

6 changes: 6 additions & 0 deletions talk/30-the-path.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Walking the Path

## What needs to be done

* Regular effort
* Minimizing "new legacy"
4 changes: 4 additions & 0 deletions talk/80-open-questions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Open Questions

* Consider PR's over issue(s) especially for small things
* Single project repos (combinatory explosion and overhead)
1 change: 1 addition & 0 deletions talk/90-questions-and-feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Questions & Feedback ?
27 changes: 27 additions & 0 deletions talk/flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 37 additions & 0 deletions talk/flake.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
description = "A nix flake containing the dev stack for the python-toolbox talk slides";

inputs = {
nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-24.05";
};

outputs = { self, nixpkgs }:
let
system = "x86_64-linux";
pkgs = nixpkgs.legacyPackages.${system};
in
with pkgs;
{
devShell = {
x86_64-linux = pkgs.mkShell {
buildInputs = [
pkgs.starship
pkgs.fish
pkgs.pandoc
pkgs.just
pkgs.nodejs_18
pkgs.docker
pkgs.maven
pkgs.antlr4_9
pkgs.jq
];
shellHook = ''
if [ -n "$PS1" ]; then
exec fish
fi
'';
};
};
};
}

Binary file added talk/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions talk/justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
default_theme := 'solarized'

@default:
just --list

@list-themes:
echo "* black"
echo "* white"
echo "* league"
echo "* beige"
echo "* night"
echo "* serif"
echo "* simple"
echo "* solarized"
echo "* moon"
echo "* dracula"
echo "* sky"
echo "* blood"


@build theme=default_theme:
echo "Building Presentation..."
pandoc --to=revealjs --embed-resources --standalone \
--resource-path=./images \
00-metadata.yml *.md \
--slide-level=3 --variable "progress=true" \
--variable "mainfont=Courier" \
--highlight-style haddock \
--include-in-header=slides.css \
-o python-toolbox.html
#--css style.css # --variable "theme={{theme}}" \

@open:
xdg-open python-toolbox.html
61 changes: 61 additions & 0 deletions talk/slides.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<style>
:root {
--r-background-color: #fff;
--r-main-color: #56565A;
--r-heading-color: #76BC1C;
--r-link-color: #589BD4;
--r-link-color-hover: #EEE65D;
/** --r-main-font: #{$mainFont};
--r-main-font-size: #{$mainFontSize};
--r-block-margin: #{$blockMargin};
--r-heading-margin: #{$headingMargin};
--r-heading-font: #{$headingFont};
--r-heading-line-height: #{$headingLineHeight};
--r-heading-letter-spacing: #{$headingLetterSpacing};
--r-heading-text-transform: #{$headingTextTransform};
--r-heading-text-shadow: #{$headingTextShadow};
--r-heading-font-weight: #{$headingFontWeight};
--r-heading1-text-shadow: #{$heading1TextShadow};
--r-heading1-size: #{$heading1Size};
--r-heading2-size: #{$heading2Size};
--r-heading3-size: #{$heading3Size};
--r-heading4-size: #{$heading4Size};
--r-code-font: #{$codeFont};
--r-link-color: #{$linkColor};
--r-link-color-dark: #{darken($linkColor , 15% )};
--r-link-color-hover: #{$linkColorHover};
--r-selection-background-color: #{$selectionBackgroundColor};
--r-selection-color: #{$selectionColor};
--r-overlay-element-bg-color: #{$overlayElementBgColor};
--r-overlay-element-fg-color: #{$overlayElementFgColor}; */
}

.reveal-viewport {
background-image: url(logo.png);
background-size: 5%;
background-repeat: no-repeat;
background-position: 3% 97%;
}

.slides {
font-size: 0.75em;
}

img {
max-height: 350px !important;
}

figcaption {
font-size: 0.6em !important;
font-style: italic !important;
}

.subtitle {
font-style: italic !important;
font-size: 0.75em;
}

.date {
font-size: 0.75em !important;
}
</style>
Loading