Merge pull request #45 from Descent098/v0.3.3

V0.3.3; May 25th 2022 The focus for this release was adding features that were not finalized in time for the `0.3.0`-`0.3.2` releases, and cleaning up some bugs. ### Features - Added `required_config` section to theme metadata that's used: - on initialization to generate the `config.yml` file - on build to cancel the build if a required value is missing from `config.yml` - Added section command (**note** `ezcv theme -s <section name>` **will no longer work**) - use `ezcv section <section name>` to get information - use `ezcv section <section name> [<type>]` to create a new section (note *type* is only required for any non-markdown sections i.e. blogs [can be "blog" or "b"] or galleries [can be "gallery" or "g"]). See [cli documentation](https://ezcv.readthedocs.io/en/latest/cli/) for full usage details - Added deepsource integration - Added issue template for creating new themes ### Themes - Added `massively` - Added `blog` - Added `evie` - Added `parallax` ### Bug Fixes - Fixed bug with downloading `aerial` theme from remote - Fixed bug where `ezcv_version` was generated incorrectly in the metadata - Fixed a bug where a theme without a `metadata.yml` file would not load properly
Descent098 · May 26, 2022 · c7a55d9 · c7a55d9
2 parents 3b7e39c + 7771212
commit c7a55d9
Show file tree

Hide file tree

Showing 25 changed files with 888 additions and 175 deletions.
diff --git a/.deepsource.toml b/.deepsource.toml
@@ -4,7 +4,8 @@ test_patterns = ["test/**"]
 
 exclude_patterns = [
   "docs/**",
-  ".github/**"
+  ".github/**",
+  "/ezcv/themes/**",
 ]
 
 [[analyzers]]

diff --git a/.github/ISSUE_TEMPLATE/new_theme.md b/.github/ISSUE_TEMPLATE/new_theme.md
@@ -0,0 +1,26 @@
+---
+name: New theme
+about: Suggest a new theme
+title: "[theme]"
+labels: theme
+---
+
+
+
+name: `<THEME NAME>`
+URL: `<THEME URL>`
+
+## TODO
+
+- [ ] Create theme
+    - [ ] Create `index.jijna`
+    - [ ] Add in CSS/JS
+    - [ ] Create sections
+    - [ ] Create metadata
+      - [ ] Add in `required: true` to fields that need it
+      - [ ] Add in required_config
+      - [ ] Add in analytics tag
+      - [ ] Add in highlightjs tag
+- [ ] Add documentation to `docs/included-themes.md`
+- [ ] Add to [https://github.com/qu-up/ezcv-themes](https://github.com/qu-up/ezcv-themes)
+- [ ] Add to `remotes.yml`
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,33 @@
 # Changelog
 
+## V0.3.3; May 25th 2022
+
+The focus for this release was adding features that were not finalized in time for the `0.3.0`-`0.3.2` releases, and cleaning up some bugs.
+
+### Features
+
+- Added `required_config` section to theme metadata that's used:
+  - on initialization to generate the `config.yml` file
+  - on build to cancel the build if a required value is missing from `config.yml`
+- Added section command (**note** `ezcv theme -s <section name>` **will no longer work**)
+  - use `ezcv section <section name>` to get information
+  - use `ezcv section <section name> [<type>]` to create a new section (note *type* is only required for any non-markdown sections i.e. blogs [can be "blog" or "b"] or galleries [can be "gallery" or "g"]). See [cli documentation](https://ezcv.readthedocs.io/en/latest/cli/) for full usage details
+- Added deepsource integration
+- Added issue template for creating new themes
+
+### Themes
+
+- Added `massively`
+- Added `blog`
+- Added `evie`
+- Added `parallax`
+
+### Bug Fixes
+
+- Fixed bug with downloading `aerial` theme from remote
+- Fixed bug where `ezcv_version` was generated incorrectly in the metadata
+- Fixed a bug where a theme without a `metadata.yml` file would not load properly
+
 ## V0.3.2; May 16th 2022
 
 More minor fixes

diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 ![ezcv logo](https://raw.githubusercontent.com/Descent098/ezcv/master/.github/logo.png)
 
+[![Downloads](https://pepy.tech/badge/ezcv)](https://pepy.tech/project/ezcv) [![DeepSource](https://deepsource.io/gh/Descent098/ezcv.svg/?label=active+issues&show_trend=true&token=Yg9KssXSgrClbYRYM3OMJhbI)](https://deepsource.io/gh/Descent098/ezcv/?ref=repository-badge)
+
 # ezcv
 
 *A python-based static site generator for setting up a CV/Resume site*
@@ -134,9 +136,10 @@ If you're on github then pushing the contents to master/main will activate the p
 ```shell
 Usage:
     ezcv [-h] [-v] [-p]
-    ezcv init [<name>] [<theme>]
     ezcv build [-d OUTPUT_DIR] [-o]
-    ezcv theme [-l] [-c] [-m] [-s SECTION_NAME] [<theme>]
+    ezcv init [<name>] [<theme>] [-f]
+    ezcv theme [-l] [-c] [-m] [<theme>]
+    ezcv section <SECTION_NAME> [-t=<type>]
 
 
 Options:
@@ -146,9 +149,10 @@ Options:
 -c, --copy            copy the provided theme, or defined site theme
 -p, --preview         preview the current state of the site
 -o, --optimize        Optimize output files (takes longer to run)
+-f, --flask           Generate Flask routes and requirements.txt
 -d OUTPUT_DIR, --dir OUTPUT_DIR The folder name to export the site to
 -m, --metadata        Generate metadata for the theme
--s SECTION_NAME, --section SECTION_NAME The section name to initialize
+-t=<type>, --type=<type> The type of section to generate [default: markdown]
 ```
 
 See the [CLI Documentation](https://ezcv.readthedocs.io/en/latest/cli/) for additional details

diff --git a/docs/cli.md b/docs/cli.md
@@ -5,9 +5,10 @@ Here is the full usage for the CLI, but see below for specifics of each command:
 ```bash
 Usage:
     ezcv [-h] [-v] [-p]
-    ezcv init [<name>] [<theme>]
     ezcv build [-d OUTPUT_DIR] [-o]
-    ezcv theme [-l] [-c] [-m] [-s SECTION_NAME] [<theme>]
+    ezcv init [<name>] [<theme>] [-f]
+    ezcv theme [-l] [-c] [-m] [<theme>]
+    ezcv section <SECTION_NAME> [-t=<type>]
 
 
 Options:
@@ -17,9 +18,10 @@ Options:
 -c, --copy            copy the provided theme, or defined site theme
 -p, --preview         preview the current state of the site
 -o, --optimize        Optimize output files (takes longer to run)
+-f, --flask           Generate Flask routes and requirements.txt
 -d OUTPUT_DIR, --dir OUTPUT_DIR The folder name to export the site to
 -m, --metadata        Generate metadata for the theme
--s SECTION_NAME, --section SECTION_NAME The section name to initialize
+-t=<type>, --type=<type> The type of section to generate [default: markdown]
 ```
 
 ## Init
@@ -97,8 +99,7 @@ There are two optional flags and one positional argument:
   - First it will check if a ```<theme>``` argument has been passed, and if it has it will copy that theme
   - Then it will check if there's a ```config.yml``` file in the current directory and copy that one
   - Then it will just default to exporting the dimension theme
-- ```-s``` Used to create a new section in a theme
-- ```-m``` used to generate metadata file (note will also copy into project folder if not already there)
+- ```-m``` used to generate metadata file (note will also copy into project folder if not already there, and `required_config` will not be specified)
 
 
 **Examples**
@@ -127,14 +128,70 @@ ezcv theme -c aerial
 ezcv theme -m
 ```
 
-*Create a new section called books in the current theme*
+## Section
+
+This command is used to create new sections
+
+```bash
+ezcv section <SECTION_NAME> [-t=<type>]
+```
+
+*Note that if a section exists it will just print details about the section*
+
+There are two optional flags and one positional argument:
+
+- ```-t``` The type of section to generate [default: markdown], can be a few options:
+  - `m` or `markdown`: Generate markdown section
+  - `g` or `gallery`: Generate gallery section
+  - `b` or `blog`: Generate blog section, note you can control which theme files to generate (by default all 3 will be generated but you can optionally specify 1-3 other letters)
+    - Add an `s` to generate `single.jinja` (i.e. `ezcv section <SECTION_NAME> -t bs`)
+    - Add an `f` to generate `feed.jinja` (i.e. `ezcv section <SECTION_NAME> -t bf`)
+    - Add an `o` to generate `overview.jinja` (i.e. `ezcv section <SECTION_NAME> -t bo`)
+
+*Create a new markdown section called books in the current theme*
 
 ```bash
-ezcv theme -s books
+ezcv section books
 ```
 
 or
 
 ```bash
-ezcv theme --section="books"
-```
+ezcv section "books" -t m
+```
+
+or
+
+```bash
+ezcv section books --type="markdown"
+```
+
+*Create a new gallery section called gallery in the current theme*
+
+```bash
+ezcv section gallery -t g
+```
+
+*Create a new blog section called blog (with all 3 jinja files) in the current theme*
+
+```bash
+ezcv section blog -t b
+```
+
+*Create a new blog section called blog with only single templates in the current theme*
+
+```bash
+ezcv section blog -t bs
+```
+
+*Create a new blog section called blog with only overview and feed templates in the current theme*
+
+```bash
+ezcv section blog -t bof
+```
+
+*Print details about existing section called 'blog'*
+
+```bash
+ezcv section blog
+```
diff --git a/docs/img/required_config_error.png b/docs/img/required_config_error.png
diff --git a/docs/img/theme-previews/blog.png b/docs/img/theme-previews/blog.png
diff --git a/docs/img/theme-previews/evie.png b/docs/img/theme-previews/evie.png
diff --git a/docs/img/theme-previews/massively.png b/docs/img/theme-previews/massively.png
diff --git a/docs/img/theme-previews/parallax-banner.png b/docs/img/theme-previews/parallax-banner.png
diff --git a/docs/img/theme-previews/parallax-progress.png b/docs/img/theme-previews/parallax-progress.png
diff --git a/docs/img/theme-previews/parallax.png b/docs/img/theme-previews/parallax.png