diff --git a/ReadMe.md b/ReadMe.md index 6fe00c38..9108beed 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -28,6 +28,24 @@ Then play with your Github objects: History ======= +Version 0.4 (March 12th, 2012) +------------------------------ + +* The list of the not implemented APIS is shorter than the list of the implemented APIs +* APIs *not implemented*: + * GET `/gists/public` + * GET `/issues` + * GET `/repos/:user/:repo/compare/:base...:head` + * GET `/repos/:user/:repo/git/trees/:sha?recursive=1` + * POST `/repos/:user/:repo/git/trees?base_tree=` +* Gists +* Autorizations +* Keys +* Hooks +* Events +* Merge pull requests +* More refactoring, one more time + Version 0.3 (February 26th, 2012) --------------------------------- diff --git a/ReferenceOfClasses.md b/ReferenceOfClasses.md index 7fc33028..7a4adcb0 100644 --- a/ReferenceOfClasses.md +++ b/ReferenceOfClasses.md @@ -91,6 +91,7 @@ Following Orgs ---- * `get_orgs()`: list of `Organization` +* `get_organization_events( org )`: list of `Event` Repos ----- @@ -232,6 +233,11 @@ Attributes * `public` * `payload` * `created_at` +* `id` +* `commit_id` +* `url` +* `event` +* `issue` * `repo`: `Repository` * `actor`: `NamedUser` * `org`: `Organization` @@ -431,7 +437,7 @@ Comments Events ------ -* `get_events()`: list of `Event` +* `get_events()`: list of `IssueEvent` Class `IssueComment` ==================== @@ -453,6 +459,19 @@ Deletion -------- * `delete()` +Class `IssueEvent` +================== + +Attributes +---------- +* `id` +* `url` +* `created_at` +* `issue` +* `event` +* `commit_id` +* `actor`: `NamedUser` + Class `Label` ============= @@ -542,6 +561,9 @@ Events ------ * `get_events()`: list of `Event` * `get_public_events()`: list of `Event` + +Received events +--------------- * `get_received_events()`: list of `Event` * `get_public_received_events()`: list of `Event` @@ -583,6 +605,7 @@ Attributes * `html_url` * `created_at` * `type` +* `gravatar_id` * `disk_usage` * `collaborators` * `billing_email` @@ -681,6 +704,8 @@ Comments * `get_comments()`: list of `PullRequestComment` * `get_comment( id )`: `PullRequestComment` * `create_comment( body, commit_id, path, position )`: `PullRequestComment` +* `is_merged()`: bool +* `merge( [commit_message] )` Class `PullRequestComment` ========================== @@ -761,7 +786,11 @@ Events ------ * `get_events()`: list of `Event` * `get_network_events()`: list of `Event` -* `get_issues_events()`: list of `Event` + +Issues events +------------- +* `get_issues_events()`: list of `IssueEvent` +* `get_issues_event( id )`: `IssueEvent` Forks ----- @@ -876,7 +905,7 @@ Branches Pulls ----- * `get_pulls( [state] )`: list of `PullRequest` -* `get_pull( id )`: `PullRequest` +* `get_pull( number )`: `PullRequest` * `create_pull( title, body, base, head )`: `PullRequest` Teams diff --git a/RoadMap.md b/RoadMap.md index d3478eaa..732e9338 100644 --- a/RoadMap.md +++ b/RoadMap.md @@ -1,20 +1,16 @@ Planned releases ================ -(updated February 26th 2012) +(updated March 12th, 2012) -* Partial releases (versions 0.x) - * implementation of other object types: - * Authorizations and keys - * Events and hooks - * Gists - * Pull requests +* Last partial release (versions 0.5, planned around March 16th) + * full implementation of the API -* First full release (version 1.0, planned mid-March) - * full coverage of the API +* First full release (version 1.0, planned around March 19th) + * review public interface + * better use of http status (403, 404, etc. raising different exceptions) Later evolutions ================ * OAuth2 authentication -* Better use of http status (403, 404, etc. raising different exceptions) diff --git a/github/ObjectCapacities/Basic.py b/github/ObjectCapacities/Basic.py index 8fc7685a..7ced3c65 100644 --- a/github/ObjectCapacities/Basic.py +++ b/github/ObjectCapacities/Basic.py @@ -41,11 +41,14 @@ class MethodFromCallable: return self.__callable( obj, **data ) def autoDocument( self ): - doc = "* `" + self.__name + "(" + self.__argumentsChecker.documentParameters() + ")`" - if self.__returnTypePolicy.hasMeaningfulDocumentation(): - doc += ": " + self.__returnTypePolicy.documentTypeName() - doc += "\n" - return doc + if self.__name.startswith( "_" ): + return "" + else: + doc = "* `" + self.__name + "(" + self.__argumentsChecker.documentParameters() + ")`" + if self.__returnTypePolicy.hasMeaningfulDocumentation(): + doc += ": " + self.__returnTypePolicy.documentTypeName() + doc += "\n" + return doc class InternalAttribute: class AttributeDefinition: diff --git a/setup.py b/setup.py index 2858dee4..4c3abe0f 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ import textwrap setup( name = 'PyGithub', - version = '0.3', + version = '0.4', description = 'Use the full Github API v3', author = 'Vincent Jacques', author_email = 'vincent@vincent-jacques.net',