Install

Install with:

pipx install Historie

DSL

Adds the following reStructuredText directives [2] each usually having a number of arguments:

1. his-contacts

   • name

   • title

   • location

   • email

   Example:

   .. his-contacts::
      :name: Robert C. Martin
      :title: Software Craftsman & Clean Code Evangelist
      :location: Chicago, Illinois, USA
      :email: uncle.bob@cleancoders.com

2. his-links

   This directive has no argument, but uses a definition list to allow annotated links, for example:

   .. his-links::
   
      Clean Coders
          https://cleancoders.com/
   
      The Clean Code Blog
          https://blog.cleancoder.com/
   
      GitHub
          https://github.com/unclebob

3. his-stack-exchange-profiles

   • stackoverflow

   • serverfault

   • superuser

   • askubuntu

   • unix

   • dba

   • softwareengineering

   Example:

   .. his-stack-exchange-profiles::
     :stackoverflow: 73476

4. his-technology-preference

   • desired

   • undesired

   Example:

   .. his-technology-preference::
      :desired:
        clean-code, solid-principles, tdd, craftsmanship, agile,
        refactoring, design-patterns, clojure, java, architecture
      :undesired:
        big-design-up-front, waterfall, code-comments,
        null-references, singletons, service-locators

5. his-summary

   This directive only has content, for example:

   .. his-summary::
   
      Software professional since 1970. Author of foundational texts on
      clean code, agile development, and software craftsmanship. Original
      signatory of the Agile Manifesto. Firm believer that the only way
      to go fast is to go well.

6. his-job

   • company-name

   • company-website

   • role

   • start

   • finish

   • technology

   Examples:

   .. his-job::
      :company-name: Clean Coders
      :company-website: https://cleancoders.com/
      :role: Founder & Head Craftsman
      :start: 2010-01-01
      :technology:
        video-production, education, clean-code, tdd,
        solid-principles, refactoring, clojure
   
      Founded educational platform delivering video training on software
      craftsmanship. Produced 60+ hours of content covering clean code,
      TDD, SOLID principles, and functional programming. Reached hundreds
      of thousands of developers worldwide.
   
   .. his-job::
      :company-name: Object Mentor
      :company-website: https://web.archive.org/web/20070913061205/https://www.objectmentor.com/
      :role: Founder & President
      :start: 1990-01-01
      :finish: 2009-12-31
      :technology:
        consulting, training, agile, xp, tdd, oop,
        design-patterns, c++, java
   
      Built premier consulting firm for agile transformation and technical
      training. Trained Fortune 500 companies in XP, TDD, and OOP. Authored
      company's flagship course curricula. Helped establish agile practices
      in enterprise software development.
   
   .. his-job::
      :company-name: Teradyne
      :company-website: https://teradyne.com/
      :role: Software Engineer
      :start: 1970-01-01
      :finish: 1989-12-31
      :technology:
        assembly, c, c++, embedded-systems, real-time,
        telecommunications, testing-equipment
   
      Cut teeth on PDP-8 and PDP-11 assembly. Developed embedded systems
      for automated testing equipment. Learned that the hard way is the
      slow way, and discipline is the path to speed. Discovered that
      debugging time dwarfs coding time unless you write tests first.

7. his-project

   • name

   • url

   • start

   • finish

   • technology

   Examples:

   .. his-project::
      :name: FitNesse
      :url: https://github.com/unclebob/fitnesse
      :start: 2002-01-01
      :technology: java, acceptance-testing, wiki, collaboration
   
      Fully integrated standalone wiki and acceptance testing framework.
      Enables customers, testers, and programmers to collaborate on
      software requirements through executable specifications. Because
      the best documentation is documentation that runs.
   
   .. his-project::
      :name: Clean Code (The Book)
      :url: https://www.oreilly.com/library/view/clean-code-a/9780136083238/
      :start: 2007-01-01
      :finish: 2008-08-01
      :technology: java, craftsmanship, refactoring, naming, functions
   
      A Handbook of Agile Software Craftsmanship. Distilled decades of
      experience into principles, patterns, and practices for writing
      code that works and reads well. Over 1 million copies sold.
      Translated into dozens of languages. Still sparking debates about
      function length.
   
   .. his-project::
      :name: The Agile Manifesto
      :url: https://agilemanifesto.org/
      :start: 2001-02-11
      :technology: agile, collaboration, methodology, values
   
      Co-authored with 16 other signatories at Snowbird ski resort.
      Four values, twelve principles, infinite interpretations.
      Revolutionized software development industry. Occasionally
      misunderstood by management consultants selling certifications.

8. his-education

   • institution

   • institution-website

   • degree

   • start

   • finish

   • technology

   Example:

   .. his-education::
      :institution: Self-taught
      :start: 1970-01-01
      :technology: assembly, fortran, cobol, algorithms, data-structures
   
      Began programming professionally in 1970 on PDP-8 and PDP-11
      systems. Learned through hands-on experience, reading, and
      mentorship. Proof that mastery comes from dedication and
      deliberate practice, not just formal credentials.

CLI

$ historie --help
usage: historie [-h] [--logging-level LOGGING_LEVEL] [-f {html,pdf}] [-o OUTPUT] input

Generate a résumé in a publish format from reStructuredText.

positional arguments:
  input                 Input reStructuredText file

options:
  -h, --help            show this help message and exit
  --logging-level LOGGING_LEVEL
                        Logging level. By default: INFO.
  -f, --format {html,pdf}
                        Output format. By default: html.
  -o, --output OUTPUT   Output file: By default ".rst" is appended to input.