| Name | email-draft-generator JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A utility to generate E-mail drafts from a list of E-mail addresses. |
| upload_time | 2024-08-30 02:54:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 fodfodfod 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 |
email
email-generator
email-template
gmail
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Email Generator
## Installation (PyPI)
```sh
pip3 install email-draft-generator
```
## Building from source
Install the `build` tool with pip and run `python3 -m build` to build the package.
## Usage (command line)
The utility provides two command-line binaries: `email-generator` and `email-list-parser`.
### email-generator
`email-generator` takes a JSON-formatted list of E-mail addresses and recipient names, formats them according to the template JSON, and uploads them to Gmail. To set up the Google API, run it once (you will need to provide a valid list of E-mail addresses for it to run), and it will guide you through setting this up. Most of the usage specifics are described in the usage help, which you can show by running `email-generator -h`.
### email-list-parser
`email-list-parser` takes a CSV formatted list or a newline-seperated list of values and turn it into a JSON file which can be piped into `email-generator`.
#### Text file format
The values should be formatted as follows
```
Company Name 1
e-mail@company1.com
Company Name 2
e-mail@company2.com
Company Name 3
e-mail@company3.com
...
```
#### CSV format
The CSV file should have the keys in the order `name,email`
### Template Format
The E-mail template is a JSON file with the following keys
| Key | Value |
|--------------------------|--------------------------------------------------|
| `subject` (formatted) | E-mail subject |
| `body` (formatted) | E-mail body |
| `attachments` (optional) | Paths to any attachments that should be included |
Formatted fields can include the following variables
| Variable | Data |
|-----------|----------------|
| `{name}` | Company name |
| `{email}` | Company E-mail |
## Installation (scripts)
Download the latest release as a `tar.gz` file.
### Setup
#### Build program
Run `setup.sh` (can be run by simply double-clicking on the file).
#### Set up the template
Update the email template in `data/template.json` according to the [template format](#template-format).
#### Google API
Run the program once, and it will guide you through setting up the Google API.
## Usage (scripts)
### Prepare data
Copy and paste the table into `data/email-list.txt`.
### Run the program
Run `run.sh` (can be run by double-clicking as well)
The first time it is run, you will need to authenticate with the account that you want to upload the drafts to. A browser window should be opened automatically to do this in (if it is not, copy and paste the URL from the terminal window into your browser). The authentication flow may not work in Firefox or other Gecko-based browsers, so try Chrome, Safari, or another Chromium- or Webkit-based browser if it doesn't work for you.
## Usage (GUI)
The utility provides two GUI binaries: `email-generator-gui` and `email-template-editor-gui`. These take no command line arguments.
Raw data
{
"_id": null,
"home_page": null,
"name": "email-draft-generator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Max Nargang <CoffeeCoder1@outlook.com>",
"keywords": "email, email-generator, email-template, gmail",
"author": null,
"author_email": "Brandon Clague <94200657+fodfodfod@users.noreply.github.com>, Max Nargang <CoffeeCoder1@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/0d/4a/2a1223bbe4caf4218e15d06d9618833b4dd436f97230e72b4f7387232fc6/email_draft_generator-0.1.2.tar.gz",
"platform": null,
"description": "# Email Generator\n\n## Installation (PyPI)\n```sh\npip3 install email-draft-generator\n```\n\n## Building from source\nInstall the `build` tool with pip and run `python3 -m build` to build the package.\n\n## Usage (command line)\nThe utility provides two command-line binaries: `email-generator` and `email-list-parser`.\n\n### email-generator\n`email-generator` takes a JSON-formatted list of E-mail addresses and recipient names, formats them according to the template JSON, and uploads them to Gmail. To set up the Google API, run it once (you will need to provide a valid list of E-mail addresses for it to run), and it will guide you through setting this up. Most of the usage specifics are described in the usage help, which you can show by running `email-generator -h`.\n\n### email-list-parser\n`email-list-parser` takes a CSV formatted list or a newline-seperated list of values and turn it into a JSON file which can be piped into `email-generator`.\n\n#### Text file format\nThe values should be formatted as follows\n```\nCompany Name 1\ne-mail@company1.com\nCompany Name 2\ne-mail@company2.com\nCompany Name 3\ne-mail@company3.com\n...\n```\n\n#### CSV format\nThe CSV file should have the keys in the order `name,email`\n\n### Template Format\nThe E-mail template is a JSON file with the following keys\n| Key | Value |\n|--------------------------|--------------------------------------------------|\n| `subject` (formatted) | E-mail subject |\n| `body` (formatted) | E-mail body |\n| `attachments` (optional) | Paths to any attachments that should be included |\n\nFormatted fields can include the following variables\n| Variable | Data |\n|-----------|----------------|\n| `{name}` | Company name |\n| `{email}` | Company E-mail |\n\n## Installation (scripts)\nDownload the latest release as a `tar.gz` file.\n\n### Setup\n#### Build program\nRun `setup.sh` (can be run by simply double-clicking on the file).\n\n#### Set up the template\nUpdate the email template in `data/template.json` according to the [template format](#template-format).\n\n#### Google API\nRun the program once, and it will guide you through setting up the Google API.\n\n## Usage (scripts)\n### Prepare data\nCopy and paste the table into `data/email-list.txt`.\n### Run the program\nRun `run.sh` (can be run by double-clicking as well)\nThe first time it is run, you will need to authenticate with the account that you want to upload the drafts to. A browser window should be opened automatically to do this in (if it is not, copy and paste the URL from the terminal window into your browser). The authentication flow may not work in Firefox or other Gecko-based browsers, so try Chrome, Safari, or another Chromium- or Webkit-based browser if it doesn't work for you.\n\n## Usage (GUI)\nThe utility provides two GUI binaries: `email-generator-gui` and `email-template-editor-gui`. These take no command line arguments.",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 fodfodfod 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": "A utility to generate E-mail drafts from a list of E-mail addresses.",
"version": "0.1.2",
"project_urls": {
"Bug Reports": "https://github.com/CoffeeCoder1/Email-Generator/issues",
"Homepage": "https://github.com/CoffeeCoder1/Email-Generator",
"Source": "https://github.com/CoffeeCoder1/Email-Generator"
},
"split_keywords": [
"email",
" email-generator",
" email-template",
" gmail"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e3dd2d50005ac0373f901341b13522fda389c5799786e6d945671f3aab58e03",
"md5": "c581c7f31c8009e0eaa3dbf97c6bc3ab",
"sha256": "a2b707447ef07c41390aca8420afc94b62e9b3e1174ef259099ec3b9d6ddcaa5"
},
"downloads": -1,
"filename": "email_draft_generator-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c581c7f31c8009e0eaa3dbf97c6bc3ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19744,
"upload_time": "2024-08-30T02:54:52",
"upload_time_iso_8601": "2024-08-30T02:54:52.773094Z",
"url": "https://files.pythonhosted.org/packages/9e/3d/d2d50005ac0373f901341b13522fda389c5799786e6d945671f3aab58e03/email_draft_generator-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d4a2a1223bbe4caf4218e15d06d9618833b4dd436f97230e72b4f7387232fc6",
"md5": "018f64c4aae602b418204e9af30bb352",
"sha256": "2df08b89c93a656b8982714428de1f42f9a38fa1876458fed97f880303641594"
},
"downloads": -1,
"filename": "email_draft_generator-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "018f64c4aae602b418204e9af30bb352",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 174911,
"upload_time": "2024-08-30T02:54:54",
"upload_time_iso_8601": "2024-08-30T02:54:54.399982Z",
"url": "https://files.pythonhosted.org/packages/0d/4a/2a1223bbe4caf4218e15d06d9618833b4dd436f97230e72b4f7387232fc6/email_draft_generator-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-30 02:54:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CoffeeCoder1",
"github_project": "Email-Generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "email-draft-generator"
}
