cushead


Namecushead JSON
Version 4.0.4 PyPI version JSON
download
home_pagehttps://github.com/lucasvazq/cushead
SummaryCLI that help you to improve the SEO and UX of your websites.
upload_time2021-01-20 03:57:29
maintainer
docs_urlNone
authorLucas Vazquez
requires_python>=3.8
licenseMIT
keywords seo meta-tags ux pwa front-end favicon manifest robots browserconfig sitemap opensearch
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Build Status](https://api.travis-ci.org/lucasvazq/cushead.svg?branch=master)](https://travis-ci.org/lucasvazq/cushead)
[![codecov](https://codecov.io/gh/lucasvazq/cushead/branch/master/graph/badge.svg)](https://codecov.io/gh/lucasvazq/cushead)
[![PyPI version](https://badge.fury.io/py/cushead.svg)](https://badge.fury.io/py/cushead)

<div align="center">
  <img src="https://github.com/lucasvazq/cushead/raw/master/docs/logo.png" alt="cushead logo">
</div>

# CUSHEAD

**Generates a basic website template with a focus on _SEO_ and _UX_.**

## Description

This is a small script that allows you to generate a basic template of a website through a configuration file.\
In this file, you can define different variables that will produce a different template in each case.

[View live example](https://lucasvazq.github.io/cushead/)\
[View example of generated files](https://github.com/lucasvazq/cushead/blob/master/docs/examples/relative_static_url/example/output)

## Installation

`pip install cushead`

_Required python version >= 3.8_

## Usage

```
usage: cushead { --help | { --config | --default [ --images ] } FILE }

excluding arguments:
  -h, --help     Show this help message and exit.
  -c, --config   Read a config file and create the website template based on it.
  -d, --default  Generate a default config. Can be used with --images.

optional arguments:
  -i, --images   Use with --default. Generate default images that can be used by the default config file.
                 This include: favicon_ico_16px.ico, favicon_png_2688px.png, favicon_svg_scalable.svg and preview_png_600px.png

positional arguments:
  FILE           Input or output file used by the --config or --default arguments.
                 For --config it must be a path to a config file in JSON format.
                 For --default it must be the destination path where to want to create the default config.
                 If the --images argument is set, the images would be created in the directory of that file.

Examples:
1) Generate default config file with images:
  cushead --default --images config.json
2) Run that config:
  cushead --config config.json
```

## Recomendation

Web development is an area that is very evolved today. It has grown a lot over the years and, like everything that proliferates, it has become more complex.
This little package only solves a small part of all the problems that exist in the field of web development. If you want to take a closer look, here is an interactive website that shows a lot of things to consider when working in this area: [andreasbm/web-skills][web-skills]\
My advice is don't get stuck with so much information, the sites will work anyway. Only if the expense is justified, it is always good to face all these things with a team and try to use already created tools that are kept up to date.

[web-skills]: https://andreasbm.github.io/web-skills/

## License

cushead © 2019 Lucas Vazquez. Released under the [MIT][license] License.

[license]: http://mit-license.org/



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/lucasvazq/cushead",
    "name": "cushead",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "SEO,meta-tags,UX,PWA,front-end,favicon,manifest,robots,browserconfig,sitemap,opensearch",
    "author": "Lucas Vazquez",
    "author_email": "lucas5zvazquez@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/8d/9d/91fcce39a4e1adbb6d48801da2f0f337e85afbeb433196650695c3c5eb57/cushead-4.0.4.tar.gz",
    "platform": "any",
    "description": "[![Build Status](https://api.travis-ci.org/lucasvazq/cushead.svg?branch=master)](https://travis-ci.org/lucasvazq/cushead)\n[![codecov](https://codecov.io/gh/lucasvazq/cushead/branch/master/graph/badge.svg)](https://codecov.io/gh/lucasvazq/cushead)\n[![PyPI version](https://badge.fury.io/py/cushead.svg)](https://badge.fury.io/py/cushead)\n\n<div align=\"center\">\n  <img src=\"https://github.com/lucasvazq/cushead/raw/master/docs/logo.png\" alt=\"cushead logo\">\n</div>\n\n# CUSHEAD\n\n**Generates a basic website template with a focus on _SEO_ and _UX_.**\n\n## Description\n\nThis is a small script that allows you to generate a basic template of a website through a configuration file.\\\nIn this file, you can define different variables that will produce a different template in each case.\n\n[View live example](https://lucasvazq.github.io/cushead/)\\\n[View example of generated files](https://github.com/lucasvazq/cushead/blob/master/docs/examples/relative_static_url/example/output)\n\n## Installation\n\n`pip install cushead`\n\n_Required python version >= 3.8_\n\n## Usage\n\n```\nusage: cushead { --help | { --config | --default [ --images ] } FILE }\n\nexcluding arguments:\n  -h, --help     Show this help message and exit.\n  -c, --config   Read a config file and create the website template based on it.\n  -d, --default  Generate a default config. Can be used with --images.\n\noptional arguments:\n  -i, --images   Use with --default. Generate default images that can be used by the default config file.\n                 This include: favicon_ico_16px.ico, favicon_png_2688px.png, favicon_svg_scalable.svg and preview_png_600px.png\n\npositional arguments:\n  FILE           Input or output file used by the --config or --default arguments.\n                 For --config it must be a path to a config file in JSON format.\n                 For --default it must be the destination path where to want to create the default config.\n                 If the --images argument is set, the images would be created in the directory of that file.\n\nExamples:\n1) Generate default config file with images:\n  cushead --default --images config.json\n2) Run that config:\n  cushead --config config.json\n```\n\n## Recomendation\n\nWeb development is an area that is very evolved today. It has grown a lot over the years and, like everything that proliferates, it has become more complex.\nThis little package only solves a small part of all the problems that exist in the field of web development. If you want to take a closer look, here is an interactive website that shows a lot of things to consider when working in this area: [andreasbm/web-skills][web-skills]\\\nMy advice is don't get stuck with so much information, the sites will work anyway. Only if the expense is justified, it is always good to face all these things with a team and try to use already created tools that are kept up to date.\n\n[web-skills]: https://andreasbm.github.io/web-skills/\n\n## License\n\ncushead \u00a9 2019 Lucas Vazquez. Released under the [MIT][license] License.\n\n[license]: http://mit-license.org/\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CLI that help you to improve the SEO and UX of your websites.",
    "version": "4.0.4",
    "split_keywords": [
        "seo",
        "meta-tags",
        "ux",
        "pwa",
        "front-end",
        "favicon",
        "manifest",
        "robots",
        "browserconfig",
        "sitemap",
        "opensearch"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1f8cdc87959768b9c1bf92ef801ada74",
                "sha256": "4af086c9557a98154ee4ae121aaf36751511f5eb5f1865c7254ee885d050f8ed"
            },
            "downloads": -1,
            "filename": "cushead-4.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1f8cdc87959768b9c1bf92ef801ada74",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 76322,
            "upload_time": "2021-01-20T03:57:28",
            "upload_time_iso_8601": "2021-01-20T03:57:28.385047Z",
            "url": "https://files.pythonhosted.org/packages/ed/72/18fdcb8913ba23b945b0204d3cf4938ea689f5e094928d4e3db2c08af306/cushead-4.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "5a0010f82ea2a66d4d563344857964b2",
                "sha256": "317459f9575a5434c92d88fa6df7c06bef91876e4778ae8a17673ffd39fd83a8"
            },
            "downloads": -1,
            "filename": "cushead-4.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "5a0010f82ea2a66d4d563344857964b2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 41849,
            "upload_time": "2021-01-20T03:57:29",
            "upload_time_iso_8601": "2021-01-20T03:57:29.722222Z",
            "url": "https://files.pythonhosted.org/packages/8d/9d/91fcce39a4e1adbb6d48801da2f0f337e85afbeb433196650695c3c5eb57/cushead-4.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-01-20 03:57:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "lucasvazq",
    "error": "Could not fetch GitHub repository",
    "lcname": "cushead"
}
        
Elapsed time: 0.21883s