meltanolabs-tap-github 1.10.0__py3-none-any.whl

meltanolabs_tap_github-1.10.0.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

meltanolabs_tap_github-1.10.0.dist-info/METADATA

@@ -0,0 +1,192 @@
+Metadata-Version: 2.3
+Name: meltanolabs-tap-github
+Version: 1.10.0
+Summary: Singer tap for GitHub, built with the Singer SDK.
+Home-page: https://github.com/MeltanoLabs/tap-github
+License: Apache-2.0
+Keywords: Meltano,Singer,Meltano SDK,Singer SDK,ELT,Github
+Author: Meltano and Meltano Community
+Author-email: hello@meltano.com
+Maintainer: Meltano and Meltano Community
+Maintainer-email: hello@meltano.com
+Requires-Python: >=3.9
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Typing :: Typed
+Requires-Dist: PyJWT (==2.10.1)
+Requires-Dist: beautifulsoup4 (>=4.12.0,<4.13.0)
+Requires-Dist: nested-lookup (>=0.2.25,<0.3.0)
+Requires-Dist: python-dateutil (>=2.9,<3.0)
+Requires-Dist: requests (>=2.32.3,<2.33.0)
+Requires-Dist: singer-sdk (>=0.43.1,<0.44.0)
+Project-URL: Issue Tracker, https://github.com/MeltanoLabs/tap-github/issues
+Project-URL: Repository, https://github.com/MeltanoLabs/tap-github
+Description-Content-Type: text/markdown
+
+# tap-github
+
+`tap-github` is a Singer tap for GitHub.
+
+Build with the [Singer SDK](https://gitlab.com/meltano/singer-sdk).
+
+## Installation
+
+```bash
+pipx install git+https://github.com/MeltanoLabs/tap-github.git
+```
+
+Or better yet, please pin to a [release version](https://github.com/MeltanoLabs/tap-github/releases) for a stable experience:
+
+```bash
+pipx install git+https://github.com/MeltanoLabs/tap-github.git@vX.Y.Z
+```
+
+A list of release versions is available at https://github.com/MeltanoLabs/tap-github/releases
+
+## Configuration
+
+### Accepted Config Options
+
+This tap accepts the following configuration options:
+
+- Required: One and only one of the following modes:
+  1. `repositories`: An array of strings specifying the GitHub repositories to be included. Each element of the array should be of the form `<org>/<repository>`, e.g. `MeltanoLabs/tap-github`.
+  2. `organizations`: An array of strings containing the github organizations to be included
+  3. `searches`: An array of search descriptor objects with the following properties:
+     - `name`: A human readable name for the search query
+     - `query`: A github search string (generally the same as would come after `?q=` in the URL)
+  4. `user_usernames`: A list of github usernames
+  5. `user_ids`: A list of github user ids [int]
+- Highly recommended:
+  - Personal access tokens (PATs) for authentication can be provided in 3 ways:
+    - `auth_token` - Takes a single token.
+    - `additional_auth_tokens` - Takes a list of tokens. Can be used together with `auth_token` or as the sole source of PATs.
+    - Any environment variables beginning with `GITHUB_TOKEN` will be assumed to be PATs. These tokens will be used in addition to `auth_token` (if provided), but will not be used if `additional_auth_tokens` is provided.
+  - GitHub App keys are another option for authentication, and can be used in combination with PATs if desired. App IDs and keys should be assembled into the format `:app_id:;;-----BEGIN RSA PRIVATE KEY-----\n_YOUR_P_KEY_\n-----END RSA PRIVATE KEY-----` where the key can be generated from the `Private keys` section on https://github.com/organizations/:organization_name/settings/apps/:app_name.  Read more about GitHub App quotas [here](https://docs.github.com/en/enterprise-server@3.3/developers/apps/building-github-apps/rate-limits-for-github-apps#server-to-server-requests). Formatted app keys can be provided in 2 ways:
+    - `auth_app_keys` - List of GitHub App keys in the prescribed format.
+    - If `auth_app_keys` is not provided but there is an environment variable with the name `GITHUB_APP_PRIVATE_KEY`, it will be assumed to be an App key in the prescribed format.
+- Optional:
+  - `user_agent`
+  - `start_date`
+  - `metrics_log_level`
+  - `stream_maps`
+  - `stream_maps_config`
+  - `stream_options`: Options which can change the behaviour of a specific stream are nested within.
+    - `milestones`: Valid options for the `milestones` stream are nested within.
+      - `state`: Determines which milestones will be extracted. One of `open` (default), `closed`, `all`.
+  - `rate_limit_buffer`: A buffer to avoid consuming all query points for the auth_token at hand. Defaults to 1000.
+  - `expiry_time_buffer`: A buffer used when determining when to refresh GitHub app tokens. Only relevant when authenticating as a GitHub app. Defaults to 10 minutes. Tokens generated by GitHub apps expire 1 hour after creation, and will be refreshed once fewer than `expiry_time_buffer` minutes remain until the anticipated expiry time.
+
+Note that modes 1-3 are `repository` modes and 4-5 are `user` modes and will not run the same set of streams.
+
+A full list of supported settings and capabilities for this tap is available by running:
+
+```bash
+tap-github --about
+```
+
+### Source Authentication and Authorization
+
+A small number of records may be pulled without an auth token. However, a Github auth token should generally be considered "required" since it gives more realistic rate limits. (See GitHub API docs for more info.)
+
+## Usage
+
+### API Limitation - Pagination
+
+The GitHub API is limited for some resources such as `/events`. For some resources, users might encounter the following error:
+
+```
+In order to keep the API fast for everyone, pagination is limited for this resource. Check the rel=last link relation in the Link response header to see how far back you can traverse.
+```
+
+To avoid this, the GitHub streams will exit early. I.e. when there are no more `next page` available. If you are fecthing `/events` at the repository level, beware of letting the tap disabled for longer than a few days or you will have gaps in your data.
+
+You can easily run `tap-github` by itself or in a pipeline using [Meltano](www.meltano.com).
+
+### Notes regarding permissions
+
+* For the `traffic_*` streams, [you will need write access to the repository](https://docs.github.com/en/rest/metrics/traffic?apiVersion=2022-11-28). You can enable extraction for these streams by [selecting them in the catalog](https://hub.meltano.com/singer/spec/#metadata).
+
+### Executing the Tap Directly
+
+```bash
+tap-github --version
+tap-github --help
+tap-github --config CONFIG --discover > ./catalog.json
+```
+
+## Contributing
+This project uses parent-child streams. Learn more about them [here.](https://gitlab.com/meltano/sdk/-/blob/main/docs/parent_streams.md)
+
+### Initialize your Development Environment
+
+```bash
+pipx install poetry
+poetry install
+```
+
+### Create and Run Tests
+
+Create tests within the `tap_github/tests` subfolder and
+then run:
+
+```bash
+poetry run pytest
+```
+
+You can also test the `tap-github` CLI interface directly using `poetry run`:
+
+```bash
+poetry run tap-github --help
+```
+
+### Testing with [Meltano](meltano.com)
+
+_**Note:** This tap will work in any Singer environment and does not require Meltano.
+Examples here are for convenience and to streamline end-to-end orchestration scenarios._
+
+Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any _"TODO"_ items listed in
+the file.
+
+Next, install Meltano (if you haven't already) and any needed plugins:
+
+```bash
+# Install meltano
+pipx install meltano
+# Initialize meltano within this directory
+cd tap-github
+meltano install
+```
+
+Now you can test and orchestrate using Meltano:
+
+```bash
+# Test invocation:
+meltano invoke tap-github --version
+# OR run a test `elt` pipeline:
+meltano elt tap-github target-jsonl
+```
+
+One-liner to recreate output directory, run elt, and write out state file:
+
+```bash
+# Update this when you want a fresh state file:
+TESTJOB=testjob1
+
+# Run everything in one line
+mkdir -p .output && meltano elt tap-github target-jsonl --job_id $TESTJOB && meltano elt tap-github target-jsonl --job_id $TESTJOB --dump=state > .output/state.json
+```
+
+### Singer SDK Dev Guide
+
+See the [dev guide](../../docs/dev_guide.md) for more instructions on how to use the Singer SDK to
+develop your own taps and targets.
+

meltanolabs_tap_github-1.10.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+tap_github/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tap_github/authenticator.py,sha256=fIi8ei5wHLysLAHK2nEldsb9e7k1YyAryD77OufWvkc,13935
+tap_github/client.py,sha256=LyrMQOoxy_jANEel4okrFd0DU1JLxm0Ndw1UHHJMhC8,17612
+tap_github/organization_streams.py,sha256=o3WUowypYWzaZ1QjOAONzjp1O6KRx6sMyoFpFDubXLQ,6463
+tap_github/repository_streams.py,sha256=D1Q2azFE9ut-tqWgJDTGr7JyW--4tenyMoYd3AXAkEE,97259
+tap_github/schema_objects.py,sha256=YBlRGY23FBrB6mGi0jnm4EUyUF4fOEkxlRrMDB3qdBI,2735
+tap_github/scraping.py,sha256=qD-bYGRp4QA5jcMWdOMgjY81YP6nmr9Yr88jI6_1Y7Y,5644
+tap_github/streams.py,sha256=iMzNvh3xhKdPCS1TXNEIr1cA_cDgn3Fq_ZKfqxYeKvM,3437
+tap_github/tap.py,sha256=F6OudlQhkdA2dH8uz403KQnYWgFZoJ-5n7LPPcVfCW0,5474
+tap_github/tests/__init__.py,sha256=_jD-0z6A-g6bkWVIXpKiv3K79FsTpDX6EmDi47VR1BQ,946
+tap_github/tests/fixtures.py,sha256=WIFlLO1gp4Jq3yyzFQXlxeDWS80pDEne-LoS9ZeDPBo,4159
+tap_github/tests/test_authenticator.py,sha256=cSABiuFgQ4rZ_ZXgXY31Ifz7x_bMKI8XAXcsLlEQPPs,25751
+tap_github/tests/test_core.py,sha256=66LWrkB9uQjSNsZeNLMBnYd6lhYGwoO82OplIBxdPMg,2238
+tap_github/tests/test_tap.py,sha256=heeqnnI_nN2GRdRRi52lbSOZzrzCDzSvQhXA9xBmloc,8186
+tap_github/user_streams.py,sha256=GQurVJJYfwh6sPynhE-F0LBmBIjwQ2_mIaZatXasbxg,13714
+tap_github/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tap_github/utils/filter_stdout.py,sha256=sUIYqsS4i2rIbgI-1za2lngVRvLQ2ndxXZqiPnDtAkA,1086
+meltanolabs_tap_github-1.10.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+meltanolabs_tap_github-1.10.0.dist-info/METADATA,sha256=wjF2eYeNv4CAMdQDVb3eFqf3fF1pnHRFLpTuSG-a5IM,8374
+meltanolabs_tap_github-1.10.0.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+meltanolabs_tap_github-1.10.0.dist-info/entry_points.txt,sha256=UoclPHogNRB1q66Qw6CD0LvAbjwaMKr6VyvsqiQcjbM,49
+meltanolabs_tap_github-1.10.0.dist-info/RECORD,,

meltanolabs_tap_github-1.10.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.0.0
+Root-Is-Purelib: true
+Tag: py3-none-any

meltanolabs_tap_github-1.10.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+tap-github=tap_github.tap:cli
+