rezume
Rezume is a Python library to validate and easily create a YAML based resume file that is JSON Resume compatible according to the defined schema.
Installation
Install from Pypi by running this command:
pip install rezume
Dependencies
Rezume requires Python 3.6+ and depends mainly on pydantic for data validation and pyyaml for processing YAML data.
Usage
You can use rezume as a Python package as shown below:
from rezume import RezumeError, Rezume
# sample (invalid) rezume data to validate
rezume_data = { name: 'John Doe' }
# check the validity of sample data
if Rezume.is_valid(rezume_data):
print('Validated successfully!')
else:
print('Invalid rezume')
# alternatively, if we prefer catching exceptions
try:
Rezume.validate(rezume_data)
print('Validated successfully!')
except RezumeError as ex:
print(f'Invalid rezume: {ex}')
To validate a rezume file instead:
from pathlib import Path
from rezume import RezumeError, Rezume
# path to sample file to validate
rezume_file = Path('/path/to/sample/rezume-file.yml')
# use
Rezume.is_valid(rezume_file) # returns boolean
# or
Rezume.validate(rezume_file) # throws exception if invalid
Furthermore, you can programmatically process a Rezume:
import json
from pathlib import Path
from rezume import RezumeError, Rezume
# load and modify a standard JSON resume
rezume = Rezume()
json_file = Path('/path/to/json/resume-file.json')
with json_file.open('r') as fp:
data = json.load(fp)
rezume.load_data(data) # throws exception if invalid
rezume.basics.name = 'John Doe (Verified)'
print(rezume.dump_data())
# or programmatically modify a YAML rezume file
yaml_file = Path('/path/to/yaml/rezume-file.yml')
try:
rezume = Rezume()
rezume.load(yaml_file) # throws exception if invalid
except RezumeError:
print('Unable to process rezume file')
else:
rezume.basics.label = 'Pythonista'
print(rezume.dump_data())
In addition, rezume can be used as a command line tool to create or validate a YAML-based rezume file. Here is the output of rezume --help
Usage: rezume [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or
customize the installation.
--help Show this message and exit.
Commands:
init Initializes a new rezume.yml file
serve Serves a rezume for local viewing applying available themes
test Validates correctness of a rezume.yml file
License
This project is licensed under the BSD license
Metadata
Release files for rezume 0.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rezume-0.4.2.tar.gz | 23.2 kB | Without provenance | Details for rezume-0.4.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| rezume-0.4.2-py3-none-any.whl | Python 3 | none | any | Details for rezume-0.4.2-py3-none-any.whl |
Total release size: 48.0 kB
Release files / rezume-0.4.2.tar.gz
| Download URL | rezume-0.4.2.tar.gz |
|---|---|
| Size | 23.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d484a17966e94cca94f88096d327f9917e4bd5d1c4bbc37d345e9560f310bade
|
|
BLAKE2b-256 checksum How to use checksums |
a75291320dfb7199ec6a1b0aa837b578b4c479af17f7e06cd0573198e8f66482
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.4 CPython/3.8.7 Linux/5.4.0-1039-azure
|
Release files / rezume-0.4.2-py3-none-any.whl
| Download URL | rezume-0.4.2-py3-none-any.whl |
|---|---|
| Size | 24.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
962fd885f5700389e4a8fc3690b044a595cdebf7c1efba890196b8dd2fdd30ed
|
|
BLAKE2b-256 checksum How to use checksums |
495b5951bdb8eddbccf7d37b907eca2b9e1d7006c4a5f7a8910d55a7f99c7edd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.4 CPython/3.8.7 Linux/5.4.0-1039-azure
|
Security for rezume 0.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.