Commit Graph
279 Commits
Author SHA1 Message Date
Liuyang Wan c677ced98d Publish version 1.56 2022-10-13 09:23:01 +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
mickeydarrenlau 99e00a2894 Fix install command example (#2043)
It should be pip install PyGithub[integrations] not pip install PyGithub['integrations']
2021-10-12 16:06:54 +11:00
Steve Kowalik d1644e3350 Adding headers in GithubException is a breaking change (#1931)
Since exporting headers in GithubException might require passing them in
a constructor for client code, shift it as a breaking change so users
watch out for it.
2021-04-26 21:34:05 +10:00
Steve Kowalik 8aebd94fda Fix commit message typo in changelog (#1930)
It appears we run codespell over all documentation, so common typos are
picked up by CI. In other news, I must remember to run lint before
creating a release.
2021-04-26 15:27:07 +10:00
Steve Kowalik 31538337fa Publish version 1.55 2021-04-26 14:43:40 +10:00
Steve Kowalik 55d98373d8 No longer show username and password examples (#1866)
With GitHub moving away from allowing authentication to the API using an
username and password, update our documentation to remove it and rely on
tokens. Perhaps we should link to how to create an API token, but that
can be addressed later.

Fixes #1851
2021-03-08 13:13:22 +11:00
Steve Kowalik 34d097ce47 Publish version 1.54.1 2020-12-24 15:11:01 +11:00
Steve Kowalik e113e37de1 Add pyupgrade to pre-commit configuration (#1783)
To help us switch to f-strings and other 3.6+ changes, add pyupgrade to
our pre-commit configuration to keep the codebase clean.
2020-12-15 14:07:33 +11:00
Steve Kowalik 951fcdf23f Publish version 1.54 2020-11-30 16:43:49 +11:00
Steve Kowalik e690adf3ff List new project in introduction (#1739)
Fixes #1677
2020-11-04 14:45:57 +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 743f5a58b0 Publish version 1.53 2020-08-18 18:15:44 +10:00
Steve Kowalik 707246519e Publish version 1.52 2020-08-03 18:45:52 +10: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
Wan Liuyang 0ca534ee1c Publish version 1.51 2020-05-03 00:58:45 +08: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
Wan Liuyang a9f174bd1d Publish version 1.50 2020-04-26 16:46:19 +08:00
Steve Kowalik 83bef0f7b2 Correct typos found with codespell (#1467)
Correct misspellings and typos located using the codespell tool. Add
codespell to pre-commit to avoid further regressions.

Fixes #1459
2020-04-16 13:25:01 +10:00
Steve Kowalik afb1259a4e Publish version 1.47 2020-03-15 13:01:20 +11:00
Steve Kowalik e5ce4912f5 Publish version 1.46 2020-02-11 12:33:45 +11: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
Steve Kowalik 7134752c36 Publish version 1.45 2019-12-29 14:48:30 +11:00
Wan Liuyang b797cac021 Fix rtd build 2019-12-10 23:19:55 +08:00
Wan Liuyang 6ceb9e9a15 Apply black to whole codebase (#1303) 2019-12-10 17:14:33 +08:00
Steve Kowalik 05b9ecb471 Publish version 1.44.1 2019-11-07 12:44:10 +11:00
sharkykh d7947d825f Update changes.rst (#1263) 2019-10-20 10:25:47 +11:00
Steve Kowalik ff716654fd Publish version 1.44 2019-10-19 18:32:53 +11:00
Michell Stuttgart 13e2c7c786 Add close all issues example (#1256) 2019-10-15 10:01:17 +08:00
Alon Chanukov 2df7269a95 Update changes.rst (#1223)
* Update changes.rst

* Update changes.rst
2019-09-18 09:46:15 +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
Steve Kowalik f93207b4ca Run flake8 in Travis (#1163)
Clean up a few errors I missed, ignore another, and configure flake8 using
a config file to ignore certain errors. The next step would be to remove
the F* ignores.
2019-08-05 15:03:10 +10:00
Wan Liuyang 1ced054592 Publish version 1.43.8 2019-07-20 23:56:37 +08: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
Wan Liuyang f716df86bb Publish version 1.43.7 2019-04-16 11:49:45 +08:00
Wan Liuyang fcc2670873 Publish version 1.43.6 2019-04-05 14:32:18 +08:00
Dirk Avery 8c1a13e294 Update link/description of project (#1043) 2019-02-13 09:34:30 +08:00
Wan Liuyang f0e0762a0d Publish version 1.43.5 2019-01-29 17:34:47 +08:00
Wan Liuyang 4a6daf6b9f Publish version 1.43.4 2018-12-21 17:29:21 +08: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
Wan Liuyang 395fd5c98b Publish version 1.43.3 2018-10-31 08:38:13 +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