| Name | resumy JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | Resume builder |
| upload_time | 2024-04-12 13:22:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2022 Alex Laurent Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
resume
cv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# resumy
[](https://badge.fury.io/py/resumy)
<img src="/docs/demo.png" width="300"/>
### Features
- Now supports the [jsonresume](https://jsonresume.org/schema/) format
- A default theme already supported
- Easy to create a theme or a config file
- Configs and schemas are both in yaml format
- Exports a pdf
## Install
```
pip install resumy
```
**It may not work out of the box as some external dynamic libraries are necessary depending on your platform, please take a look at the weasyprint documentation page: https://doc.courtbouillon.org/weasyprint/stable/first_steps.html**
## CI
An easy way to create your resume is to host your yaml file in a git repository and build it automatically + host it somewhere each time you push new changes. You can fork [resumy_workflow](https://github.com/alexlren/resumy_workflow) for an example on github.
## Commands
### Usage
```
resumy --help
```
### Init a config file
```
resumy init -o myconfig.yaml
```
This creates a file that you can easily edit:
```
basics:
email: anakin@skywalker.com
location:
city: Mos Eisley
countryCode: Tatooine
name: Anakin Skywalker
phone: 123-456-7890
profiles:
- network: Github
url: https://github.com/alexlren
username: alexlren
- network: Linkedin
url: https://www.linkedin.com/anakin
username: anakin
url: https://shaoner.com
education:
- area: Jedi / General
institution: Jedi Academy
startDate: '2011-01-01'
projects:
- description: a multiplatform gameboy engine
keywords:
- Rust
- React.js
name: padme
url: https://padme.cc
skills:
- keywords:
- Rust
- Python
name: Languages
work:
- highlights:
- Killed a few rebels here and there
- Tracked Jedi all around the galaxy
- Practiced the force with my master Darth Sidious
- Killed some younglings
name: Empire
position: Darth Vader
startDate: '2016-08-01'
```
And it makes it easier to support multiple languages (i.e. multiple config files)
### Build a resume
```
resumy build -o myresume.pdf myconfig.yaml
```
### Create and use your own theme
```
resumy theme -o /tmp/mytheme
```
Now you can simply edit /tmp/mytheme/theme.html and /tmp/mytheme/theme.css, and use your custom theme with `--theme` option.
```
resumy build -o myresume.pdf --theme /tmp/mytheme myconfig.yaml
```
## Development
1. Create a virtual env
```
python -m venv venv
source venv/bin/activate
```
2. Install dependencies
```
pip install -e .
```
2. Create a config file
```
cp config.example.yaml my_config.yaml
```
or
```
python src/resumy/resumy.py init
```
3. Run
```
python resumy/resumy.py build -o my_resume.pdf my_config.yaml
```
## Migrating from v0.0.2
It's now possible to transform the previous resumy format into the jsonresume standard:
```
resumy normalize my_config.yaml -s jsonresume.yaml -o my_new_config.yaml
```
You can still use the original format, it is internally transformed into the new format
```
resumy build -o myresume.pdf --schema resumy.yaml myconfig.yaml
```
The old theme is not supported anymore, but it's not that hard to migrate it yourself.
## Tests
### Linting with flake8
```
tox -e flake8
```
### Type checking with mypy
```
tox -e mypy
```
Raw data
{
"_id": null,
"home_page": null,
"name": "resumy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "resume, cv",
"author": null,
"author_email": "Alex Laurent <alex@i42.sh>",
"download_url": "https://files.pythonhosted.org/packages/02/ca/55b411dd222eafee9ad6aa6f0856d89996c735c5c07d7194c3e6591bf666/resumy-0.1.2.tar.gz",
"platform": null,
"description": "# resumy\n\n[](https://badge.fury.io/py/resumy)\n\n\n<img src=\"/docs/demo.png\" width=\"300\"/>\n\n### Features\n\n- Now supports the [jsonresume](https://jsonresume.org/schema/) format\n- A default theme already supported\n- Easy to create a theme or a config file\n- Configs and schemas are both in yaml format\n- Exports a pdf\n\n## Install\n\n```\npip install resumy\n```\n\n**It may not work out of the box as some external dynamic libraries are necessary depending on your platform, please take a look at the weasyprint documentation page: https://doc.courtbouillon.org/weasyprint/stable/first_steps.html**\n\n## CI\n\nAn easy way to create your resume is to host your yaml file in a git repository and build it automatically + host it somewhere each time you push new changes. You can fork [resumy_workflow](https://github.com/alexlren/resumy_workflow) for an example on github.\n\n## Commands\n\n### Usage\n\n```\nresumy --help\n```\n\n### Init a config file\n\n```\nresumy init -o myconfig.yaml\n```\n\nThis creates a file that you can easily edit:\n\n```\nbasics:\n email: anakin@skywalker.com\n location:\n city: Mos Eisley\n countryCode: Tatooine\n name: Anakin Skywalker\n phone: 123-456-7890\n profiles:\n - network: Github\n url: https://github.com/alexlren\n username: alexlren\n - network: Linkedin\n url: https://www.linkedin.com/anakin\n username: anakin\n url: https://shaoner.com\neducation:\n- area: Jedi / General\n institution: Jedi Academy\n startDate: '2011-01-01'\nprojects:\n- description: a multiplatform gameboy engine\n keywords:\n - Rust\n - React.js\n name: padme\n url: https://padme.cc\nskills:\n- keywords:\n - Rust\n - Python\n name: Languages\nwork:\n- highlights:\n - Killed a few rebels here and there\n - Tracked Jedi all around the galaxy\n - Practiced the force with my master Darth Sidious\n - Killed some younglings\n name: Empire\n position: Darth Vader\n startDate: '2016-08-01'\n```\n\nAnd it makes it easier to support multiple languages (i.e. multiple config files)\n\n### Build a resume\n\n```\nresumy build -o myresume.pdf myconfig.yaml\n```\n\n### Create and use your own theme\n\n```\nresumy theme -o /tmp/mytheme\n```\n\nNow you can simply edit /tmp/mytheme/theme.html and /tmp/mytheme/theme.css, and use your custom theme with `--theme` option.\n\n```\nresumy build -o myresume.pdf --theme /tmp/mytheme myconfig.yaml\n```\n\n## Development\n\n1. Create a virtual env\n\n```\npython -m venv venv\nsource venv/bin/activate\n```\n\n2. Install dependencies\n\n```\npip install -e .\n```\n\n2. Create a config file\n\n```\ncp config.example.yaml my_config.yaml\n```\n\nor\n\n```\npython src/resumy/resumy.py init\n```\n\n3. Run\n\n```\npython resumy/resumy.py build -o my_resume.pdf my_config.yaml\n```\n\n## Migrating from v0.0.2\n\nIt's now possible to transform the previous resumy format into the jsonresume standard:\n\n```\nresumy normalize my_config.yaml -s jsonresume.yaml -o my_new_config.yaml\n```\n\nYou can still use the original format, it is internally transformed into the new format\n\n```\nresumy build -o myresume.pdf --schema resumy.yaml myconfig.yaml\n```\n\nThe old theme is not supported anymore, but it's not that hard to migrate it yourself.\n\n## Tests\n\n### Linting with flake8\n\n```\ntox -e flake8\n```\n\n### Type checking with mypy\n\n```\ntox -e mypy\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Alex Laurent Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Resume builder",
"version": "0.1.2",
"project_urls": {
"homepage": "https://github.com/alexlren/resumy"
},
"split_keywords": [
"resume",
" cv"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "730d40563cf4c691eeb7553fb333d044adbb746d28a77ebdbeb403e461f6c352",
"md5": "3b7774b97dabd7202fb5f68851680aee",
"sha256": "b17ffa821d951742f365bbe94bcbb5e0bd8b9ef73238988a6ccb54a88c290c3e"
},
"downloads": -1,
"filename": "resumy-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b7774b97dabd7202fb5f68851680aee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 143575,
"upload_time": "2024-04-12T13:22:49",
"upload_time_iso_8601": "2024-04-12T13:22:49.853377Z",
"url": "https://files.pythonhosted.org/packages/73/0d/40563cf4c691eeb7553fb333d044adbb746d28a77ebdbeb403e461f6c352/resumy-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02ca55b411dd222eafee9ad6aa6f0856d89996c735c5c07d7194c3e6591bf666",
"md5": "d9f713cdfa5e6b490e8e9ba90a8c53d0",
"sha256": "ac26d4a47fa482db9620ae5d1ddb9ff038e45361c5565e105bad050abbfc4663"
},
"downloads": -1,
"filename": "resumy-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "d9f713cdfa5e6b490e8e9ba90a8c53d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 362433,
"upload_time": "2024-04-12T13:22:51",
"upload_time_iso_8601": "2024-04-12T13:22:51.818095Z",
"url": "https://files.pythonhosted.org/packages/02/ca/55b411dd222eafee9ad6aa6f0856d89996c735c5c07d7194c3e6591bf666/resumy-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 13:22:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alexlren",
"github_project": "resumy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "resumy"
}
