ak-tools

Overview

The reporsitory contains DevOps-type materials for Python and Lean:

1. The reporsitory is intended to serve as a blueprint (or, template) of a Python project to allow easy setup. At the same time, to avoid duplication, it can be used as a blueprint for a Lean project (these are my preferred languages for programming and math, respectively). To find your way around, Python (resp., Lean) package top-level is at ak_tools/ (resp., AkTools/). Note also that some of the material in the repository root folder is redundant if the repo is used for only one of Python or Lean.

2. The reporsitory contains setup guides for a Python (resp., Lean) development environment (under docs/; we value modern and flexible CLI-based tools and strictly adhere to free and open source solutions).

3. The reporsitory includes dotfiles for Bash-type shells and different free and open source CLI-based utilities (under users/7766612/dotfiles/). Dotfiles can be referenced (or copied over) to allow easy setup of new developer machines.

4. The reporsitory includes (still, a few) common tools and utilities in Python and Lean.

5. Note that the repository blueprint is set to allow multiple "user spaces" (under users/). A user space may contain a developer's environment files (to be tracked with Git independently of other developers), as well as secret files (e.g., authentication keys; not to be tracked).

List of Contents

1. An integrated project blueprint:

   • Python project and configuration files (package top-level at ak_tools/)

     • Including Poetry, Docker, Make, Git, DVC, environment files, secrets

   • Lean project and configuration files (package top-level at AkTools/)

     • Including a mathlib dependency

   • Jupyter notebooks and Markdown documents

   • The project is set up to allow multiple user spaces under users/ while the existing user is symlinked with .user.

2. Setup guides:

   • A guide on setting up a Python development environment in docs/setting-up-python.md:

     • Including pyenv (maintaining multiple python versions), Poetry (a modern dependency manager, virtual environment, and project builder in one), Cookiecutter (sharable project templates), Podman (a free Docker engine as a replacement for Docker Desktop)

   • A short guide on setting up a Lean development environment with a mathlib dependency in docs/setting-up-lean4.md.

3. System-wide dotfiles in folder users/7766612/dotfiles/:

   • Including Bash, tmux, Vim, VS Code

4. Toolbox:

   • Python tools and utilities (under ak_tools/) -- still, a few

   • Lean tools and utilities (under AkTools/) -- to be added