michaelwooley / nya Goto Github PK

# TODO Move github workflows to top-level dir.

Looking through this quickly, I think that it might be possible to get this functionality without delving into etag specifics:

1. Allow users to pass a custom `request.Session` object to the main `GitHub` class (which would then ultimately be passed down to [`HTTPRequestsConnectionClass`](https://github.com/PyGithub/PyGithub/blob/7e6333da1a376a5f5c60c1e3d2e6e5a37527c8e9/github/Requester.py#L141).) 
This part is pretty much identical to the approach taken by [`python-gitlab`](https://python-gitlab.readthedocs.io/en/stable/api-usage-advanced.html#using-a-custom-session) ([relevant test case](https://github.com/python-gitlab/python-gitlab/blob/43c2dda7aa8b167a451b966213e83d88d1baa1df/tests/functional/api/test_gitlab.py#L34)).
2. Use [`requests-cache`](https://requests-cache.readthedocs.io/en/stable/user_guide/headers.html) package to create a custom session that respects etags. (:lock:   Care should be taken to remove tokens in requests. [`requests-cache` has support for this.](https://requests-cache.readthedocs.io/en/stable/user_guide/security.html#removing-sensitive-info) but it does require configuration.)

IMO, this keeps a reasonable separation of concerns: this package works well with the github api while the separate caching session can be tuned separately for specific use cases.

TODO Add use cases + ideas + non-goals to top-level README.

TODO Add use cases + ideas + non-goals to top-level README.

TODO Python as namespaced package? https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#using-find-namespace-or-find-namespace-packages

TODO Python release process.