Metadata-Version: 2.1
Name: haumea
Version: 0.4.5
Summary: Small & fast python library to build static websites
Home-page: https://github.com/guillbertrand/haumea
Author: Guillaume Betrand
Author-email: gbe.io@pm.me
License: UNKNOWN
Keywords: SSG graphql json python static website generator
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# haumea

Small &amp; fast python library to build more sustainable websites... 
Hybrid & agnostic, haumea is a static site generator (SSG) optimized for external JSON (REST API, GraphQL etc.) data driven contents. 

Work in progress...

### Installation

    pip install haumea

### CLI

	haumea-quickstart
	haumea build
	haumea serve

### Documentation 

#### Directory Structure (base)

	/content/
	   index.html
	/layouts/
	   _base.html

#### Directory Structure (sample)


	/content/
	    index.html
	    page.html
	    /blog/              
	        /post-1.html   
		/post-2.html   
		/post-3.html   
	    /products/        
			/_product.html 
			/_product.graphql
	/layouts/
	    /partials/
		/header.html
		/footer.html
	    _base.html
	    page.html

#### Templating tags

	{{ _content }}
------------
	{% include "partials/header.html" %}
------------
	{% menu main %}
------------
	{% for menu in _menus.main %}
	    <li><a href="{{ menu.page.permalink }}">{{ menu.page._params.title }} - {{ menu.page._json_.fields.regular_price|{:.2f} }}</a></li>
	{% endfor %}
------------
	{{ title }}
	{{ fields.short_title }}
	{{ fields.regular_price|{:.2f} }}

	{{ image media_1 jpg 600x q60 }}

#### Content configuration 


##### Static page
------------

page.html

	{
	    "title":"Welcome home",
		"nav_title":"Home",
	    "description":"A nice description...",
	    "menus":["main", "footer"]
	}



##### Single page from JSON
------------

page.html

	{
		"json-source" : "https://api.buttercms.com/v2/pages/*/sample-page/",
		"json-request-type" : "get",
		"json-params" : { "locale" : "fr" , "auth_token" : "XXXXXXX" },
		"json-root-node" : "data", 

		"title" : "{{ _json.fields.title }} - {{ _json.fields.product_qty }}",
		"menus" : [ "main" ],
		"slug" : "test"
	}


##### Page bundle from JSON with GraphQL
------------

_page.html 

	{
		"json-source" : "https://graphql.datocms.com/",
		"json-request-type" : "graphql",
		"json-headers" : {"Authorization":"token xxxxxxx"},
		"json-root-node" : "data.allProduits", 

		"title": "_title",
		"meta-desc" : "{{ _json.meta_description }}",
		"meta-title" : "{{ _json.meta_title }}",
		"slug" : "{{ _json.slug }}",

		"menus" : [ "products", "footer" ]
	}


_page.graphql

	query {
		launchesPast(limit: 80) { 
			mission_name 
			details
			launch_date_local 
			rocket { 
				rocket_name 
			} 
			ships { 
				name 
				image 
			}
		}
	}


