Website

The website python package, provides cli commands to help write blog entries for my website on https://www.rohailtaimour.com

This repository also contains the content of the website and static assets needed to render it on github pages using hugo.

Dependencies

• Hugo
• For jupyter notebooks like blog post entries I use Quarto
• Python 3.10
• uv for installing dependencies, virtual environment

Directory structure

Overview of WIP blog posts

Quarto

One of my favourite ways to explore ideas is via jupyter notebooks and quarto provides that interface by allowing you to add a code execution environment that helps keep text and code in sync.

The _quarto.yaml file in the project root (shown below) allows the use of rendering *.qmd files into regular markdown files.

project:
  type: hugo
  render:
    - "*.qmd"
    - "!themes/"

format:
  hugo-md:
    code-fold: true
    code-summary: "Show the code"
    code-overflow: wrap
    code-tools: true
    code-block-bg: true
    code-block-border-left: "#31BAE9"
    code-copy: hover
    code-line-numbers: true
    # highlight-style:
    #   light: arrow
    #   dark: arrow-dark

execute:
  warning: false
  freeze: true
  enabled: false

Rendering qmd files to regular markdown files is done by quarto render. That would render the contents of the website in the current directory. The extra front matter you need to declare may have the following contents:

# regular front matter ...
toc: true
format: hugo-md
jupyter:
  kernel: "scraper-series"
execute:
  enabled: true
  freeze: false

Quick start

1. Install the website package and its development dependencies, follow these steps:

   uv pip install -e ".[dev]"

2. website --help should list the relevant output

│ list-draft-posts   Concatenate all draft posts into a single markdown file.
│ new-post           Create a new post with a given title under a specified category.

Bumping package version and updating changelog

Using the script release.py, bump2version and the github action .github/workflows/release-package.yaml I'm automating my package release process.

Each new release has a section in the CHANGELOG.md under the [Unreleased] section for keeping track of changes made to the python package since the last release.