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


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 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
Sébastien Besson
974d1ec593
Expand nature of rate limit changes in 1.43 ( #902 )
...
Document breaking API changes as well as new API additions
2018-09-18 15:02:19 +08:00
Wan Liuyang
8ef6990889
Publish version 1.43.2
2018-09-12 15:01:08 +08:00
Wan Liuyang
54eb59cf6e
Publish version 1.43.1
2018-09-11 13:10:13 +08:00
Wan Liuyang
6c5451d6ba
Adding actual v1.43 change log
2018-09-08 15:49:33 +08:00
Vincent Jacques
4e3d47c0e8
Publish version 1.43
2018-09-08 09:09:08 +02: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
Wan Liuyang
310d0733ee
Fix a few docs error
2018-08-20 16:07:36 +08:00
Wan Liuyang
df57bf17a8
Publish version 1.42
2018-08-19 12:27:09 +08:00
Wan Liuyang
2c97823a95
Publish version 1.41
2018-08-19 11:32:31 +08:00
Wan Liuyang
3f0caa4057
Sync copyright header
2018-08-19 10:47:41 +08:00
sfdye
d897e86aa9
Publish version 1.40
2018-06-26 09:05:38 +08:00
Sviatoslav Sydorenko
05f49a59de
Add check-in to projects using PyGithub ( #814 )
...
* Add check-in to projects using PyGithub
* Drop pip install link
2018-06-12 11:36:38 +08:00
João Pedro
a90878d0b5
Adding project name into "Projects using PyGithub" ( #815 )
2018-06-11 22:26:28 +08:00
Wan Liuyang
286272aaf1
Publish version 1.40a4
2018-05-21 10:42:33 +08:00
Wan Liuyang
2bab41326b
Add Satsuki, closes #798
2018-05-21 10:23:06 +08:00
Wan Liuyang
b0fc5da5ae
Publish version 1.40a3
2018-04-26 14:52:47 +08:00
Wan Liuyang
d9071a9eda
Publish version 1.40a2
2018-04-23 14:31:58 +08:00
Wan Liuyang
981111dbe0
Publish version 1.40a1
2018-04-17 12:15:02 +08:00
Wan Liuyang
6563ce12f5
Publish version 1.39
2018-04-10 10:21:49 +08:00
Wan Liuyang
6fd5212124
Add Gitana to projects using PyGithub
2018-04-07 17:20:24 +08:00
Morgan Goose
1497e8269a
docs: sort the Github Objects ( #735 )
...
It's difficult to follow the API docs when the order isn't alphabetical. This seems like the simplest fix, and worked well locally.
2018-03-25 14:33:30 +08:00
Wan Liuyang
ecab384885
Fix typo
2018-03-21 10:21:20 +08:00
Wan Liuyang
193aeaad2a
Publish version 1.38
2018-03-21 10:19:03 +08:00
Wan Liuyang
67091c256c
Update introduction.rst, closes #636
2018-03-19 07:38:52 +08:00
sfdye
365a0a24d3
Apply fix_headers script to update copyright info
2018-03-17 20:06:16 +08:00
sfdye
654b06f6ba
Update Sphinx conf
2018-03-13 22:51:56 +08:00
sfdye
58e1ef9ccb
Fix copyright formatting
2018-03-13 22:30:47 +08:00
sfdye
020c136a40
Update doc link in copyright text
2018-03-13 22:07:38 +08:00
sfdye
58f6e6eab5
Use a more modern sphinx theme
2018-03-11 09:21:14 +08:00
Wan Liuyang
28499d0b9e
Add gitsuggest, fixes #581
2018-03-10 14:14:34 +08:00
Wan Liuyang
c3a8acabd0
Remove contributing from readthedocs, closes #714
2018-03-09 16:25:20 +08:00
Wan Liuyang
8daae1375e
Update doc link for PyPI
2018-03-02 11:37:27 +08:00
Wan Liuyang
b2461670d3
Publish version 1.37
2018-03-01 18:09:55 +08:00
Wan Liuyang
1ca7d523fb
Make sphinx work again
2018-03-01 17:28:48 +08:00
Raihaan
98d32af494
Fix typo in Design.md ( #701 )
2018-02-14 00:31:54 +08:00
Jason White
f42bd1d2a0
Fix changelog formatting
2018-02-07 01:01:27 -08:00
Jason White
513ab1cdd8
Publish version 1.36
2018-02-07 00:57:51 -08:00
Wan Liuyang
c33a388395
Doc create instance from token ( #667 )
2017-12-07 20:01:03 -08:00
Tiago Danin
d2c72bb330
Updated references in introduction.rst
2017-08-23 11:27:53 -03:00
Jannis Gebauer
19310e77e3
new release, 1.35
2017-07-10 13:16:34 +02:00
Jannis Gebauer
b93d43df23
reformat changelog
2017-07-10 10:58:21 +02:00