# Wagtail resume
[](https://codecov.io/gh/adinhodovic/wagtail-resume/branch/main)
[](https://pypi.org/project/wagtail-resume/)
[](https://pypi.org/project/wagtail-resume/)
Wagtail-resume is a reusable Wagtail page model designed to make the creation of your resume easy and quick.
Feaures:
- Easy management of your resume in Wagtail
- Search engine optimized using HTML meta tags - make it easier to find your resume in Google
- Flexible section creation of projects, blog posts, etc
- Easy customizations of font, icons and background color
- Easily reference other content on your Wagtail page as blog posts
- HTML based, no more sending of PDFs, just a url for sharing
- In-site Weasyprint button for a PDF version
- Responsive for mobile and tablet
## Preview
The full resume example is [live and accesible here.](https://hodovi.cc/wagtail-resume-sample)
## Dependencies
- Wagtail-metadata
- It uses wagtail-metadata for all meta & SEO fields.
- Wagtail-markdown
- Weasyprint
- Uses Weasyprint to generate a PDF from the HTML page.
## Installation
Install wagtail-resume with pip:
`pip install wagtail-resume`
Add the application and dependencies to installed Django applications:
```py
INSTALLED_APPS = [
...
"wagtailmetadata",
"wagtailmarkdown",
"wagtail_resume",
...
]
```
Add the urls for generating a pdf using Weasyprint:
```py
path("resume/", include("wagtail_resume.urls")),
```
Run the migrations.
## Getting started
Import and extend the BaseResumePage:
```python
# home/models.py
from wagtail_resume.models import BaseResumePage
class ResumePage(BaseResumePage):
pass
```
After adding the model you'll need to make a migration
```
python manage.py makemigrations
```
... and then apply it
```
python manage.py migrate
```
Head over to the Wagtail admin and create your resume!
Weasyprint generates PDFs using the absolute URL of a resume which consists of the hostname, port and path. Therefore don't forget to configure your site's host and path in the Wagtail admin interface which is located in settings -> sites. E.g when running the server locally the host should be localhost and the port should be 8000 (or whichever port you develop locally with).
## Default Fields
Default resume fields:
- Role
- Profile picture
- Social links
- About
- Work Experience
- Contributions (Opensource/projects)
- Writing (internal Wagtail pages or external URLs)
- Education (Degrees/Courses/Certificates)
## Customization
Wagtail-resume currently supports 4 customizations:
- Heading for a section
- Icon for a section (Fontawesome)
- Font style
- Background color
- PDF generation button visibility (public, authenticated, disabled)
The background-color should be specified in hex (e.g #FFFFFF) or [css supported colors](https://www.w3schools.com/cssref/css_colors.asp) and the font should be available on Google fonts. The fonts supported are only the ones from [Google Fonts](https://fonts.google.com/) so make sure to check what fonts are available.
Raw data
{
"_id": null,
"home_page": "https://github.com/adinhodovic/wagtail-resume",
"name": "wagtail-resume",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "Resume, Django, Wagtail, CMS",
"author": "Adin Hodovic",
"author_email": "hodovicadin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/46/88/80e98101592735a4c03a72e93901d23faf6d3e8cebdc0c052bd42384f373/wagtail_resume-2.8.0.tar.gz",
"platform": null,
"description": "# Wagtail resume\n\n\n\n[](https://codecov.io/gh/adinhodovic/wagtail-resume/branch/main)\n[](https://pypi.org/project/wagtail-resume/)\n[](https://pypi.org/project/wagtail-resume/)\n\nWagtail-resume is a reusable Wagtail page model designed to make the creation of your resume easy and quick.\n\nFeaures:\n\n- Easy management of your resume in Wagtail\n- Search engine optimized using HTML meta tags - make it easier to find your resume in Google\n- Flexible section creation of projects, blog posts, etc\n- Easy customizations of font, icons and background color\n- Easily reference other content on your Wagtail page as blog posts\n- HTML based, no more sending of PDFs, just a url for sharing\n- In-site Weasyprint button for a PDF version\n- Responsive for mobile and tablet\n\n## Preview\n\n\n\nThe full resume example is [live and accesible here.](https://hodovi.cc/wagtail-resume-sample)\n\n## Dependencies\n\n- Wagtail-metadata\n - It uses wagtail-metadata for all meta & SEO fields.\n- Wagtail-markdown\n- Weasyprint\n - Uses Weasyprint to generate a PDF from the HTML page.\n\n## Installation\n\nInstall wagtail-resume with pip:\n\n`pip install wagtail-resume`\n\nAdd the application and dependencies to installed Django applications:\n\n```py\nINSTALLED_APPS = [\n ...\n \"wagtailmetadata\",\n \"wagtailmarkdown\",\n \"wagtail_resume\",\n ...\n]\n```\n\nAdd the urls for generating a pdf using Weasyprint:\n\n```py\n path(\"resume/\", include(\"wagtail_resume.urls\")),\n```\n\nRun the migrations.\n\n## Getting started\n\nImport and extend the BaseResumePage:\n\n```python\n# home/models.py\nfrom wagtail_resume.models import BaseResumePage\n\n\nclass ResumePage(BaseResumePage):\n pass\n```\n\nAfter adding the model you'll need to make a migration\n\n```\npython manage.py makemigrations\n```\n\n... and then apply it\n\n```\npython manage.py migrate\n```\n\nHead over to the Wagtail admin and create your resume!\n\nWeasyprint generates PDFs using the absolute URL of a resume which consists of the hostname, port and path. Therefore don't forget to configure your site's host and path in the Wagtail admin interface which is located in settings -> sites. E.g when running the server locally the host should be localhost and the port should be 8000 (or whichever port you develop locally with).\n\n## Default Fields\n\nDefault resume fields:\n\n- Role\n- Profile picture\n- Social links\n- About\n- Work Experience\n- Contributions (Opensource/projects)\n- Writing (internal Wagtail pages or external URLs)\n- Education (Degrees/Courses/Certificates)\n\n## Customization\n\nWagtail-resume currently supports 4 customizations:\n\n- Heading for a section\n- Icon for a section (Fontawesome)\n- Font style\n- Background color\n- PDF generation button visibility (public, authenticated, disabled)\n\nThe background-color should be specified in hex (e.g #FFFFFF) or [css supported colors](https://www.w3schools.com/cssref/css_colors.asp) and the font should be available on Google fonts. The fonts supported are only the ones from [Google Fonts](https://fonts.google.com/) so make sure to check what fonts are available.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Wagtail project made to simplify creation of resumes for developers.",
"version": "2.8.0",
"project_urls": {
"Documentation": "https://github.com/adinhodovic/wagtail-resume",
"Homepage": "https://github.com/adinhodovic/wagtail-resume",
"Repository": "https://github.com/adinhodovic/wagtail-resume"
},
"split_keywords": [
"resume",
" django",
" wagtail",
" cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7ab6fc1ce59e736a3d24fc0476baae04bfc4db1dad7a2c58779c4fe9b67277f",
"md5": "c8f7e8ab599a0290fee2f32011dfd2ca",
"sha256": "148969c058ae323cea01adfe8e1c118d33705ce24097b910b8017268eaa70026"
},
"downloads": -1,
"filename": "wagtail_resume-2.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c8f7e8ab599a0290fee2f32011dfd2ca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 31260,
"upload_time": "2024-04-30T11:10:37",
"upload_time_iso_8601": "2024-04-30T11:10:37.504913Z",
"url": "https://files.pythonhosted.org/packages/f7/ab/6fc1ce59e736a3d24fc0476baae04bfc4db1dad7a2c58779c4fe9b67277f/wagtail_resume-2.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "468880e98101592735a4c03a72e93901d23faf6d3e8cebdc0c052bd42384f373",
"md5": "35e6459c4a83c96be49504f196266013",
"sha256": "34fd0aa45811ffac7c4537cbe0d3bc30492bf078b08bfe86edfb0ab2a79a3ee2"
},
"downloads": -1,
"filename": "wagtail_resume-2.8.0.tar.gz",
"has_sig": false,
"md5_digest": "35e6459c4a83c96be49504f196266013",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 17409,
"upload_time": "2024-04-30T11:10:39",
"upload_time_iso_8601": "2024-04-30T11:10:39.144365Z",
"url": "https://files.pythonhosted.org/packages/46/88/80e98101592735a4c03a72e93901d23faf6d3e8cebdc0c052bd42384f373/wagtail_resume-2.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 11:10:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adinhodovic",
"github_project": "wagtail-resume",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "wagtail-resume"
}
JSON
