methodology/tools.md

Tools

• Documentation
  • Use Google's Markdown Style Guide for written documentation.
  • Conceptual graphical documentation as inline embedded images.
  • Save Matplotlib / Seaborn plots as .svg.
  • Sketches and handwritten illustrations scanned / photographed as .png/.jpg.
  • Scanned / photographed illustrations should be cropped, contrast and alligned.
• DevOps
  • Do CodeReviews
  • Use scrum methodology
  • Test and Production environments must be the same and very well defined: FreeBSD image or Ubunut Docker container
  • Logs:
    • Application logs docker-compose logs
    • Linux-based OS logs: /var/log/messages
    • ssh logs /var/log/audit/audit.log
• UX/UI
  • Understand, Ideate and Test, Implement UX.
  • Avoid dark patterns
• Visualization
  • problem: it's difficult to include visualization in this workflow but essential to fast prototyping.
  • Perhaps text-to-diagram
  • AsciiFlow
  • Spectral, a diverging colormap from matplotlib.
  • Tikz Editor
  • Matplotlib
    • book of examples
    • cheatsheets
• API
  • JSON API is the easiet API - follow the rules
  • Requesting - use Python-requests
• Database / DataWarehouse
  • sqlAlchemy usage
  • Pandas cheatsheet
  • PostgreSQL (datetime functs)
  • Consider SQL (but don't use select *)
  • Be aware of feature casualties of large databases
  • Data Science - Hierarchy of Needs
• Security
  • Audit security
  • Understand SSH tunnels
  • Anticipatory Failure Determination
  • Secret Management for APIs
• Programming Personalizations
  • Code-tags (PEP-0350)
  • vscode tip: turn off openDiffOnClick
  • git bash solarized 🌞
  • Music for programming
  • OpenStack: Linting and Pre-commit Hooks
• Deploying
  • Virtualize Everything! Awesome-Compose.
• AI / ML / Modelling
  • open source cousin to GPL3
  • Machine Learning Master is a great resource!
• Philosophy / Mindset / Principles
  • the-importance-of-humility-in-software-development
  • doing it right vs doing it on time
  • Closed Source Software: If you cannot check what it does / how it works, do not use it for the sake of security.
  • Software Design X Dieter Rams
• Collaboration / Working in a team
  • SPACE (satification, performance, activity, communication, efficiency)
  • Google's Four DevOp KPIs
  • Details about pair programming
  • Is extreme programming a thing?
  • Collaboration (tools: csvbox, pyodide)
  • Resolve Joel's 12 Questions
  • keeping the repo nice
  • keep repo nice with makefile
• Misc
  • Use NestedText: No YAML, TOML, or INI. CSV/TSV is acceptable.
  • Things you should do now
  • Follow naming conventions
  • Follow software engineering laws
  • There's some gold nuggets this reddit post
• Mac Software
  • Lulu Firewall
  • NightOwal