\n# GPT-Based Cover Letter Generator
`clgen` is a cover letter generator CLI based on GPT-4. It reduces the effort to create customized cover letters for job applications.
Setting up the application takes about two minutes, and saves you from the effort of interacting with ChatGPT manually.
# Installation
```bash
pip install clgen
```
# Usage
`clgen` requires the `OPENAI_API_KEY` environment variable to be set.
```bash
$ export OPENAI_API_KEY=sk-W...m
$ clgen --help
Usage: clgen [OPTIONS] COMMAND [ARGS]...
Cover Letter Generator CLI.
Options:
--help Show this message and exit.
Commands:
configure Configure user profile.
cv-add Add a new CV.
cv-delete Delete an existing CV.
cv-display Display an existing CV.
generate Generate a cover letter.
```
### Configure
Adds information about yourself:
```bash
$ clgen configure
Enter your full name: John Doe
Enter your street: Doe Street
Enter your street number: 5
Enter your zip: 123456
Enter your city: Berlin
Enter your country: Germany
Configuration saved.
```
Rerun to update saved information.
### Manage CVs
#### Add CV
```bash
clgen cv-add
```
This command asks for a name to save the cv / resume as and open an interactive window to paste the plain text cv. Recommended to paste everything from job experience and skills, maybe exclude your contact information.
#### Display CVs
```bash
clgen cv-display
```
Lists list of saved CVs with option to print them.
#### Delete CV
```bash
clgen cv-delete
```
Deletes a saved CV.
## Generating Cover Letters
```bash
clgen generate --model gpt-3.5-turbo-1106
```
Generate takes an additional (optional) argument model, which should correspond to a model found [here](https://platform.openai.com/docs/models). Defaults to `gpt-4-1106-preview`.
Upon running the command, an interactive window opens to copy-paste the job description into. Next you are asked to provide the company name.
The CLI will then leverage the OpenAI API to generate a friendly cover letter focussing on your skills, explaining why you are a good match for the position. The result will be printed to the terminal.
Once the result is available, you can proceed in three ways:
`Choose an action (a / accept, e / edit, r / regenerate) (a, e, r):`
### Accept
Upon accepting, you can edit the output interactively before it is automatically saved to the `~/.clgen/letters` directory as markdown file. Congrats, go to get that job!
### Edit
If you are not satisfied with the result, you can choose to pass the existent generation with an additional prompt. An example prompt which works quite good is:
```text
Rewrite the letter with a stronger focus on me being a good match for the position and less focus on my past emplyoment history.
```
### Regenerate
If you are not satisfied with the result, you can regenerate the last input with a different temperature (aka. creativeness). Default tempeature is `0.7`, where a higher value (e.g. `1.5`) would create in more creative writing, be aware about hallucinations though.
# Disclaimer
## Costs
> By using this open source project, you agree to provide your own OpenAI API key to access the OpenAI services. You acknowledge that you will be solely responsible for any costs incurred by the use of your OpenAI API key in connection with this project. The usage of the OpenAI API through this project will be billed to your account with OpenAI according to their pricing policies.
> The author(s) of this project shall not be held liable for any charges, fees, costs, or expenses that you may incur as a result of your use of your OpenAI API key with this project. It is your responsibility to secure your API key and to ensure that any use of the key complies with OpenAI's terms and conditions. You should monitor your usage to prevent unexpected charges, as the author(s) provide no warranty or guarantee regarding the cost or billing of your use of the OpenAI API.
## Data Privacy
> When using this open source project, you may input information that will be processed by the OpenAI API. Please be aware that any data you provide may be shared with OpenAI and will be subject to OpenAI's privacy policy. The author(s) of this project do not have control over, and assume no responsibility for, the data privacy practices of OpenAI or any data handling once it has been transmitted to OpenAI's systems.
> You are responsible for ensuring that any data you input into the tool complies with data protection laws applicable to you and does not infringe upon the rights of any third parties. It is your duty to review OpenAI's privacy policy to understand how your data will be used and to ensure that you consent to this usage. By using your OpenAI API key in conjunction with this project, you acknowledge and agree to OpenAI's data processing practices as outlined in their privacy policy.
Raw data
{
"_id": null,
"home_page": "https://github.com/willsamu/clgen",
"name": "clgen",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenAI,CV,cover letter,ai generator",
"author": "Samuel Will",
"author_email": "will.samuel@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/e3/67/b768f677e5ef0cf5b78c62971d3082e14af0d8dd93efd159c34c231cfb56/clgen-1.0.0.tar.gz",
"platform": null,
"description": "\\n# GPT-Based Cover Letter Generator\n\n`clgen` is a cover letter generator CLI based on GPT-4. It reduces the effort to create customized cover letters for job applications.\n\nSetting up the application takes about two minutes, and saves you from the effort of interacting with ChatGPT manually.\n\n# Installation\n\n```bash\npip install clgen\n```\n\n# Usage\n\n`clgen` requires the `OPENAI_API_KEY` environment variable to be set.\n\n```bash\n$ export OPENAI_API_KEY=sk-W...m\n$ clgen --help\n\nUsage: clgen [OPTIONS] COMMAND [ARGS]...\n\n Cover Letter Generator CLI.\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n configure Configure user profile.\n cv-add Add a new CV.\n cv-delete Delete an existing CV.\n cv-display Display an existing CV.\n generate Generate a cover letter.\n```\n\n### Configure\n\nAdds information about yourself:\n\n```bash\n$ clgen configure\nEnter your full name: John Doe\nEnter your street: Doe Street\nEnter your street number: 5\nEnter your zip: 123456\nEnter your city: Berlin\nEnter your country: Germany\nConfiguration saved.\n```\n\nRerun to update saved information.\n\n### Manage CVs\n\n#### Add CV\n\n```bash\nclgen cv-add\n```\n\nThis command asks for a name to save the cv / resume as and open an interactive window to paste the plain text cv. Recommended to paste everything from job experience and skills, maybe exclude your contact information.\n\n#### Display CVs\n\n```bash\nclgen cv-display\n```\n\nLists list of saved CVs with option to print them.\n\n#### Delete CV\n\n```bash\nclgen cv-delete\n```\n\nDeletes a saved CV.\n\n## Generating Cover Letters\n\n```bash\nclgen generate --model gpt-3.5-turbo-1106\n```\n\nGenerate takes an additional (optional) argument model, which should correspond to a model found [here](https://platform.openai.com/docs/models). Defaults to `gpt-4-1106-preview`.\n\nUpon running the command, an interactive window opens to copy-paste the job description into. Next you are asked to provide the company name.\n\nThe CLI will then leverage the OpenAI API to generate a friendly cover letter focussing on your skills, explaining why you are a good match for the position. The result will be printed to the terminal.\n\nOnce the result is available, you can proceed in three ways:\n`Choose an action (a / accept, e / edit, r / regenerate) (a, e, r):`\n\n### Accept\n\nUpon accepting, you can edit the output interactively before it is automatically saved to the `~/.clgen/letters` directory as markdown file. Congrats, go to get that job!\n\n### Edit\n\nIf you are not satisfied with the result, you can choose to pass the existent generation with an additional prompt. An example prompt which works quite good is:\n\n```text\nRewrite the letter with a stronger focus on me being a good match for the position and less focus on my past emplyoment history.\n```\n\n### Regenerate\n\nIf you are not satisfied with the result, you can regenerate the last input with a different temperature (aka. creativeness). Default tempeature is `0.7`, where a higher value (e.g. `1.5`) would create in more creative writing, be aware about hallucinations though.\n\n# Disclaimer\n\n## Costs\n\n> By using this open source project, you agree to provide your own OpenAI API key to access the OpenAI services. You acknowledge that you will be solely responsible for any costs incurred by the use of your OpenAI API key in connection with this project. The usage of the OpenAI API through this project will be billed to your account with OpenAI according to their pricing policies.\n\n> The author(s) of this project shall not be held liable for any charges, fees, costs, or expenses that you may incur as a result of your use of your OpenAI API key with this project. It is your responsibility to secure your API key and to ensure that any use of the key complies with OpenAI's terms and conditions. You should monitor your usage to prevent unexpected charges, as the author(s) provide no warranty or guarantee regarding the cost or billing of your use of the OpenAI API.\n\n## Data Privacy\n\n> When using this open source project, you may input information that will be processed by the OpenAI API. Please be aware that any data you provide may be shared with OpenAI and will be subject to OpenAI's privacy policy. The author(s) of this project do not have control over, and assume no responsibility for, the data privacy practices of OpenAI or any data handling once it has been transmitted to OpenAI's systems.\n\n> You are responsible for ensuring that any data you input into the tool complies with data protection laws applicable to you and does not infringe upon the rights of any third parties. It is your duty to review OpenAI's privacy policy to understand how your data will be used and to ensure that you consent to this usage. By using your OpenAI API key in conjunction with this project, you acknowledge and agree to OpenAI's data processing practices as outlined in their privacy policy.\n",
"bugtrack_url": null,
"license": "",
"summary": "OpenAI GPT based cover letter generator.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/willsamu/clgen"
},
"split_keywords": [
"openai",
"cv",
"cover letter",
"ai generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2edbe8208490416d2ac328cf49abba70283b821abd26481522fce641f152dd83",
"md5": "42107ee4b2e5e148d9b465146227a279",
"sha256": "2039de8acce8b769867ac80e1dfac37ca6db69b5e7b1105283dd06765ecd3fc2"
},
"downloads": -1,
"filename": "clgen-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "42107ee4b2e5e148d9b465146227a279",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6629,
"upload_time": "2023-11-14T10:35:16",
"upload_time_iso_8601": "2023-11-14T10:35:16.956607Z",
"url": "https://files.pythonhosted.org/packages/2e/db/e8208490416d2ac328cf49abba70283b821abd26481522fce641f152dd83/clgen-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e367b768f677e5ef0cf5b78c62971d3082e14af0d8dd93efd159c34c231cfb56",
"md5": "72b1941f309adb0ecb7c2cc0985193e0",
"sha256": "2f574f55f00ad72e87fb526d165dd1c74601e178251f05b7149ac21e6e23c106"
},
"downloads": -1,
"filename": "clgen-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "72b1941f309adb0ecb7c2cc0985193e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6188,
"upload_time": "2023-11-14T10:35:18",
"upload_time_iso_8601": "2023-11-14T10:35:18.612074Z",
"url": "https://files.pythonhosted.org/packages/e3/67/b768f677e5ef0cf5b78c62971d3082e14af0d8dd93efd159c34c231cfb56/clgen-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-14 10:35:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "willsamu",
"github_project": "clgen",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "clgen"
}
JSON
