32 Commits
Author SHA1 Message Date
Enrico Minack ac36f6a9e2 Suppress requests fallback to netrc, provide github.Auth.Netrc (#2739) 2023-08-28 19:27:32 +02:00
Enrico Minack 8bf542aedd Pass Requester arguments to AppInstallationAuth.__integration (#2695) 2023-08-28 15:43:49 +02:00
YugoHinoandEnrico Minack a7bfdf2d65 Adding feature for enterprise consumed license (#2626)
Co-authored-by: Enrico Minack <github@enrico.minack.dev>
2023-08-17 21:21:20 +02:00
Enrico Minack ea45237d3b Sync GithubIntegration __init__ arguments with github.Github (#2556)
Github and GithubIntegration now both support the same (full) set of Requester arguments.
Creating a Github instance for a Github App Installation coming from GithubIntegration uses the same
Requester arguments (except for auth).
2023-06-21 09:04:19 +02:00
Enrico Minack f291a368bb Implement AppUserAuth for Github App user tokens (#2546)
Allows to refresh Github App user token. Integrates `ApplicationOAuth` into `github.Auth`.
2023-06-14 19:40:29 +02:00
Enrico Minack fc2d0e150a Add authentication classes, move auth logic there (#2528)
This adds argument `auth` and deprecates `login_or_token`, `password`, `jwt`, and `app_auth` arguments of `github.Github`.

This adds argument `auth` and deprecates `integration_id`, `private_key` of `github.GithubIntegration`.

This deprecates the `create_jwt` method of `github.GithubIntegration`, replaced by `github.Auth.AppAuth.create_jwt`.
2023-06-08 09:17:25 +02:00
Nicolas Schweitzer c2f12bdc09 Add example for Pull Request comments to documentation (#2390) 2023-05-23 15:37:23 +02:00
Eric Nieuwland 7902351d4f Add code scanning alerts (#2227) 2022-11-09 14:59:34 +08:00
Krishna Sheth 3f767649c8 Add comment on issue example (#2081)
Add an example showing how to comment on an existing issue.
2021-10-20 18:48:51 +11:00
Steve Kowalik 8880084447 Fix Branch protection status in the examples (#1729)
A long time ago when branch protection was changed, the example of
checking if a branch is protected wasn't changed in the examples.

Fixes #1724
2020-10-28 15:18:27 +11:00
Steve Kowalik 5a8bc20314 Fix two RST warnings in Webhook.rst (#1512)
The final code block in the example is not Python code, and the
underlines were incorrect, correct both.
2020-05-11 09:56:53 +10:00
Sam Pearlman 1c1cbb49c6 Fix typo in PullRequest.rst (#1494) 2020-05-01 09:55:39 +08:00
Liuyang WanandSteve Kowalik d6e77ba1e2 Drop Travis in favor of Github workflow (#1488)
* Drop Travis CI

* Update DEPLOY.md about new workflow of uploading new version to PyPI

* Upload coverage data to Codecov

Co-Authored-By: Steve Kowalik <steven@wedontsleep.org>
2020-04-27 21:54:20 +10:00
Nabil BENDAFI d5ad09ae35 doc: example of Pull Request creation (#1344)
Add an example of creating a pull request
2020-01-11 10:16:45 +10:00
Steve Kowalik fc4eff3185 Fix all but one sphinx warnings (#1346)
To hopefully correct our doc build, tidy up some of the warnings that
sphinx complains about. The one remaining one is legitimate.
2020-01-11 10:15:34 +10:00
Steve Kowalik b7894ea00c Drop Python 2 support (#1329)
With the Python 2 deadline gone, it's time to move with the times and
switch to Python 3 only.
2020-01-06 18:01:38 +11:00
Michell Stuttgart 13e2c7c786 Add close all issues example (#1256) 2019-10-15 10:01:17 +08:00
Sumithran 74cd6856de Fix bug in repository create new file example PyGithub#1210 (#1211)
* Fix bug in repository create new file example (#1211)

the previous code would throw an 'error path cannot start with a slash'
. Now fixed it by removing a slash in the example. 

Fixes: #1210
2019-09-02 12:01:15 +10:00
Kevin Rickard 8b6b4505b6 Fix bug in recursive repository contents example (#1166)
The previous code would prematurely exit when the intermediate contents list holds one thing, and that one thing has not been processed / expanded yet. Now the exit condition is when the contents list is empty, and there is nothing left to be processed.
2019-07-12 16:30:15 +10:00
Moritz Schubotz fd090eccbb Update Repository.rst (#1118)
the example confused me until I found https://github.com/PyGithub/PyGithub/issues/545
2019-06-27 22:36:40 +10:00
Justin Kufro a433a2fe3d Traffic Endpoints Support (#977)
Added support for the traffic endpoints found at https://developer.github.com/v3/repos/traffic/.

We added four functions to the Repository class (one for each of the endpoints) with corresponding unit tests. 

Fixes #926
2018-12-05 09:54:31 +08:00
Alice GIRARD 0a10d7cdf0 Mark notification as read (#932)
Wraps the parts of the notification API that allows the user to mark notifications as read.
New methods are : 
 
- Notification.mark_as_read : marks a single notification thread as read
- Repository.mark_notifications_as_read : marks all the notifications for a given repository as read
- AuthenticatedUser.mark_notifications_as_read : marks all the notifications as read

Aims to fix : https://github.com/PyGithub/PyGithub/issues/571 and simply uses the APIs described on this page : https://developer.github.com/enterprise/11.10.340/v3/activity/notifications/

A weird thing I noticed doing this is that Repository.notifications_url doesn't seem to be usable directly. I used Repository.url + "/notifications" instead.
2018-10-19 07:24:45 +08:00
Steve Kowalik 2b2ecfad4d Add some examples for Branch (#936)
In the spirit of #874, add some examples for working with Branch
objects. It doesn't add everything, but it's a start.
2018-10-18 19:41:59 +08:00
Juri Di Rocco 5e69ff00a3 Update Repository.rst (#935)
stargazers count attribute  is misspelled
2018-10-17 17:00:42 +08:00
AetherDeity ee9f098d91 Add a trailing slash to URL when updating or deleting a file (tests fixed) (#931)
* Add a trailing slash to URL when updating or deleting a file.

* Update test files to match new create/update/delete_file Repo methods

* Add trailing slash to get_contents() method

* update tests

* add missing slash in get_dir_contents

* add example usage

* remove dup slashes in tests

* clarify example comments
2018-10-17 08:21:17 +08:00
Levi Matus 9d2129c7b9 Example: Listen for New Events with PyGithub and Pyramid (#930)
## What does this change do?
Adds a small demo implementation of how one might use webhooks to listen for
new events in a given repository.

### Additions
#### doc/examples/Webhook.rst
Adds a new `.rst` file, `Webhook.rst`, which can be used for demonstrating the usage of Webhooks in PyGithub.

The example that I've added shows how to continually listen for events using Pyramid in conjunction with PyGithub.

## Motivation
This example is in the spirit of #874. [It was asked](https://github.com/PyGithub/PyGithub/issues/874#issuecomment-429075695) that someone provide an example of how to listen to events from a repository.

## How has this been tested?
I've built the docs locally and made sure the HTML is generated as expected.

## Screenshots
![webhook1](https://user-images.githubusercontent.com/16039329/46991191-40e58900-d0db-11e8-87e4-d5cf2cc18b0a.png)
![webhook2](https://user-images.githubusercontent.com/16039329/46991193-42af4c80-d0db-11e8-9b20-678f70e6baee.png)
2018-10-16 23:14:40 +08:00
Levi Matus ac8966cc8c Example to show How to get Commit Date (#927)
## What does this change do?
Adds a small example of how to get at the date a commit took place.

### Changes
#### doc/examples/Commit.rst
Adds a block of code that demonstrates how to get at a commit's date.

## Motivation
This example is in the spirit of #874.

When I began using PyGithub it was not readily apparent to me where the commit date was being abstracted to. Being unfamiliar with Git's API, it took some convincing for me to be satisfied that the `Commit.commit.author/committer.date` path would get me the commit date.

I would hope that this would save somebody a little bit of time in the future.

## How has this been tested?
I've built the docs locally and made sure the HTML is generated as expected.

## Screenshots
![2018-10-11 3](https://user-images.githubusercontent.com/16039329/46782728-add4d980-ccfd-11e8-88dd-1e48be629eb5.png)
2018-10-11 15:51:12 +08:00
Michell Stuttgart 228e5e8219 New use examples (#920)
This PR add the follow code examples

* Issue examples (get list, get specific issue, create issue)
* Milestone examples (get list, get specific milestone, create milestone)

Ref.: https://github.com/PyGithub/PyGithub/issues/874
2018-10-08 20:33:12 +08:00
Vishal Sodani 8f4f40ecbe Add examples for searching repositories (#874) (#918) 2018-10-08 11:31:25 +08:00
Vishal Sodani 19165519a9 Add examples for Repository as per #874 (#917) 2018-10-06 18:28:51 +08:00
Aaron L. Levine cc9636af3f Add Pull Request Examples (#875)
Per @sfdye request, here is an example to acquire Pull Requests.
2018-08-23 09:06:02 +08:00
Wan Liuyang 3eb695484b Set up example docs skeleton 2018-08-21 16:03:35 +08:00