Metadata-Version: 1.2
Name: hugon
Version: 0.1.0
Summary: An incredibly simple python script that makes working with archtypes in Hugo 0.5x much easier.
Home-page: https://github.com/hithismani/hugon
Author: Mani Kumar
Author-email: hi@manikumar.in
License: MIT license
Description: =====
        hugon
        =====
        
        
        .. image:: https://img.shields.io/pypi/v/hugon.svg
                :target: https://pypi.python.org/pypi/hugon
        
        
        An incredibly simple python script that makes working with archetypes in Hugo 0.5x much easier.
        
        * 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 simply converting a provided string into a filename.
        * When working with pages that require us to create multiple markdown files in sequence (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.
        
        Features
        --------
        
        * Enter a string with as many special characters you wish to enter, the script will conver it into a suitable filename. Eg: "This new blog post I want to write!" in the command line would be converted 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.
        * Let's 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.
        * Colour codes the output (uses Colorama!) for you to differenciate between outputs.
        * Let's you use a custom separator if you'd like something apart from '-' hyphens in your file name.
        
        Requirements
        ------------
        * Python 3.x
        * Hugo CLI (Tested on 0.59.1)
        
        How To Use
        ----------
        1) pip install hugon
        2) cd Into your hugo initialized folder.
        3) run the command 'hugon -name "N3w F!le" -arch "default" -sequence "5"
        
        Syntax
        ------
        +------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+-------------------+------------------------------------------------+
        | 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  | Let's you create multiple files with a sequence as a postfix. Helpful of 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 | Let's you define a custom separatorthat'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 |
        +------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+-------------------+------------------------------------------------+
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2019-12-06)
        ------------------
        
        * First release on PyPI.
        
Keywords: hugon
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
