An easy to use personal site generator
Project description
ezcv
A python-based static site generator for setting up a CV/Resume site
Table of Contents
- What does ezcv do?
- Features & Roadmap
- Why should I use ezcv?
- Who is ezcv for?
- Quick-start
- CLI
- Additional Documentation
- Examples and resources
What does ezcv do?
ezcv is a purpose built static site generator for creating personal resume/portfolio/cv sites
Features & Roadmap
- A large collection of built in themes
- Flexible templating with Jinja2
- Fully customizable configuration files and sections
- Simple markdown syntax for content building
Why should I use ezcv?
ezcv is a great choice if:
- You are fond of one of the built in themes
- You want a free and open source static site generator
- If you want a simple to use static site generator based on Jinja
- If you are familiar with markdown and yaml, and want a system that can be extended
- You are not familiar with static site generators and want a simple one to try out
- You want a static site generator with a built in github pages deploy pipeline
ezcv is not a great choice if:
- You want a widely used industry solution (something like hugo or jekyl would be better for this)
- You need low level access to the API for complicated extensions that are not possible within jinja
- You are not familiar with markdown, yaml and jinja and want a frontend to edit your site with ( netlify, squarespace or wix would be better for this)
Who is ezcv for?
- People who are not necessarily familiar with coding, let alone web development
- People who are familiar with web development and want a very simple to use static site generator
- People who are familiar with web development but don't want to bother writing pure html for their site
Quick-start
Here's everything you need to know to get started with ezcv.
No-code/remote setup
Note that there is an option to develop a site completely on your browser without needing to install anything or know how to use git. For details on setting this up, please visit https://ezcv.readthedocs.io/en/latest/quick-start/#remote-editing.
Installation
To use ezcv you will need python 3.6+ (earlier versions wont work) and pip for python 3.
From PyPi
- Run
pip install ezcv
From source
- Clone this repo: https://github.com/Descent098/ezcv
- Run
pip install .orsudo pip3 install .in the root directory
Getting started
The easiest way to get started is by running:
ezcv init <name>
Replacing the <name> argument with your name (use "" if you want to use your full name i.e. ezcv init "Kieran Wood").
File structure
When you run the command a new folder will be created with your name, and some starter files like this:
Legend
| Icon | Meaning |
|---|---|
| 📁 | File Folder |
| 📷 | Image file |
| 📝 | File you should edit/delete |
| 📄 | File you don't need to edit/shouldn't delete |
📁<name>/
├── 📁.github/
│ └── 📁workflows/
│ └── 📄ezcv-publish.yml
├── 📁content/
│ ├── 📁education/
│ | ├── 📝example-current.md
│ | └── 📝example-old.md
│ ├── 📁projects/
│ | └── 📝example.md
│ ├── 📁volunteering_experience/
│ | ├── 📝example-current.md
│ | └── 📝example-old.md
│ └── 📁volunteering_experience/
│ ├── 📝example-current.md
│ └── 📝example-old.md
├── 📁images/
│ ├── 📷 abstract-landscape.jpg
│ └── 📷 ice-caps.jpg
├── 📄.gitignore
└── 📝config.yml
From here you can go into your config.yml file and pick a theme, then start filling out your content according to what's available for the theme.
To preview your content use:
ezcv -p
If you're on github then pushing the contents to master/main will activate the publish workflow and automatically publish the site to <username>.github.io.
CLI
Usage:
ezcv [-h] [-v] [-p]
ezcv init [<name>] [<theme>]
ezcv build [-d OUTPUT_DIR] [-p]
ezcv theme [-l] [-c] [-s SECTION_NAME] [<theme>]
Options:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-l, --list list the possible themes
-c, --copy copy the provided theme, or defined site theme
-p, --preview preview the current state of the site
-d OUTPUT_DIR, --dir OUTPUT_DIR The folder name to export the site to
-s SECTION_NAME, --section SECTION_NAME The section name to initialize
See the CLI Documentation for additional details
Additional Documentation
Examples and resources
Template repository for bootstrapping projects
See documentation for included themes for examples of each of the included themes
Changelog
V0.2.2; August 2nd 2021
Documentation bugs after release
Bug fixes
- Fixed issue with mkdocs build not recognizing correct URL and image paths
V0.2.1; August 2nd 2021
Fixed bugs after release
Bug fixes
- Fixed the fact that colored was not included as setup.py dependency
V0.2.0; August 2nd 2021
The focus for this release is to add new features and themes
Features
- Added Resume Generator
- Setup remote theme support
- Added new section; gallery
- Supports multiple images being put together into a gallery
- Google analytics config option
- Custom Favicon
- Added new section creation CLI
- When initializing with a theme that is not downloaded it will try to be downloaded on initialization instead of first build
- Added support for all standard markdown file extensions (.md, .markdown, .mdown, .mkdn, .mkd, .mdwn)
- Added support for many image file extensions as content (.jpg, .png, .jpeg, .gif, .svg, .webp, .apng, .jfif, .pjpeg, .pjp)
- Added many new markdown extensions
- Created filters module for creating custom Jinja filters (will be an exposed API for adding your own in v0.3.0)
- Created several custom filters for optimizing & simplifying theme development
- split_to_sublists; Takes a list and splits it into sublists of size n
- get_image_path; Takes in the path to an image and returns it in usable format to use in img tags as src attribute
- get_filename_without_extension; Takes in path and returns filename without extension
- pretty_datetime; A utility function for pretty printing dates provided for jobs/getting a degree/volunteering etc
- pretty_defaultdict; Returns a prettyprinted form of a defaultdict
Themes
- Moved existing themes to new repo https://github.com/QU-UP/ezcv-themes
- Added new themes
Bug fixes
- Fixed markdown files with different standard extensions not being recognized
- Fixed markdown files with capitalized extensions not being recognized
Documentation Improvements
- Added documentation for new features
- Added additional onboarding videos/tutorials
- Added section for finding help/support
V0.1.1; January 10th 2020
Fixes following initial launch
Bug fixes
- Added additional warnings for if necessary config value is not provided
Documentation improvements
- Updated necessary docstrings
V0.1.0; January 10th 2020
Initial release of ezcv
Features
- Themes Added:
- Added initial example site
- Added initial CLI
- Added initial core files
- Added to pypi
Documentation improvements
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
