{ "info": { "author": "yuecen", "author_email": "yuecendev+pypi@gmail.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "Programming Language :: Python", "Topic :: Communications :: Email", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "## github-email-explorer\n\n[![Build Status](https://travis-ci.org/yuecen/github-email-explorer.svg?branch=master)](https://travis-ci.org/yuecen/github-email-explorer)\n[![Code Climate](https://codeclimate.com/github/yuecen/github-email-explorer/badges/gpa.svg)](https://codeclimate.com/github/yuecen/github-email-explorer)\n\nFor people who want to create an email marketing plan for particular group on \nGitHub, github-email-explorer can collect addresses from a repository you want, \nand then send email content to those email addresses.\n\n### Installation\n\n```bash\npip install github-email-explorer\n```\n\nThere are two commends can be used in github-email-explorer,\n\n* ```ge-explore```: Get email address list from stargazers, forks or watchers on a repository\n* ```ge-sendgrid```: Send email by list or repository name with SendGrid API\n\nSendGrid is only one email provider at current progress.\n\n### Example of Getting Email Addresses from Stargazers, Forks or Watchers\n\n#### A. Using Command\n\n```bash\n$ ge-explore --repo yuecen/github-email-explorer --action_type star fork watch\n \nJohn (john2) ; Peter James (pjames) ;\n```\n\nYou can get user email by ```ge-explore``` with ```/```. The email \naddresses are responded in a formatted string. You can copy contact list to any \nemail service you have, then send your email with those contact address.\n\n(If you encounter the situation of limitation from GitHub server during running \nthe command, please add ```--client_id --client_secret ``` \nwith the command above. Get *Client ID* and *Client Secret* by [OAuth applications].)\n\n#### B. Using Python Script\n\n```python\nfrom github_email_explorer import github_email\n\nges = github_email.collect_email_info('yuecen', 'github-email-explorer', ['star', 'watch'])\n\nfor ge in ges:\n print ge.g_id, \"->\", ge.name, \",\", ge.email\n\n# With Authentication\n# github_api_auth = ('', '')\n# ges = github_email.collect_email_info('yuecen', 'github-email-explorer', ['star', 'watch'],\n# github_api_auth=github_api_auth)\n```\n\n```bash\n$ python examples/get_email.py\n\n0john123 -> P.J. John, john@example.org\npjames56 -> Peter James, james@example.org\n```\n\nYou can find get_email.py in *examples* folder.\n\n### How to Send a Email to GitHub Users from a Particular Repository?\n\n#### 1. Write Email Content with Template Format\n\nThe [Jinja2] is used to render email content in github-email-explorer, basic \n[expressions] make email content more flexible for personal information.\n\nHere is an example to use following syntax, the file saved to ```examples/marketing_email.txt```\n\n```\nsubject: Thanks for using {{repository}}\nfrom: test@example.com\nuser:\nrepository: yuecen/github-email-explorer\nrepository_owner: yuecen\nrepository_name: github-email-explorer\nsite: GitHub\n\n

Hi {{ user.name }} ({{ user.g_id }}),

\n

Thank you for trying {{ repository_owner }}/{{ repository_name }}!

\n\n

...

\n\n

I look forward to seeing you on GitHub :)

\n

yuecen

\n```\n\n| Metadata Field | Description |\n| --------------- |:------------- |\n| subject | email subject |\n| from | sender address|\n| from_name | sender name |\n| user | you can put an email list with a well format for parse user's ```name``` and ```g_id```. For example, ```John (john2) ; Peter James (pjames) ```. If you don't put an email list, the repository field will be used for running ge-explore to get email list. |\n| repository | full repository name on GitHub|\n| repository_owner| repository owner |\n| repository_name | repository name |\n\n```site``` is not a essential field, it will be in SendGrid custom_args field for log\n\nYou can use syntax ```{{ ... }}``` to substitute metadata field in runtime stage for personal information.\n\n#### 2. Send Email\n\nIn order to send email to many users flexibly, we combine the email list from \nresult of ge-explore and SendGrid to approach it.\n\n```\nge-sendgrid --api_key \n --template_path /examples/marketing_email.txt\n```\n\nThe following image is an real example of email format for ge-sendgrid command.\n\n> \n\n### More...\n\nIn order to understand API [rate limit] you are using, the status information \ncan be found by github-email-explorer command.\n\nWithout authentication\n\n```bash\n$ ge-explore --status\n\nResource Type Limit Remaining Reset Time\n--------------- ------- ----------- --------------------\nCore 60 60 2016-07-07T04:56:12Z\nSearch 10 10 2016-07-07T03:57:12Z\n```\n\nWith authentication\n\nYou can request more than 60 using authentication by [OAuth applications]\n\n```bash\n$ ge-explore --status --client_id --client_secret \n\n== GitHub API Status ==\nResource Type Limit Remaining Reset Time\n--------------- ------- ----------- --------------------\nCore 5000 5000 2016-07-06T07:59:47Z\nSearch 30 30 2016-07-06T07:00:47Z\n```\n\n\n[rate limit]:https://developer.github.com/v3/rate_limit/\n[OAuth applications]:https://github.com/settings/developers\n[Jinja2]:http://jinja.pocoo.org/\n[expressions]:http://jinja.pocoo.org/docs/dev/templates/#expressions", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/yuecen/github-email-explorer", "keywords": "github,email,sendgrid,marketing", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "github-email-explorer", "package_url": "https://pypi.org/project/github-email-explorer/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/github-email-explorer/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/yuecen/github-email-explorer" }, "release_url": "https://pypi.org/project/github-email-explorer/0.2.8/", "requires_dist": null, "requires_python": null, "summary": "A tool to get email addresses by action types such as starred, watching or fork on GitHub repositories; Send email content to those addresses with a template.", "version": "0.2.8" }, "last_serial": 2327234, "releases": { "0.0.7": [ { "comment_text": "", "digests": { "md5": "d68a2cef205f0b97e00174ab658ae3ee", "sha256": "d658d30a0b5249b48c3fdf379edc195963adb9322f154d8524431f60a3cf3021" }, "downloads": -1, "filename": "github-email-explorer-0.0.7.tar.gz", "has_sig": false, "md5_digest": "d68a2cef205f0b97e00174ab658ae3ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7030, "upload_time": "2016-07-13T05:23:47", "url": "https://files.pythonhosted.org/packages/41/79/0fb641f9af27de8e2e11e538321aaae96408b5cedd162ea8885c21908b40/github-email-explorer-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "c178c748a1e5887e224f36a6a172ac9b", "sha256": "4eec6f0e4b0d563f6bec893af68001f53d77caf18706f5466708a4ecd062f84b" }, "downloads": -1, "filename": "github-email-explorer-0.0.8.tar.gz", "has_sig": false, "md5_digest": "c178c748a1e5887e224f36a6a172ac9b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7134, "upload_time": "2016-07-14T08:31:53", "url": "https://files.pythonhosted.org/packages/cd/21/855a2946b56af568c5a1be28a62c4a2d15e1b2ec7884fb9d20e7f76be9f4/github-email-explorer-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "e495d2d4793ff8450ded4006b76877b5", "sha256": "f6c5b6d5ca6f9300a905c40ae0fdaaa60167458c7c26c52f23293be653fa53eb" }, "downloads": -1, "filename": "github-email-explorer-0.0.9.tar.gz", "has_sig": false, "md5_digest": "e495d2d4793ff8450ded4006b76877b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7647, "upload_time": "2016-07-15T05:25:26", "url": "https://files.pythonhosted.org/packages/b4/5c/b70c983bf5296c73a91b67c94ff0cfc20b78691802d3007302c83a0a5f49/github-email-explorer-0.0.9.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "255ecbdb4ec3d6aabcaefb307ddd598e", "sha256": "eb685d2694f9971c04dd00b1e5dfca20a41ef4af64e925de385ccd72f145d78d" }, "downloads": -1, "filename": "github-email-explorer-0.1.0.tar.gz", "has_sig": false, "md5_digest": "255ecbdb4ec3d6aabcaefb307ddd598e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7872, "upload_time": "2016-07-15T16:04:42", "url": "https://files.pythonhosted.org/packages/db/0a/4d626d4ebbfc00a3fe63ce7c3a0c384c1b98a24360bfa9829f470faf0208/github-email-explorer-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "6676bb846fdba75fd0b8479e85f67535", "sha256": "bb8e86815f4095d7c9c747f5c14285929ac148b8f52b6354becdf7868e341381" }, "downloads": -1, "filename": "github-email-explorer-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6676bb846fdba75fd0b8479e85f67535", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7942, "upload_time": "2016-07-18T07:10:53", "url": "https://files.pythonhosted.org/packages/30/70/f78f7c454922641b54d92a4cb51d37cb3d96b81fe0b6648929bba3d31f55/github-email-explorer-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "a6054af6cbccb2e52ae047ca7cee7cbb", "sha256": "25d20a216329285258c9e664343d4673baad53c32174d2e925733633f60f62fa" }, "downloads": -1, "filename": "github-email-explorer-0.1.2.tar.gz", "has_sig": false, "md5_digest": "a6054af6cbccb2e52ae047ca7cee7cbb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7980, "upload_time": "2016-07-18T07:53:01", "url": "https://files.pythonhosted.org/packages/62/db/7a81d1e1d974d036c0368de4f83ab7dc150b70111204aea3978b7de723b3/github-email-explorer-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "f25d32c937e8d0f5e021e1ba0c5cc968", "sha256": "34c2d67d02430418ad5bc79b6ca0c8c9c9ef57ae63ef5d7c00843286a7d2368e" }, "downloads": -1, "filename": "github-email-explorer-0.1.3.tar.gz", "has_sig": false, "md5_digest": "f25d32c937e8d0f5e021e1ba0c5cc968", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7989, "upload_time": "2016-07-18T09:46:19", "url": "https://files.pythonhosted.org/packages/78/70/42bd494924648cb23c4cce295ec47bf163c9b45721aff082b68cac0df3ff/github-email-explorer-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "f1432519405e77c1ace60f165fb32bba", "sha256": "beeba9fd7970b633d259a10e89f797793d80b0ae74696074d64f08614ab7a1ae" }, "downloads": -1, "filename": "github-email-explorer-0.1.4.tar.gz", "has_sig": false, "md5_digest": "f1432519405e77c1ace60f165fb32bba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8180, "upload_time": "2016-07-19T10:43:24", "url": "https://files.pythonhosted.org/packages/fb/75/64bd1388ec018ed3c89b777d8c044e8506e777b28c79f628af2cbf299c4d/github-email-explorer-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "bfebc246415d2636def1715a2557aaba", "sha256": "22d1c4ceb17bfa5557fe62a3635c03a59c44cb1d0712df06419a9e8dfb85ec75" }, "downloads": -1, "filename": "github-email-explorer-0.1.5.tar.gz", "has_sig": false, "md5_digest": "bfebc246415d2636def1715a2557aaba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8298, "upload_time": "2016-08-10T06:54:21", "url": "https://files.pythonhosted.org/packages/b6/92/74b5b99414f22779031a62629238eee764c967232040d2cb13df33d6f1cd/github-email-explorer-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "851681331d8920a5b341b0e57c707f77", "sha256": "e7379e92b1aaf43b274ec6cb8c47110cfd7ebf3c045507f8b69c9458d9d08526" }, "downloads": -1, "filename": "github-email-explorer-0.1.6.tar.gz", "has_sig": false, "md5_digest": "851681331d8920a5b341b0e57c707f77", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8835, "upload_time": "2016-08-20T14:25:42", "url": "https://files.pythonhosted.org/packages/96/53/e13cd0c344f4db5f21055fada1441834ebc456e9a6b013410d576132b5fc/github-email-explorer-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "adaa92703092f6d5a25d2ca45ec27494", "sha256": "44e4b892add187711d1be4fd7cb0ff71edd567602834c09ff492ec824f4dd91e" }, "downloads": -1, "filename": "github-email-explorer-0.1.7.tar.gz", "has_sig": false, "md5_digest": "adaa92703092f6d5a25d2ca45ec27494", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8839, "upload_time": "2016-08-20T15:11:05", "url": "https://files.pythonhosted.org/packages/6e/6b/f761eaeea93aba8a805e3a3e773de052ee476763212f6a8bb57f3470f2a2/github-email-explorer-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "75c81bc9da20fc20a55d7137ea98f27e", "sha256": "7c2154f64bc8b405e0c6a5adc454e7b48959b80e9a5a7787ce6c46e18380709f" }, "downloads": -1, "filename": "github-email-explorer-0.1.8.tar.gz", "has_sig": false, "md5_digest": "75c81bc9da20fc20a55d7137ea98f27e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8831, "upload_time": "2016-08-20T15:23:37", "url": "https://files.pythonhosted.org/packages/4b/0d/aadca358c438c9e67c03730656aeadc624d636bcd2c46802d7a2436f95bf/github-email-explorer-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "49834a142067bca090570a162836f7c8", "sha256": "e29ad5245d9abd48e05b41ab2c4dc12c6160418e933b6ed4f804366b18419a70" }, "downloads": -1, "filename": "github-email-explorer-0.1.9.tar.gz", "has_sig": false, "md5_digest": "49834a142067bca090570a162836f7c8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8876, "upload_time": "2016-08-20T17:22:51", "url": "https://files.pythonhosted.org/packages/af/94/fa3b6a5309469e8c764f2c1dfaa432bf66b6efa42e71f2482c12447262df/github-email-explorer-0.1.9.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "85e1751968e66af61d3da3de2fd98809", "sha256": "80423e5331ac6d5e2f5fca462c7f21055d18c1797681e9b435dc8c2d89da2900" }, "downloads": -1, "filename": "github-email-explorer-0.2.0.tar.gz", "has_sig": false, "md5_digest": "85e1751968e66af61d3da3de2fd98809", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8874, "upload_time": "2016-08-20T18:27:50", "url": "https://files.pythonhosted.org/packages/81/7a/7a0530760aa72a4f584d183cad5583fd8e5933af054a2fe811c8e91adf00/github-email-explorer-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "7e532a4fe657e7560edb7d05eaeaaf4b", "sha256": "e68adb00a4e0ffe7a7937982a25c84fa3521df0a07e1fbe905ca95a200e9ee34" }, "downloads": -1, "filename": "github-email-explorer-0.2.1.tar.gz", "has_sig": false, "md5_digest": "7e532a4fe657e7560edb7d05eaeaaf4b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8833, "upload_time": "2016-08-21T03:03:44", "url": "https://files.pythonhosted.org/packages/e5/85/5272855107be727db560c984f4b3a33146e1c35037684ed749371406ba6e/github-email-explorer-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "3bab6010afbb003d4c0177e90f1c3b83", "sha256": "3bfb19853c9a154b7e8c491f4b917bb5bb9941455cb85a5c1b01575a86f62ff7" }, "downloads": -1, "filename": "github-email-explorer-0.2.2.tar.gz", "has_sig": false, "md5_digest": "3bab6010afbb003d4c0177e90f1c3b83", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8829, "upload_time": "2016-08-21T03:29:43", "url": "https://files.pythonhosted.org/packages/e6/c2/620ec3e809250dd701d748f0913b74a8eae7b3c34ecbe3f7fed9d3d21f8d/github-email-explorer-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "bda9be23062e6f2131bf621b955c7ea9", "sha256": "fd6c543f9bb4a244f3e12bd63c25916871ed8753a85b01f94a94f51024143618" }, "downloads": -1, "filename": "github-email-explorer-0.2.3.tar.gz", "has_sig": false, "md5_digest": "bda9be23062e6f2131bf621b955c7ea9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8413, "upload_time": "2016-08-25T08:33:54", "url": "https://files.pythonhosted.org/packages/4d/a5/4ebdfc08dfcfe1456658368284d26be461027caa95d1a8b3d97143412e36/github-email-explorer-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "bac4db3c780ba7551b157581d0fec620", "sha256": "f9a335b44517cc596eaa9281bbb3e1fde1916984d691d5ca70591549c795edbe" }, "downloads": -1, "filename": "github-email-explorer-0.2.4.tar.gz", "has_sig": false, "md5_digest": "bac4db3c780ba7551b157581d0fec620", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8425, "upload_time": "2016-08-25T13:47:05", "url": "https://files.pythonhosted.org/packages/99/4e/f6ca1ffdd82a6f4ee9e08c7511bde74f6b0f099cc2e8da191878f44ea034/github-email-explorer-0.2.4.tar.gz" } ], "0.2.5": [ { "comment_text": "", "digests": { "md5": "9191a30883e16f663e8770d4ab5a0358", "sha256": "bcb6fcfb73ee2616e66e6d3731368ba305e03d7174cd40b82c15f16ade814ce3" }, "downloads": -1, "filename": "github-email-explorer-0.2.5.tar.gz", "has_sig": false, "md5_digest": "9191a30883e16f663e8770d4ab5a0358", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8439, "upload_time": "2016-08-25T14:06:23", "url": "https://files.pythonhosted.org/packages/5e/05/f28ad3457df06671a9b1e3a779364874e806e1864e5a4728494bfb58a7d7/github-email-explorer-0.2.5.tar.gz" } ], "0.2.6": [ { "comment_text": "", "digests": { "md5": "fe7b3e306c45857ae7a805f21eef4fa2", "sha256": "5b162c5e775d8a5dcc1920f50c8a494db2660056151e6ce029edcad3fd6f56ff" }, "downloads": -1, "filename": "github-email-explorer-0.2.6.tar.gz", "has_sig": false, "md5_digest": "fe7b3e306c45857ae7a805f21eef4fa2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8461, "upload_time": "2016-09-06T04:06:17", "url": "https://files.pythonhosted.org/packages/8b/ed/f0f92d9a8c21bb4c9021565a9c84da922a4ffebc21b96a440ccf64c744e4/github-email-explorer-0.2.6.tar.gz" } ], "0.2.7": [ { "comment_text": "", "digests": { "md5": "af5f76205bf83a4707ae51504d3d9c09", "sha256": "4a6c1acf33210da72f8ca5d8fa3349ebc46077ddafac4ead68d4275d6080e816" }, "downloads": -1, "filename": "github-email-explorer-0.2.7.tar.gz", "has_sig": false, "md5_digest": "af5f76205bf83a4707ae51504d3d9c09", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8466, "upload_time": "2016-09-06T11:13:46", "url": "https://files.pythonhosted.org/packages/2d/f2/83a24cde55f9c14cc7827b5da3c7e8943b90bc9d3652284188fde33c05f0/github-email-explorer-0.2.7.tar.gz" } ], "0.2.8": [ { "comment_text": "", "digests": { "md5": "a2d4c4b8fbad7b064da5c2c64508b2f0", "sha256": "6c46fc1ff5d632b43dacd1aa1a1b51c5388205f575685b58016391ae33752741" }, "downloads": -1, "filename": "github-email-explorer-0.2.8.tar.gz", "has_sig": false, "md5_digest": "a2d4c4b8fbad7b064da5c2c64508b2f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8495, "upload_time": "2016-09-06T12:35:57", "url": "https://files.pythonhosted.org/packages/44/cc/9c3cf18f578f89c595ebb4c49779aa159dcc62527b274ee5fa72915e1509/github-email-explorer-0.2.8.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a2d4c4b8fbad7b064da5c2c64508b2f0", "sha256": "6c46fc1ff5d632b43dacd1aa1a1b51c5388205f575685b58016391ae33752741" }, "downloads": -1, "filename": "github-email-explorer-0.2.8.tar.gz", "has_sig": false, "md5_digest": "a2d4c4b8fbad7b064da5c2c64508b2f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8495, "upload_time": "2016-09-06T12:35:57", "url": "https://files.pythonhosted.org/packages/44/cc/9c3cf18f578f89c595ebb4c49779aa159dcc62527b274ee5fa72915e1509/github-email-explorer-0.2.8.tar.gz" } ] }