Skip to main content

An incredibly simple python script that makes working with archtypes in Hugo 0.5x much easier.

Project description

hugon (Hugo + Python)

Hugon Header Image https://img.shields.io/pypi/v/hugon.svg

An incredibly simple (CLI) python script that makes working with archetypes in Hugo 0.5x much easier. Also automates the process of bulk file creation via a single .csv!

Read my medium post for a quick idea of what this package does.

Hugon Sample Run
  • Free software: MIT license

Why

  • When working with archetypes, the CLI expects us to mention the exact file name we want to create, instead of converting a provided string into a valid file name.
  • Inability to create a sequence of files (Example, creating an FAQ’s Markdown Page with faq-1.md, faq-2.md, faq-3.md file names). We’re expected to enter them manually each time.
  • When working with projects that require us to create multiple markdown files, we can’t add more than the “title” field to our markdown files.

Features

  • Enter a string with as many special characters, watcht them be converted into a suitable file name.

    Eg: “This new blog post I want to write!” in the command line would convert into “this-new-blog-post-i-want-to-write.md”.

  • Enter the archetype you wish to enter, the script will check if the archetype exists. If it doesn’t exist, Hugo CLI will prompt you with an error.

  • Create multiple markdown files and automatically populate the variables + content fields from a local CSV! (YAML format front matter only)

  • (NEW) Lets you download files from a link into a specific path within your project and aassign the values into your .md file! (CSV Only)

  • Lets you use a custom prefix CLI if you’re using any other CLI that handshakes with hugo. Only changes prefix that could replace the “hugo new” function

  • Enter the amount of files you want to create in sequence, the script will create everything.

  • Lets you use a custom separator if you’d like something apart from ‘-‘ hyphens in your file name.

  • Colour codes the output (ft. colorama) for you to differentiate between outputs.

Requirements

  • Python 3.x
  • Hugo CLI (Tested on 0.59.1)
  • Archetype file within your project root/theme archetype folder.

How To Use (Normal)

  1. Install Hugon:

    pip install hugon
    
  1. cd Into your hugo project folder.

  2. run the command:

    hugon -name "N3w F!le" -archetype "default" -sequence "5"
    

Syntax (Normal)

Command Description Required? Example Converts Into
-archetype Define Archetype Name (without file extension). The Archetype file of this name should be present in the archetype folder. (Name is automatically converted to lowercase) Yes Default default
-name Filename you’d want to set. Can contain spaces, numbers, special characters, all which will be stripped (and converted to lowercase) to create a seamless file name to send to Hugo CLI. Yes FILE NAM3 Ex@mple file-nam3-exmple.md
-sequence Lets you create multiple files with a ‘sequence’ as a postfix. Helpful if you’re working with FAQ’s, or other pages where file name doesn’t necessarily matter. Value has to be more than 1, with sequence kicking off skipping 0. No 5 file-nam3-exmple1.md
file-nam3-exmple2.md
file-nam3-exmple3.md
file-nam3-exmple4.md
file-nam3-exmple5.md
-separator Lets you define a custom separator that’s not “-” a hyphen. No _ file_nam3_example.md
-prefix Use another command instead of “hugo new”. No npm run customdev npm run customdev default/file_nam3_example.md

How To Use (Generate From CSV)

  1. Create a ‘data.csv’ file in the root of your hugo site.

  2. Enter all the required variable fields (along with the required compulsory fields) as columns on your first row, and populate to your hearts content.

  3. Run command:

    hugon -csv yes
    
  4. If you’d like to overwrite your files without being prompted (Risky) just pass ‘-overwrite true’ as an argument.:

    hugon -csv yes -overwrite true
    

Syntax (CSV)

Hugon Sample Run | CSV

Warning: Files would be modified the moment they’re made. Mistakes cannot be undone.

Column Name Required Purpose
archetype Yes States archetype of post to be made.
content No Lets you add matter to the “content” section of your markdown file.
filename No Lets you specify another filename if you don’t want to use a ‘sluggified’ title. Please ensure you don’t add ‘.md’ to the filename and your file name has the proper separators.
title Yes Title field/filename.
da-<key> No Download Anchorlink column that lets the script know that the value of the field is a download link. Must be followed by the key it assigns to. Eg: ‘da-image’. Single use only.
path No(?) (Required if ‘da-‘ is specified) Lets the script set the download location of the file specified above. Creates the folder if it doesn’t exist.
prefix No Any custom build command you’d like to specify.
separator No Any custom separator (if you’re generating from title column) apart from default ‘-‘.
  • Looking to add tags/taxonomies? Separate your values in the column with a “^;”
  • Looking to values to your YAML without quotation marks? (Eg: true/false values) Prepend your value with “^”
  • Need line breaks within your ‘content’ cell? Specify them with a ‘n’
  • If you’re using the “path” key, note that the script would add the path into your front matter by ommiting the first folder. Eg: “static/img/ex.jpg” would be inserted as “img/ex”. If you’d like to retain the parent folder name in front matter, just add “?” to the beginning of the value in your CSV path field.
  • View sample CSV attached within this repository for more information.
  • Note:
    • Remember to remove any whitespace around your cell headings and values.
    • If the script doesn’t work as expected, please check your archetype keys for typos/spaces as well.

TO DO

  • Adding option to input values from CSV. (Done!)
  • Adding option to get image/file from a URL and downloading it straight into a specified folder. CSV Only. (Done!)
  • Adding option to expand download functionality to allow for download of multiple files.
  • TOML format support.
  • Fixing typos and grammatical errors in code + this readme doc. (Never ending :( )

Credits

History

0.1.7 (2020-08-01)

  • Fixed Functionality:
    • CSV would now “continue” to next row instead of earlier “break”, if the values in the row are incorrect.
    • By default, path field in front matter would remove the first folder. (Eg: “static/img/ex.jpg” would be saved into the static folder, but inserted into front matter as “img/ex.jpg”)
    • You can still retain parent folder in your front matter by adding “?” to the beginning of your path.
  • Tiny fixes and performance improvements.

0.1.6 (2019-12-27)

  • Added new functionality:
    • CSV now allows you to download a single file into your project folder. Specify ‘da-‘ suffix in the key column, and mention the anchor link in your values field. Might not work with restricted URLs.
    • Above functionality works only when you have a ‘path’ column specified with the name of the folder the file should go into, within the root of your project. Does not currently support downloading multiple files related to a single page.
  • Added sample CSV link to help understand the above functionality and others better.
  • Fixed typos and grammatical errors within the code and readme file. Oops!
  • Added comment entries to a few functions for easier readability.
  • Homogenized the method used to combine folder paths, making the script function more predictably cross platform.
  • Cleaned up the terminal, and added closing credits (script name) to show up after execution.
  • Updated readme to make it easier to understand.
  • Renamed “images” folder (in the github repository) to “sample”.

0.1.5 (2019-12-26)

  • Fixed bug that stopped you from specifying a file name with separators within the name.
  • Updated display screenshot to reflect the above change.
  • Added do-it-live.sh file for ease of screenshot creation. Not added the same into dependencies.

0.1.4 (2019-12-13)

  • Fixed bug that stopped you from specifying a sequence.
  • Fixed content replacement (CSV) issue that duplicated the section instead of replacing it.
  • Pushed non-hugo CLI messages to colorama function for easy readability.
  • Added pretty ‘horizontal line breaks’ after any code is executed. (Resizes the next output to your existing terminal size).
  • Other bug fixes and optimizations.

0.1.1 (2019-12-13)

  • Added CSV support for dynamic YAML markdown file generation.

0.1.0 (2019-12-06)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hugon, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size hugon-0.1.7-py2.py3-none-any.whl (10.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size hugon-0.1.7.tar.gz (21.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page