Package `ezcv`

A python-based static site generator for setting up a CV/Resume site

Note

If this is your first time using ezcv I would recommend looking at the user docs at https://ezcv.readthedocs.io

Installation

From pypi

pip install ezcv or sudo pip3 install ezcv

From source

git clone https://github.com/Descent098/ezcv
pip install . or sudo pip3 install .

Modules

core

The module containing all primary functionality of ezcv including:

Section parsing
HTML generation
Site exporting

cli

The module containing all cli functionality of ezcv including:

Initializing sites
Generating temporary preview
Getting lists of themes and/or copying themes

Content

This module is for handling all the functionality around content including:

Getting the list of content directories
Getting the metadata and contents of content files for sections
Classes for parsing all extensions

Filter

This is a module that provides additional jinja filters to help with theme development

Themes

Contains utilities related to theme management, discovery and creation including:

Section template discovery and creation
Remote repo management
Theme discovery & updating

Quickstart

Generating a site using all settings defined in "config.yml"

from ezcv.core import generate_site

generate_site()

Generating a site overriding the theme in "config.yml", output directory and specifying to show a preview of the site

from ezcv.core import generate_site

generate_site(output_folder="my_site", theme = "aerial", preview = True)

Expand source code

"""A python-based static site generator for setting up a CV/Resume site

Note
----
If this is your first time using ezcv I would recommend looking at the user docs at https://ezcv.readthedocs.io

Installation
------------
#### From pypi
```pip install ezcv``` or ```sudo pip3 install ezcv```

#### From source
1. ```git clone https://github.com/Descent098/ezcv```
2. ```pip install .``` or ```sudo pip3 install .```

Modules
-------
#### core
The module containing all primary functionality of ezcv including:

- Section parsing
- HTML generation
- Site exporting

#### cli
The module containing all cli functionality of ezcv including:

- Initializing sites
- Generating temporary preview
- Getting lists of themes and/or copying themes

#### Content
This module is for handling all the functionality around content including:

- Getting the list of content directories
- Getting the metadata and contents of content files for sections
- Classes for parsing all extensions

#### Filter

This is a module that provides additional jinja filters to help with theme development

#### Themes

Contains utilities related to theme management, discovery and creation including:

- Section template discovery and creation
- Remote repo management
- Theme discovery & updating

Quickstart
----------
#### Generating a site using all settings defined in "config.yml"
```
from ezcv.core import generate_site

generate_site()
```

#### Generating a site overriding the theme in "config.yml", output directory and specifying to show a preview of the site
```
from ezcv.core import generate_site

generate_site(output_folder="my_site", theme = "aerial", preview = True)
```
"""

Sub-modules

ezcv.cli: The module containing all cli functionality of ezcv including: - Initializing sites - Generating temporary preview - Getting lists of …
ezcv.content: This module is for handling all the functionality around content including: …
ezcv.core: The module containing all primary functionality of ezcv including: …
ezcv.filters: This is a module that provides additional jinja filters to help with theme development …
ezcv.themes: Contains utilities related to theme management, discovery and creation including: …