ak-tools

Overview

• Firstly, the repository is intended as a blueprint (or, template) of a Python project for a repeatable and easy set up. At the same time, to avoid duplication, it can be used as a blueprint for a Lean project. These are my favorite modern alternatives for programming and reasoning. Package top-levels are at ak_tools/ and AkTools/, respectively, and part of the material in the repository root is redundant if only used for one of Python or Lean.

• Secondly, the repository contains setup guides (under docs/) for Python and Lean development environments, using a modern, effective, free and open source toolset.

• Thirdly, the repository includes system-wide dotfiles (under users/7766612/dotfiles/) for Bash-type shells and other popular, free and open source CLI utilities. These can be referenced (or copied over) for a repeatable and easy set up of the machine.

• Fourth, the repo include (still, a few) common tools and utilities in Python and Lean.

• The repository is set up to allow multiple user spaces (under users/), each with different environment files and secret (authentication) files, while the former are being tracked in Git.

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