From d5a26bd35820b1cb3de991fd45460345b9d3f492 Mon Sep 17 00:00:00 2001 From: David Medina Date: Wed, 29 Feb 2012 01:22:16 +0100 Subject: Init documentation +core +services.user ~services.repos --- .gitignore | 1 + docs/Makefile | 153 ++++++++++++++++++++ docs/conf.py | 245 +++++++++++++++++++++++++++++++++ docs/github.rst | 7 + docs/index.rst | 44 ++++++ docs/installation.rst | 29 ++++ docs/repos.rst | 84 +++++++++++ docs/resources.rst | 0 docs/result.rst | 37 +++++ docs/services.rst | 48 +++++++ docs/users.rst | 60 ++++++++ pygithub3/core/client.py | 6 - pygithub3/core/result.py | 10 +- pygithub3/github.py | 15 +- pygithub3/services/base.py | 55 ++++++++ pygithub3/services/repos.py | 5 +- pygithub3/services/users.py | 169 +++++++++++++++++++++++ pygithub3/tests/services/test_repos.py | 4 +- 18 files changed, 959 insertions(+), 13 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/github.rst create mode 100644 docs/index.rst create mode 100644 docs/installation.rst create mode 100644 docs/repos.rst create mode 100644 docs/resources.rst create mode 100644 docs/result.rst create mode 100644 docs/services.rst create mode 100644 docs/users.rst diff --git a/.gitignore b/.gitignore index 0abbe71..228a223 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ *.DS_STORE *.rope* MANIFEST +docs/_build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..5e804dc --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pygithub3.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pygithub3.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/pygithub3" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pygithub3" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..d3d00a6 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,245 @@ +# -*- coding: utf-8 -*- +# +# pygithub3 documentation build configuration file, created by +# sphinx-quickstart on Sun Feb 26 22:08:00 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.append(os.path.abspath('../')) +#sys.path.append(os.path.abspath('_themes')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'pygithub3' +copyright = u'2012, David Medina' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.2' +# The full version, including alpha/beta/rc tags. +release = '0.2' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' +highlight_language = 'python' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'sphinxdoc' +#html_theme = 'werkzeug' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = ['_themes'] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'pygithub3doc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'pygithub3.tex', u'pygithub3 Documentation', + u'David Medina', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'pygithub3', u'pygithub3 Documentation', + [u'David Medina'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'pygithub3', u'pygithub3 Documentation', + u'David Medina', 'pygithub3', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff --git a/docs/github.rst b/docs/github.rst new file mode 100644 index 0000000..b54cef2 --- /dev/null +++ b/docs/github.rst @@ -0,0 +1,7 @@ +Github +======== + +This is the main entrance of **pygithub3** + +.. autoclass:: pygithub3.github.Github + :members: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..24561ca --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,44 @@ +Documentation Overview +======================= + +**pygithub3** is a Github APIv3 python wrapper. + +You can consume the API with several :doc:`services` (users, repos...) like +you see in `Github API v3 documentation`_. + +When you do an API request, **pygithub3** map the result into :doc:`resources` +which can do its own related requests in future releases. + +Fast sample +----------- +:: + + from pygithub3 import Github + + gh = Github(login='octocat', password='password') + + octocat = gh.users.get() # Auth required + copitux = gh.users.get('copitux') + # copitux = + + octocat_followers = gh.users.followers.list().all() + copitux_followers = gh.users.followers.list('copitux').all() + # copitux_followers = [, , ...] + + +Others +------- + +You must apologize my English level. I'm trying to do my best + + +.. toctree:: + :maxdepth: 3 + + installation + github + services + resources + result + +.. _Github API v3 documentation: http://developer.github.com diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..8ed6c10 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,29 @@ +Installation +============= +:: + + pip install pygithub3 + + or + + easy_install pygithub3 + + +Dependencies +--------------- + +Required +......... + +This library only depends on `request library`_ module. + +If you install ``pygithub3`` with ``pip`` all is done. The best option + +Optional +......... + +If you want to run the test suite, you must install `nose`_ and `mock`_ + +.. _request library: http://docs.python-requests.org/en/v0.10.6/index.html +.. _nose: http://readthedocs.org/docs/nose/en/latest +.. _mock: http://pypi.python.org/pypi/mock diff --git a/docs/repos.rst b/docs/repos.rst new file mode 100644 index 0000000..73aadb2 --- /dev/null +++ b/docs/repos.rst @@ -0,0 +1,84 @@ +.. _Repos service: + +Repos's services +=================== + +**Fast sample**:: + + from pygithub3 import Github + + auth = dict(login='octocat', password='pass') + gh = Github(**auth) + + # Get copitux user + gh.users.get('copitux') + + # Get copitux's followers + gh.users.followers.list('copitux') + + # Get octocat's emails + gh.users.emails.list() + +Repo +------- + +.. autoclass:: pygithub3.services.repos.Repo + :members: + + .. attribute:: collaborators + + :ref:`Collaborators service` + + .. attribute:: commits + + :ref:`Commits service` + + .. attribute:: downloads + + :ref:`Downloads service` + + .. attribute:: forks + + :ref:`Forks service` + + .. attribute:: keys + + :ref:`RepoKeys service` + + .. attribute:: watchers + + :ref:`Watchers service` + +.. _Collaborators service: + +Collaborators +-------------- + + +.. _Commits service: + +Commits +---------- + +.. _Downloads service: + +Downloads +------------ + + +.. _Forks service: + +Forks +--------- + + +.. _RepoKeys service: + +Keys +---------- + + +.. _Watchers service: + +Watchers +--------- diff --git a/docs/resources.rst b/docs/resources.rst new file mode 100644 index 0000000..e69de29 diff --git a/docs/result.rst b/docs/result.rst new file mode 100644 index 0000000..2162745 --- /dev/null +++ b/docs/result.rst @@ -0,0 +1,37 @@ + +Result +======= + +Some requests returns multiple :doc:`resources`, for that reason the +``Github API`` paginate it and **pygithub3** too + +.. autoclass:: pygithub3.core.result.Result + +You have several ways to consume it + +1. Iterating over the result:: + + result = some_request() + for page in result: + for resource in page: + print resource + +2. With a generator:: + + result = some_request() + for resource in result.iterator(): + print resource + +3. As a list:: + + result = some_request() + print result.all() + +4. Also you can request some page manually + +.. autoattribute:: pygithub3.core.result.Result.pages +.. automethod:: pygithub3.core.result.Result.get_page + +Each ``Page`` is an iterator and contains resources + + diff --git a/docs/services.rst b/docs/services.rst new file mode 100644 index 0000000..ddd8c89 --- /dev/null +++ b/docs/services.rst @@ -0,0 +1,48 @@ +Services +========== + +:doc:`github` class is a glue to all of them and the recommended option to +start + +Overview +.......... + +You can access to the API requests through the different services. + +If you take a look at +`github API v3 documentation `_, you'll see a +few sections in the sidebar. + +**pygithub3** has one service per each section of request-related + +For example: :: + + repos => services.repos.repo + collaborators => services.repos.collaborators + commits => services.repos.commits + .... + +Each service has the functions to throw the API requests and is isolated +from the rest. + +Config each service +..................................... + +Each service can be configurated with some variables (behind the scenes, each +service has her client which is configurated with this variables). + +.. note:: + + Also you can configure :doc:`github` as a service + +.. autoclass:: pygithub3.services.base.Service + :members: + +List of services +.................. + +.. toctree:: + :maxdepth: 2 + + users + repos diff --git a/docs/users.rst b/docs/users.rst new file mode 100644 index 0000000..5bd2e97 --- /dev/null +++ b/docs/users.rst @@ -0,0 +1,60 @@ +.. _User service: + +User's services +=============== + +**Fast sample**:: + + from pygithub3 import Github + + auth = dict(login='octocat', password='pass') + gh = Github(**auth) + + # Get copitux user + gh.users.get('copitux') + + # Get copitux's followers + gh.users.followers.list('copitux') + + # Get octocat's emails + gh.users.emails.list() + +User +-------- + +.. autoclass:: pygithub3.services.users.User + :members: + + .. attribute:: emails + + :ref:`Emails service` + .. attribute:: keys + + :ref:`Keys service` + .. attribute:: followers + + :ref:`Followers service` + +.. _Emails service: + +Emails +-------- + +.. autoclass:: pygithub3.services.users.Emails + :members: + +.. _Keys service: + +Keys +------ + +.. autoclass:: pygithub3.services.users.Keys + :members: + +.. _Followers service: + +Followers +----------- + +.. autoclass:: pygithub3.services.users.Followers + :members: diff --git a/pygithub3/core/client.py b/pygithub3/core/client.py index a9e9ad4..ce6cf7c 100644 --- a/pygithub3/core/client.py +++ b/pygithub3/core/client.py @@ -15,12 +15,6 @@ class Client(object): """ Client to send configurated requests""" def __init__(self, **kwargs): - """ - It can be configurated - - :login, :password, :user, :repo, :token, :per_page, :base_url, :verbose - """ - self.requester = requests.session() self.config = { 'per_page': 100, diff --git a/pygithub3/core/result.py b/pygithub3/core/result.py index 226d6ab..9e69e7d 100644 --- a/pygithub3/core/result.py +++ b/pygithub3/core/result.py @@ -135,10 +135,11 @@ class Page(object): class Result(object): - """ """ + """ + Result is a very lazy paginator. It only do a real request when is needed + """ def __init__(self, client, request, **kwargs): - """ """ self.getter = Method(client.get, request, **kwargs) self.page = Page(self.getter) @@ -158,9 +159,14 @@ class Result(object): @property def pages(self): + """ Total number of pages in request """ return self.getter.last def get_page(self, page): + """ Get ``Page`` of resources + + :param int page: Page number + """ if page in xrange(1, self.pages + 1): return Page(self.getter, page) return None diff --git a/pygithub3/github.py b/pygithub3/github.py index 4941ffd..d05f069 100644 --- a/pygithub3/github.py +++ b/pygithub3/github.py @@ -6,7 +6,14 @@ from pygithub3.services.repos import Repo class Github(object): - """ Main entrance """ + """ + You can preconfigure all services globally with a ``config`` dict. See + :attr:`~pygithub3.services.base.Service` + + Example:: + + gh = Github(user='kennethreitz', token='ABC...', repo='requests') + """ def __init__(self, **config): self._users = User(**config) @@ -14,8 +21,14 @@ class Github(object): @property def users(self): + """ + :ref:`User service ` + """ return self._users @property def repos(self): + """ + :ref:`Repos service ` + """ return self._repos diff --git a/pygithub3/services/base.py b/pygithub3/services/base.py index 21b22eb..fced575 100644 --- a/pygithub3/services/base.py +++ b/pygithub3/services/base.py @@ -8,6 +8,34 @@ from pygithub3.core.errors import NotFound class Service(object): + """ + You can configure each service with this keyword variables: + + :param str login: Username to authenticate + :param str password: Username to authenticate + :param str user: Default username in requests + :param str repo: Default repository in requests + :param str token: Token to OAuth + :param int per_page: Items in each page of multiple returns + :param str base_url: To support another github-related API (untested) + :param stream verbose: Stream to write debug logs + + You can configure the **authentication** with BasicAuthentication (login + and password) and with `OAuth `_ ( + token). + If you include ``login``, ``password`` and ``token`` in config; Oauth has + precedence + + Some API requests need ``user`` and/or ``repo`` arguments (e.g repos + service). + You can configure the default value here to avoid repeating + + Some API requests return multiple resources with pagination. You can + configure how many items has each page. + + You can configure ``verbose`` logging like `requests library `_ + """ def __init__(self, **config): self._client = Client(**config) @@ -17,18 +45,35 @@ class Service(object): return self._client.user def set_user(self, user): + """ Set user + + :param str user: Default username in requests + """ self._client.user = user def get_repo(self): return self._client.repo def set_repo(self, repo): + """ Set repository + + :param str repo: Default repository in requests + """ self._client.repo = repo def set_credentials(self, login, password): + """ Set Basic Authentication + + :param str login: Username to authenticate + :param str password: Username to authenticate + """ self._client.set_credentials(login, password) def set_token(self, token): + """ Set OAuth token + + :param str token: Token to OAuth + """ self._client.set_token(token) def make_request(self, request, **kwargs): @@ -90,6 +135,16 @@ class Service(object): class MimeTypeMixin(object): + """ + Mimetype support to Services that inherit this Mixin + + Adds 4 public functions to service: + + 1. set_raw_mimetype + 2. set_text_mimetype + 3. set_html_mimetype + 4. set_full_mimetype + """ VERSION = 'beta' diff --git a/pygithub3/services/repos.py b/pygithub3/services/repos.py index b20d317..3643633 100644 --- a/pygithub3/services/repos.py +++ b/pygithub3/services/repos.py @@ -148,7 +148,7 @@ class Commits(Service, MimeTypeMixin): self._delete(request) -class Collaborator(Service): +class Collaborators(Service): def list(self, user=None, repo=None): request = self.make_request('repos.collaborators.list', @@ -172,9 +172,10 @@ class Collaborator(Service): class Repo(Service): + """ Consume `Repos API `_ """ def __init__(self, **config): - self.collaborators = Collaborator(**config) + self.collaborators = Collaborators(**config) self.commits = Commits(**config) self.downloads = Downloads(**config) self.forks = Forks(**config) diff --git a/pygithub3/services/users.py b/pygithub3/services/users.py index 2bf4302..8c436e6 100644 --- a/pygithub3/services/users.py +++ b/pygithub3/services/users.py @@ -5,71 +5,216 @@ from .base import Service class Keys(Service): + """ Consume `Keys API `_ + + .. warning:: + + You must be authenticated for all requests + """ def list(self): + """ Get public keys + + It returns a :doc:`result` + """ request = self.make_request('users.keys.list') return self._get_result(request) def get(self, key_id): + """ Get a public key + + :param int key_id: Key id + + :: + + key_service.get(42) + """ request = self.make_request('users.keys.get', key_id=key_id) return self._get(request) def add(self, data): + """ Add a public key + + :param dict data: Key (title and key attributes required) + + :: + + key_service.add(dict(title='host', key='ssh-rsa AAA...')) + """ request = self.make_request('users.keys.add', body=data) return self._post(request) def update(self, key_id, data): + """ Update a public key + + :param int key_id: Key id + :param dict data: Key (title and key attributes required) + + :: + + key_service.update(42, dict(title='host', key='ssh-rsa AAA...')) + """ request = self.make_request('users.keys.update', key_id=key_id, body=data) return self._patch(request) def delete(self, key_id): + """ Delete a public key + + :param int key_id: Key id + + :: + + key_service.delete(42) + """ request = self.make_request('users.keys.delete', key_id=key_id) self._delete(request) class Followers(Service): + """ Consume `Followers API + `_ + """ def list(self, user=None): + """ Get user's followers + + :param str user: Username + + It returns a :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's followers + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + followers_service.list() + followers_service.list('octocat') + """ request = self.make_request('users.followers.list', user=user) return self._get_result(request) def list_following(self, user=None): + """ Get who a user is following + + :param str user: Username + + It returns a :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's followings + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + followers_service.list_following() + followers_service.list_following('octocat') + """ request = self.make_request('users.followers.listfollowing', user=user) return self._get_result(request) def is_following(self, user): + """ Check if you are following a user + + :param str user: Username + + :: + + followers_service.is_following('octocat') + """ request = self.make_request('users.followers.isfollowing', user=user) return self._bool(request) def follow(self, user): + """ Follow a user + + :param str user: Username + + .. warning:: + + You must be authenticated + + :: + + followers_service.follow('octocat') + """ request = self.make_request('users.followers.follow', user=user) self._put(request) def unfollow(self, user): + """ Unfollow a user + + :param str user: Username + + .. warning:: + + You must be authenticated + + :: + + followers_service.unfollow('octocat') + """ request = self.make_request('users.followers.unfollow', user=user) self._delete(request) class Emails(Service): + """ Consume `Emails API `_ + + .. warning:: + + You must be authenticated for all requests + """ def list(self): + """ Get user's emails + + It returns a :doc:`result` + """ request = self.make_request('users.emails.list') return self._get_result(request) def add(self, *emails): + """ Add emails + + :param list emails: Emails to add + + .. note:: + + It reject non-valid emails + + :: + + email_service.add('test1@xample.com', 'test2@xample.com') + """ request = self.make_request('users.emails.add', body=emails) return self._post(request) def delete(self, *emails): + """ Delete emails + + :param list emails: List of emails + + :: + + email_service.delete('test1@xample.com', 'test2@xample.com') + """ request = self.make_request('users.emails.delete', body=emails) self._delete(request) class User(Service): + """ Consume `Users API `_ """ def __init__(self, **config): self.keys = Keys(**config) @@ -78,9 +223,33 @@ class User(Service): super(User, self).__init__(**config) def get(self, user=None): + """ Get a single user + + :param str user: Username + + If you call it without user and you are authenticated, get the + authenticated user. + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + user_service.get('copitux') + user_service.get() + """ request = self.make_request('users.get', user=user) return self._get(request) def update(self, data): + """ Update the authenticated user + + :param dict data: Input to update + + :: + + user_service.update(dict(name='new_name', bio='new_bio')) + """ request = self.make_request('users.update', body=data) return self._patch(request) diff --git a/pygithub3/tests/services/test_repos.py b/pygithub3/tests/services/test_repos.py index 6f4ed71..e11bef7 100644 --- a/pygithub3/tests/services/test_repos.py +++ b/pygithub3/tests/services/test_repos.py @@ -6,7 +6,7 @@ from unittest import TestCase import requests from mock import patch, Mock -from pygithub3.services.repos import (Repo, Collaborator, Commits, Downloads, +from pygithub3.services.repos import (Repo, Collaborators, Commits, Downloads, Forks, Keys, Watchers) from pygithub3.resources.base import json from pygithub3.tests.utils.base import (mock_response, mock_response_result, @@ -146,7 +146,7 @@ class TestRepoService(TestCase): class TestCollaboratorsService(TestCase): def setUp(self): - self.cs = Collaborator() + self.cs = Collaborators() self.cs.set_user('octocat') self.cs.set_repo('oc_repo') -- cgit v1.2.3-59-g8ed1b From 372e78ea456e23e00729ff9b5cb79b866da4bec3 Mon Sep 17 00:00:00 2001 From: David Medina Date: Wed, 29 Feb 2012 22:24:57 +0100 Subject: Services.repos.Repo doc And typos --- docs/conf.py | 1 - docs/repos.rst | 45 +++++++++++++--- docs/services.rst | 6 ++- pygithub3/services/base.py | 4 +- pygithub3/services/repos.py | 126 ++++++++++++++++++++++++++++++++++++++++++++ pygithub3/services/users.py | 32 ++--------- 6 files changed, 174 insertions(+), 40 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index d3d00a6..7b87720 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,6 @@ highlight_language = 'python' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinxdoc' #html_theme = 'werkzeug' # Theme options are theme-specific and customize the look and feel of a theme diff --git a/docs/repos.rst b/docs/repos.rst index 73aadb2..f6dbead 100644 --- a/docs/repos.rst +++ b/docs/repos.rst @@ -7,17 +7,44 @@ Repos's services from pygithub3 import Github - auth = dict(login='octocat', password='pass') - gh = Github(**auth) + gh = Github() - # Get copitux user - gh.users.get('copitux') + django_compressor = gh.repos.get(user='jezdez', repo='django_compressor') + requests_collaborators = gh.repos.collaborators(user='kennethreitz', + repo='requests') - # Get copitux's followers - gh.users.followers.list('copitux') +.. _config precedence: - # Get octocat's emails - gh.users.emails.list() +Config precedence +------------------ + +Some request always need ``user`` and ``repo`` parameters, both, to identify +a `repository`. Because there are a lot of requests which need that parameters, +you can :ref:`config each service` with ``user`` and ``repo`` globally. + +So several requests follow a simple precedence ``user_in_arg > user_in_config`` + +You can see it better with an example: :: + + from pygithub3 import Github + + gh = Github(user='octocat', repo='oct_repo') + oct_repo = gh.repos.get() + another_repo_from_octocat = gh.repos.get(repo='another_repo') + + django_compressor = gh.repos.get(user='jezdez', repo='django_compressor') + +.. note:: + + Remember that each service is isolated from the rest :: + + # continue example... + gh.repos.commits.set_user('copitux') + oct_repo = gh.repos.get() + oct_repo_collaborators = gh.repos.collaborators.list().all() + + # Fail because copitux/oct_repo doesn't exist + gh.repos.commits.list_comments() Repo ------- @@ -82,3 +109,5 @@ Keys Watchers --------- + +.. _github repo doc: http://developer.github.com/v3/repos diff --git a/docs/services.rst b/docs/services.rst index ddd8c89..8611455 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -22,8 +22,10 @@ For example: :: commits => services.repos.commits .... -Each service has the functions to throw the API requests and is isolated -from the rest. +Each service has the functions to throw the API requests and **is isolated +from the rest**. + +.. _config each service: Config each service ..................................... diff --git a/pygithub3/services/base.py b/pygithub3/services/base.py index fced575..d50ceb7 100644 --- a/pygithub3/services/base.py +++ b/pygithub3/services/base.py @@ -26,8 +26,8 @@ class Service(object): If you include ``login``, ``password`` and ``token`` in config; Oauth has precedence - Some API requests need ``user`` and/or ``repo`` arguments (e.g repos - service). + Some API requests need ``user`` and/or ``repo`` arguments (e.g + :ref:`repos service `). You can configure the default value here to avoid repeating Some API requests return multiple resources with pagination. You can diff --git a/pygithub3/services/repos.py b/pygithub3/services/repos.py index 3643633..b4cf43c 100644 --- a/pygithub3/services/repos.py +++ b/pygithub3/services/repos.py @@ -184,22 +184,96 @@ class Repo(Service): super(Repo, self).__init__(**config) def list(self, user=None, type='all'): + """ Get user's repositories + + :param str user: Username + :param str type: Filter by type (optional). See `github repo doc`_ + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's repositories + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + repo_service.list('copitux', type='owner') + repo_service.list(type='private') + """ request = self.make_request('repos.list', user=user) return self._get_result(request, type=type) def list_by_org(self, org, type='all'): + """ Get organization's repositories + + :param str org: Organization name + :param str type: Filter by type (optional). See `github repo doc`_ + :returns: A :doc:`result` + + :: + + repo_service.list_by_org('myorganization', type='member') + """ request = self.make_request('repos.list_by_org', org=org) return self._get_result(request, type=type) def create(self, data, in_org=None): + """ Create a new repository + + :param dict data: Input. See `github repo doc`_ + :param str in_org: Organization where create the repository (optional) + + .. warning:: + + You must be authenticated + + If you use ``in_org`` arg, the authenticated user must be a member + of + + :: + + repo_service.create(dict(name='new_repo', description='desc')) + repo_service.create(dict(name='new_repo_in_org', team_id=2300), + in_org='myorganization') + """ request = self.make_request('repos.create', org=in_org, body=data) return self._post(request) def get(self, user=None, repo=None): + """ Get a single repo + + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.get', user=user, repo=repo) return self._get(request) def update(self, data, user=None, repo=None): + """ Update a single repository + + :param dict data: Input. See `github repo doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + .. warning:: + + You must be authenticated + + :: + + repo_service.update(dict(has_issues=True), user='octocat', + repo='oct_repo') + """ request = self.make_request('repos.update', body=data, user=user, repo=repo) return self._patch(request) @@ -210,25 +284,77 @@ class Repo(Service): return self._get_result(request, **kwargs) def list_contributors(self, user=None, repo=None): + """ Get repository's contributors + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ return self.__list_contributors(user, repo) def list_contributors_with_anonymous(self, user=None, repo=None): + """ Like :attr:`~pygithub3.services.repos.Repo.list_contributors` plus + anonymous """ return self.__list_contributors(user, repo, anom=True) def list_languages(self, user=None, repo=None): + """ Get repository's languages + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.list_languages', user=user, repo=repo) return self._get(request) def list_teams(self, user=None, repo=None): + """ Get repository's teams + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.list_teams', user=user, repo=repo) return self._get_result(request) def list_tags(self, user=None, repo=None): + """ Get repository's tags + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.list_tags', user=user, repo=repo) return self._get_result(request) def list_branches(self, user=None, repo=None): + """ Get repository's branches + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.list_branches', user=user, repo=repo) return self._get_result(request) diff --git a/pygithub3/services/users.py b/pygithub3/services/users.py index 8c436e6..0c8c7aa 100644 --- a/pygithub3/services/users.py +++ b/pygithub3/services/users.py @@ -15,7 +15,7 @@ class Keys(Service): def list(self): """ Get public keys - It returns a :doc:`result` + :returns: A :doc:`result` """ request = self.make_request('users.keys.list') return self._get_result(request) @@ -24,10 +24,6 @@ class Keys(Service): """ Get a public key :param int key_id: Key id - - :: - - key_service.get(42) """ request = self.make_request('users.keys.get', key_id=key_id) @@ -64,10 +60,6 @@ class Keys(Service): """ Delete a public key :param int key_id: Key id - - :: - - key_service.delete(42) """ request = self.make_request('users.keys.delete', key_id=key_id) @@ -83,8 +75,7 @@ class Followers(Service): """ Get user's followers :param str user: Username - - It returns a :doc:`result` + :returns: A :doc:`result` If you call it without user and you are authenticated, get the authenticated user's followers @@ -105,8 +96,7 @@ class Followers(Service): """ Get who a user is following :param str user: Username - - It returns a :doc:`result` + :returns: A :doc:`result` If you call it without user and you are authenticated, get the authenticated user's followings @@ -127,10 +117,6 @@ class Followers(Service): """ Check if you are following a user :param str user: Username - - :: - - followers_service.is_following('octocat') """ request = self.make_request('users.followers.isfollowing', user=user) return self._bool(request) @@ -143,10 +129,6 @@ class Followers(Service): .. warning:: You must be authenticated - - :: - - followers_service.follow('octocat') """ request = self.make_request('users.followers.follow', user=user) self._put(request) @@ -159,10 +141,6 @@ class Followers(Service): .. warning:: You must be authenticated - - :: - - followers_service.unfollow('octocat') """ request = self.make_request('users.followers.unfollow', user=user) self._delete(request) @@ -179,7 +157,7 @@ class Emails(Service): def list(self): """ Get user's emails - It returns a :doc:`result` + :returns: A :doc:`result` """ request = self.make_request('users.emails.list') return self._get_result(request) @@ -191,7 +169,7 @@ class Emails(Service): .. note:: - It reject non-valid emails + It rejects non-valid emails :: -- cgit v1.2.3-59-g8ed1b From 397238b404a66ba25aec1e4d7902e16104eddefc Mon Sep 17 00:00:00 2001 From: David Medina Date: Thu, 1 Mar 2012 13:12:00 +0100 Subject: Restructure modules and packages in a clean way The docs has increased lines of code, so I split it --- docs/github.rst | 2 +- docs/repos.rst | 13 +- docs/resources.rst | 2 + pygithub3/__init__.py | 2 + pygithub3/github.py | 4 +- pygithub3/requests/__init__.py | 136 ----------- pygithub3/requests/base.py | 137 ++++++++++++ pygithub3/requests/repos/__init__.py | 80 ++++++- pygithub3/requests/repos/collaborators.py | 1 + pygithub3/requests/repos/repo.py | 86 ------- pygithub3/requests/users/__init__.py | 32 ++- pygithub3/requests/users/emails.py | 2 +- pygithub3/requests/users/user.py | 35 --- pygithub3/services/base.py | 2 +- pygithub3/services/repos.py | 360 ------------------------------ pygithub3/services/repos/__init__.py | 199 +++++++++++++++++ pygithub3/services/repos/collaborators.py | 27 +++ pygithub3/services/repos/commits.py | 48 ++++ pygithub3/services/repos/downloads.py | 38 ++++ pygithub3/services/repos/forks.py | 17 ++ pygithub3/services/repos/keys.py | 31 +++ pygithub3/services/repos/watchers.py | 31 +++ pygithub3/services/users.py | 233 ------------------- pygithub3/services/users/__init__.py | 49 ++++ pygithub3/services/users/emails.py | 49 ++++ pygithub3/services/users/followers.py | 84 +++++++ pygithub3/services/users/keys.py | 66 ++++++ pygithub3/tests/requests/test_core.py | 2 +- pygithub3/tests/services/test_repos.py | 4 +- pygithub3/tests/utils/base.py | 2 +- 30 files changed, 910 insertions(+), 864 deletions(-) create mode 100644 pygithub3/requests/base.py delete mode 100644 pygithub3/requests/repos/repo.py delete mode 100644 pygithub3/requests/users/user.py delete mode 100644 pygithub3/services/repos.py create mode 100644 pygithub3/services/repos/__init__.py create mode 100644 pygithub3/services/repos/collaborators.py create mode 100644 pygithub3/services/repos/commits.py create mode 100644 pygithub3/services/repos/downloads.py create mode 100644 pygithub3/services/repos/forks.py create mode 100644 pygithub3/services/repos/keys.py create mode 100644 pygithub3/services/repos/watchers.py delete mode 100644 pygithub3/services/users.py create mode 100644 pygithub3/services/users/__init__.py create mode 100644 pygithub3/services/users/emails.py create mode 100644 pygithub3/services/users/followers.py create mode 100644 pygithub3/services/users/keys.py diff --git a/docs/github.rst b/docs/github.rst index b54cef2..ae4941b 100644 --- a/docs/github.rst +++ b/docs/github.rst @@ -3,5 +3,5 @@ Github This is the main entrance of **pygithub3** -.. autoclass:: pygithub3.github.Github +.. autoclass:: pygithub3.Github :members: diff --git a/docs/repos.rst b/docs/repos.rst index f6dbead..2a5bbe2 100644 --- a/docs/repos.rst +++ b/docs/repos.rst @@ -49,7 +49,7 @@ You can see it better with an example: :: Repo ------- -.. autoclass:: pygithub3.services.repos.Repo +.. autoclass:: pygithub3.services.repos.Repos :members: .. attribute:: collaborators @@ -81,33 +81,44 @@ Repo Collaborators -------------- +.. autoclass:: pygithub3.services.repos.Collaborators .. _Commits service: Commits ---------- +.. autoclass:: pygithub3.services.repos.Commits + .. _Downloads service: Downloads ------------ +.. autoclass:: pygithub3.services.repos.Downloads + .. _Forks service: Forks --------- +.. autoclass:: pygithub3.services.repos.Forks + .. _RepoKeys service: Keys ---------- +.. autoclass:: pygithub3.services.repos.Keys + .. _Watchers service: Watchers --------- +.. autoclass:: pygithub3.services.repos.Watchers + .. _github repo doc: http://developer.github.com/v3/repos diff --git a/docs/resources.rst b/docs/resources.rst index e69de29..24189e2 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -0,0 +1,2 @@ +Resources +========== diff --git a/pygithub3/__init__.py b/pygithub3/__init__.py index 0841aec..1e9d3e1 100644 --- a/pygithub3/__init__.py +++ b/pygithub3/__init__.py @@ -7,3 +7,5 @@ __author__ = 'David Medina' __email__ = 'davidmedina9@gmail.com' __license__ = 'ISC' __copyright__ = 'Copyright 2012 David Medina' + +from github import Github diff --git a/pygithub3/github.py b/pygithub3/github.py index d05f069..5b5353d 100644 --- a/pygithub3/github.py +++ b/pygithub3/github.py @@ -2,7 +2,7 @@ # -*- encoding: utf-8 -*- from pygithub3.services.users import User -from pygithub3.services.repos import Repo +from pygithub3.services.repos import Repos class Github(object): @@ -17,7 +17,7 @@ class Github(object): def __init__(self, **config): self._users = User(**config) - self._repos = Repo(**config) + self._repos = Repos(**config) @property def users(self): diff --git a/pygithub3/requests/__init__.py b/pygithub3/requests/__init__.py index b369565..dae354a 100644 --- a/pygithub3/requests/__init__.py +++ b/pygithub3/requests/__init__.py @@ -1,137 +1 @@ -#!/usr/bin/env python # -*- encoding: utf-8 -*- - -import re -from importlib import import_module -try: - import simplejson as json -except ImportError: - import json - -from pygithub3.exceptions import (DoesNotExists, UriInvalid, ValidationError, - InvalidBodySchema) -from pygithub3.resources.base import Raw - -ABS_IMPORT_PREFIX = 'pygithub3.requests' - - -class Body(object): - - def __init__(self, content, schema, required): - self.content = content - self.schema = schema - self.required = required - - def dumps(self): - if not self.schema: - return self.content or None - return json.dumps(self.parse()) - - def parse(self): - if not hasattr(self.content, 'items'): - raise ValidationError("'%s' needs a content dictionary" - % self.__class__.__name__) - parsed = {key: self.content[key] for key in self.schema - if key in self.content} - for attr_required in self.required: - if attr_required not in parsed: - raise ValidationError("'%s' attribute is required" % - attr_required) - if not parsed[attr_required]: - raise ValidationError("'%s' attribute can't be empty" % - attr_required) - return parsed - - -class Request(object): - """ """ - - uri = '' - resource = Raw - body_schema = {} - - def __init__(self, **kwargs): - """ """ - self.body = kwargs.pop('body', None) - self.args = kwargs - self.clean() - - def clean(self): - self.uri = self.clean_uri() or self.uri - self.body = Body(self.clean_body(), **self.clean_valid_body()) - - def clean_body(self): - return self.body - - def clean_uri(self): - return None - - def clean_valid_body(self): - schema = set(self.body_schema.get('schema', ())) - required = set(self.body_schema.get('required', ())) - if not required.issubset(schema): - raise InvalidBodySchema( - "'%s:valid_body' attribute is invalid. " - "'%s required' isn't a subset of '%s schema'" % ( - self.__class__.__name__, required, schema)) - return dict(schema=schema, required=required) - - def __getattr__(self, name): - return self.args.get(name) - - def __str__(self): - return self.populate_uri() - - def populate_uri(self): - try: - populated_uri = self.uri.format(**self.args) - except KeyError: - raise ValidationError( - "'%s' request wasn't be able to populate the uri '%s' with " - "'%s' args" % (self.__class__.__name__, self.uri, self.args)) - return str(populated_uri).strip('/') - - def get_body(self): - return self.body.dumps() - - -class Factory(object): - """ """ - - import_pattern = re.compile(r'^(\w+\.)+\w+$') - - def __validate(func): - """ """ - - def wrapper(self, request_uri, **kwargs): - if not Factory.import_pattern.match(request_uri): - raise UriInvalid("'%s' isn't valid form" % request_uri) - return func(self, request_uri.lower(), **kwargs) - return wrapper - - def __dispatch(func): - """ """ - - def wrapper(self, request_uri, **kwargs): - module_chunk, s, request_chunk = request_uri.rpartition('.') - try: - # TODO: CamelCase and under_score support, now only Class Name - module = import_module('%s.%s' - % (ABS_IMPORT_PREFIX, module_chunk)) - request = getattr(module, request_chunk.capitalize()) - except ImportError: - raise DoesNotExists("'%s' module does not exists" - % module_chunk) - except AttributeError: - raise DoesNotExists( - "'%s' request doesn't exists into '%s' module" - % (request_chunk.capitalize(), module_chunk)) - return func(self, request, **kwargs) - return wrapper - - @__validate - @__dispatch - def __call__(self, request='', **kwargs): - request = request(**kwargs) - assert isinstance(request, Request) - return request diff --git a/pygithub3/requests/base.py b/pygithub3/requests/base.py new file mode 100644 index 0000000..4b1aa9b --- /dev/null +++ b/pygithub3/requests/base.py @@ -0,0 +1,137 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +import re +from importlib import import_module +try: + import simplejson as json +except ImportError: + import json + +from pygithub3.exceptions import (DoesNotExists, UriInvalid, ValidationError, + InvalidBodySchema) +from pygithub3.resources.base import Raw + +ABS_IMPORT_PREFIX = 'pygithub3.requests' + + +class Body(object): + + def __init__(self, content, schema, required): + self.content = content + self.schema = schema + self.required = required + + def dumps(self): + if not self.schema: + return self.content or None + return json.dumps(self.parse()) + + def parse(self): + if not hasattr(self.content, 'items'): + raise ValidationError("'%s' needs a content dictionary" + % self.__class__.__name__) + parsed = {key: self.content[key] for key in self.schema + if key in self.content} + for attr_required in self.required: + if attr_required not in parsed: + raise ValidationError("'%s' attribute is required" % + attr_required) + if not parsed[attr_required]: + raise ValidationError("'%s' attribute can't be empty" % + attr_required) + return parsed + + +class Request(object): + """ """ + + uri = '' + resource = Raw + body_schema = {} + + def __init__(self, **kwargs): + """ """ + self.body = kwargs.pop('body', None) + self.args = kwargs + self.clean() + + def clean(self): + self.uri = self.clean_uri() or self.uri + self.body = Body(self.clean_body(), **self.clean_valid_body()) + + def clean_body(self): + return self.body + + def clean_uri(self): + return None + + def clean_valid_body(self): + schema = set(self.body_schema.get('schema', ())) + required = set(self.body_schema.get('required', ())) + if not required.issubset(schema): + raise InvalidBodySchema( + "'%s:valid_body' attribute is invalid. " + "'%s required' isn't a subset of '%s schema'" % ( + self.__class__.__name__, required, schema)) + return dict(schema=schema, required=required) + + def __getattr__(self, name): + return self.args.get(name) + + def __str__(self): + return self.populate_uri() + + def populate_uri(self): + try: + populated_uri = self.uri.format(**self.args) + except KeyError: + raise ValidationError( + "'%s' request wasn't be able to populate the uri '%s' with " + "'%s' args" % (self.__class__.__name__, self.uri, self.args)) + return str(populated_uri).strip('/') + + def get_body(self): + return self.body.dumps() + + +class Factory(object): + """ """ + + import_pattern = re.compile(r'^(\w+\.)+\w+$') + + def validate(func): + """ """ + + def wrapper(self, request_uri, **kwargs): + if not Factory.import_pattern.match(request_uri): + raise UriInvalid("'%s' isn't valid form" % request_uri) + return func(self, request_uri.lower(), **kwargs) + return wrapper + + def dispatch(func): + """ """ + + def wrapper(self, request_uri, **kwargs): + module_chunk, s, request_chunk = request_uri.rpartition('.') + try: + # TODO: CamelCase and under_score support, now only Class Name + module = import_module('%s.%s' + % (ABS_IMPORT_PREFIX, module_chunk)) + request = getattr(module, request_chunk.capitalize()) + except ImportError: + raise DoesNotExists("'%s' module does not exists" + % module_chunk) + except AttributeError: + raise DoesNotExists( + "'%s' request doesn't exists into '%s' module" + % (request_chunk.capitalize(), module_chunk)) + return func(self, request, **kwargs) + return wrapper + + @validate + @dispatch + def __call__(self, request='', **kwargs): + request = request(**kwargs) + assert isinstance(request, Request) + return request diff --git a/pygithub3/requests/repos/__init__.py b/pygithub3/requests/repos/__init__.py index bb86dac..5c7785a 100644 --- a/pygithub3/requests/repos/__init__.py +++ b/pygithub3/requests/repos/__init__.py @@ -1,4 +1,80 @@ # -*- encoding: utf-8 -*- -from pygithub3.requests import Request, ValidationError -from repo import * +from ..base import Request, ValidationError +from pygithub3.resources.users import User +from pygithub3.resources.repos import Repo, Team, Tag, Branch + +class List(Request): + + uri = 'users/{user}/repos' + resource = Repo + + def clean_uri(self): + if not self.user: + return 'user/repos' + + +class List_by_org(Request): + + uri = 'orgs/{org}/repos' + resource = Repo + + +class Create(Request): + + uri = 'orgs/{org}/repos' + resource = Repo + body_schema = { + 'schema': ('name', 'description', 'homepage', 'private', 'has_issues', + 'has_wiki', 'has_downloads', 'team_id'), + 'required': ('name', ) + } + + def clean_uri(self): + if not self.org: + return 'user/repos' + + +class Get(Request): + + uri = 'repos/{user}/{repo}' + resource = Repo + + +class Update(Request): + + uri = 'repos/{user}/{repo}' + resource = Repo + body_schema = { + 'schema': ('name', 'description', 'homepage', 'private', 'has_issues', + 'has_wiki', 'has_downloads', 'team_id'), + 'required': ('name', ) + } + + +class List_contributors(Request): + + uri = 'repos/{user}/{repo}/contributors' + resource = User + + +class List_languages(Request): + + uri = 'repos/{user}/{repo}/languages' + + +class List_teams(Request): + + uri = 'repos/{user}/{repo}/teams' + resource = Team + + +class List_tags(Request): + + uri = 'repos/{user}/{repo}/tags' + resource = Tag + +class List_branches(Request): + + uri = 'repos/{user}/{repo}/branches' + resource = Branch diff --git a/pygithub3/requests/repos/collaborators.py b/pygithub3/requests/repos/collaborators.py index c4b5f79..068a9dc 100644 --- a/pygithub3/requests/repos/collaborators.py +++ b/pygithub3/requests/repos/collaborators.py @@ -4,6 +4,7 @@ from . import Request from pygithub3.resources.users import User + class List(Request): uri = 'repos/{user}/{repo}/collaborators' diff --git a/pygithub3/requests/repos/repo.py b/pygithub3/requests/repos/repo.py deleted file mode 100644 index 45375a9..0000000 --- a/pygithub3/requests/repos/repo.py +++ /dev/null @@ -1,86 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -from . import Request -from pygithub3.resources.repos import Repo, Team, Tag, Branch -from pygithub3.resources.users import User - -__all__ = ('List', 'List_by_org', 'Create', 'Get', 'Update', - 'List_contributors', 'List_languages', 'List_teams', 'List_tags', - 'List_branches') - - -class List(Request): - - uri = 'users/{user}/repos' - resource = Repo - - def clean_uri(self): - if not self.user: - return 'user/repos' - - -class List_by_org(Request): - - uri = 'orgs/{org}/repos' - resource = Repo - - -class Create(Request): - - uri = 'orgs/{org}/repos' - resource = Repo - body_schema = { - 'schema': ('name', 'description', 'homepage', 'private', 'has_issues', - 'has_wiki', 'has_downloads', 'team_id'), - 'required': ('name', ) - } - - def clean_uri(self): - if not self.org: - return 'user/repos' - - -class Get(Request): - - uri = 'repos/{user}/{repo}' - resource = Repo - - -class Update(Request): - - uri = 'repos/{user}/{repo}' - resource = Repo - body_schema = { - 'schema': ('name', 'description', 'homepage', 'private', 'has_issues', - 'has_wiki', 'has_downloads', 'team_id'), - 'required': ('name', ) - } - - -class List_contributors(Request): - - uri = 'repos/{user}/{repo}/contributors' - resource = User - - -class List_languages(Request): - - uri = 'repos/{user}/{repo}/languages' - - -class List_teams(Request): - - uri = 'repos/{user}/{repo}/teams' - resource = Team - - -class List_tags(Request): - - uri = 'repos/{user}/{repo}/tags' - resource = Tag - -class List_branches(Request): - - uri = 'repos/{user}/{repo}/branches' - resource = Branch diff --git a/pygithub3/requests/users/__init__.py b/pygithub3/requests/users/__init__.py index 11e6a39..d8df00d 100644 --- a/pygithub3/requests/users/__init__.py +++ b/pygithub3/requests/users/__init__.py @@ -1,4 +1,32 @@ # -*- encoding: utf-8 -*- -from pygithub3.requests import Request, ValidationError -from user import * +from ..base import Request, ValidationError +from pygithub3.resources.users import User + + +class Get(Request): + + resource = User + uri = 'users/{user}' + + def clean_uri(self): + if not self.user: + return 'user' + + +class Update(Request): + + resource = User + uri = 'user' + body_schema = { + 'schema': ('name', 'email', 'blog', 'company', 'location', 'hireable', + 'bio'), + 'required': (), + } + + def clean_body(self): + if not self.body: + raise ValidationError("'%s' request needs data. You can use " + "'%s' keys" % (self.__class__.__name__, + self.body_schema)) + return self.body diff --git a/pygithub3/requests/users/emails.py b/pygithub3/requests/users/emails.py index ae4d8b8..ff89b62 100644 --- a/pygithub3/requests/users/emails.py +++ b/pygithub3/requests/users/emails.py @@ -25,7 +25,7 @@ class Add(Request): def clean_body(self): def is_email(email): - return bool(email_re.match(email)) # TODO: email regex ;) + return bool(email_re.match(email)) if not self.body: raise ValidationError("'%s' request needs emails" % (self.__class__.__name__)) diff --git a/pygithub3/requests/users/user.py b/pygithub3/requests/users/user.py deleted file mode 100644 index 3267f76..0000000 --- a/pygithub3/requests/users/user.py +++ /dev/null @@ -1,35 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -from . import Request, ValidationError -from pygithub3.resources.users import User - -__all__ = ('Get', 'Update') - - -class Get(Request): - - resource = User - uri = 'users/{user}' - - def clean_uri(self): - if not self.user: - return 'user' - - -class Update(Request): - - resource = User - uri = 'user' - body_schema = { - 'schema': ('name', 'email', 'blog', 'company', 'location', 'hireable', - 'bio'), - 'required': (), - } - - def clean_body(self): - if not self.body: - raise ValidationError("'%s' request needs data. You can use " - "'%s' keys" % (self.__class__.__name__, - self.body_schema)) - return self.body diff --git a/pygithub3/services/base.py b/pygithub3/services/base.py index d50ceb7..7fb6133 100644 --- a/pygithub3/services/base.py +++ b/pygithub3/services/base.py @@ -3,7 +3,7 @@ from pygithub3.core.client import Client from pygithub3.core.result import Result -from pygithub3.requests import Factory +from pygithub3.requests.base import Factory from pygithub3.core.errors import NotFound diff --git a/pygithub3/services/repos.py b/pygithub3/services/repos.py deleted file mode 100644 index b4cf43c..0000000 --- a/pygithub3/services/repos.py +++ /dev/null @@ -1,360 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -import requests - -from .base import Service, MimeTypeMixin - - -class Watchers(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.watchers.list', - user=user, repo=repo) - return self._get_result(request) - - def list_repos(self, user=None): - request = self.make_request('repos.watchers.list_repos', user=user) - return self._get_result(request) - - def is_watching(self, user=None, repo=None): - request = self.make_request('repos.watchers.is_watching', - user=user, repo=repo) - return self._bool(request) - - def watch(self, user=None, repo=None): - request = self.make_request('repos.watchers.watch', - user=user, repo=repo) - self._put(request) - - def unwatch(self, user=None, repo=None): - request = self.make_request('repos.watchers.unwatch', - user=user, repo=repo) - self._delete(request) - - -class Keys(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.keys.list', user=user, repo=repo) - return self._get_result(request) - - def get(self, id, user=None, repo=None): - request = self.make_request('repos.keys.get', - id=id, user=user, repo=repo) - return self._get(request) - - def create(self, data, user=None, repo=None): - request = self.make_request('repos.keys.create', - body=data, user=user, repo=repo) - return self._post(request) - - def update(self, id, data, user=None, repo=None): - request = self.make_request('repos.keys.update', - id=id, body=data, user=user, repo=repo) - return self._patch(request) - - def delete(self, id, user=None, repo=None): - request = self.make_request('repos.keys.delete', - id=id, user=user, repo=repo) - self._delete(request) - - -class Forks(Service): - - def list(self, user=None, repo=None, sort='newest'): - request = self.make_request('repos.forks.list', user=user, repo=repo) - return self._get_result(request, sort=sort) - - def create(self, user=None, repo=None, org=None): - request = self.make_request('repos.forks.create', user=user, repo=repo) - org = {'org': org} if org else {} - return self._post(request, **org) - - -class Downloads(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.downloads.list', - user=user, repo=repo) - return self._get_result(request) - - def get(self, id, user=None, repo=None): - request = self.make_request('repos.downloads.get', - id=id, user=user, repo=repo) - return self._get(request) - - def create(self, data, user=None, repo=None): - request = self.make_request('repos.downloads.create', - body=data, user=user, repo=repo) - download = self._post(request) - - # TODO: improve it. e.g Manage all with file desc - def upload(file_path): - body = download.ball_to_upload() - body['file'] = (file_path, open(file_path, 'rb')) - return requests.post(download.s3_url, files=body) - - download.upload = upload - return download - - def delete(self, id=id, user=None, repo=None): - request = self.make_request('repos.downloads.delete', - id=id, user=user, repo=repo) - self._delete(request) - - -class Commits(Service, MimeTypeMixin): - - """ TODO: Pagination structure differs from usual - def list(self, user=None, repo=None, sha='', path=''): - request = self.make_request('repos.commits.list', user=user, repo=repo) - return self._get_result(request, sha=sha, path=path) - """ - - def get(self, sha, user=None, repo=None): - request = self.make_request('repos.commits.get', - sha=sha, user=user, repo=repo) - return self._get(request) - - def list_comments(self, sha=None, user=None, repo=None): - request = self.make_request('repos.commits.list_comments', - sha=sha, user=user, repo=repo) - return self._get_result(request, **self._get_mimetype_as_header()) - - def create_comment(self, data, sha, user=None, repo=None): - request = self.make_request('repos.commits.create_comment', - sha=sha, user=user, repo=repo, body=data) - return self._post(request, **self._get_mimetype_as_header()) - - def get_comment(self, cid, user=None, repo=None): - request = self.make_request('repos.commits.get_comment', - comment_id=cid, user=user, repo=repo) - return self._get(request, **self._get_mimetype_as_header()) - - def update_comment(self, data, cid, user=None, repo=None): - request = self.make_request('repos.commits.update_comment', - comment_id=cid, user=user, repo=repo, body=data) - return self._patch(request, **self._get_mimetype_as_header()) - - def compare(self, base, head, user=None, repo=None): - request = self.make_request('repos.commits.compare', - base=base, head=head, user=user, repo=repo) - return self._get(request) - - def delete_comment(self, cid, user=None, repo=None): - request = self.make_request('repos.commits.delete_comment', - comment_id=cid, user=user, repo=repo) - self._delete(request) - - -class Collaborators(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.collaborators.list', - user=user, repo=repo) - return self._get_result(request) - - def add(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.add', - collaborator=collaborator, user=user, repo=repo) - return self._put(request) - - def is_collaborator(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.is_collaborator', - collaborator=collaborator, user=user, repo=repo) - return self._bool(request) - - def delete(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.delete', - collaborator=collaborator, user=user, repo=repo) - self._delete(request) - - -class Repo(Service): - """ Consume `Repos API `_ """ - - def __init__(self, **config): - self.collaborators = Collaborators(**config) - self.commits = Commits(**config) - self.downloads = Downloads(**config) - self.forks = Forks(**config) - self.keys = Keys(**config) - self.watchers = Watchers(**config) - super(Repo, self).__init__(**config) - - def list(self, user=None, type='all'): - """ Get user's repositories - - :param str user: Username - :param str type: Filter by type (optional). See `github repo doc`_ - :returns: A :doc:`result` - - If you call it without user and you are authenticated, get the - authenticated user's repositories - - .. warning:: - - If you aren't authenticated and call without user, it returns 403 - - :: - - repo_service.list('copitux', type='owner') - repo_service.list(type='private') - """ - request = self.make_request('repos.list', user=user) - return self._get_result(request, type=type) - - def list_by_org(self, org, type='all'): - """ Get organization's repositories - - :param str org: Organization name - :param str type: Filter by type (optional). See `github repo doc`_ - :returns: A :doc:`result` - - :: - - repo_service.list_by_org('myorganization', type='member') - """ - request = self.make_request('repos.list_by_org', org=org) - return self._get_result(request, type=type) - - def create(self, data, in_org=None): - """ Create a new repository - - :param dict data: Input. See `github repo doc`_ - :param str in_org: Organization where create the repository (optional) - - .. warning:: - - You must be authenticated - - If you use ``in_org`` arg, the authenticated user must be a member - of - - :: - - repo_service.create(dict(name='new_repo', description='desc')) - repo_service.create(dict(name='new_repo_in_org', team_id=2300), - in_org='myorganization') - """ - request = self.make_request('repos.create', org=in_org, body=data) - return self._post(request) - - def get(self, user=None, repo=None): - """ Get a single repo - - :param str user: Username - :param str repo: Repository - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.get', user=user, repo=repo) - return self._get(request) - - def update(self, data, user=None, repo=None): - """ Update a single repository - - :param dict data: Input. See `github repo doc`_ - :param str user: Username - :param str repo: Repository - - .. note:: - - Remember :ref:`config precedence` - - .. warning:: - - You must be authenticated - - :: - - repo_service.update(dict(has_issues=True), user='octocat', - repo='oct_repo') - """ - request = self.make_request('repos.update', body=data, - user=user, repo=repo) - return self._patch(request) - - def __list_contributors(self, user=None, repo=None, **kwargs): - request = self.make_request('repos.list_contributors', - user=user, repo=repo) - return self._get_result(request, **kwargs) - - def list_contributors(self, user=None, repo=None): - """ Get repository's contributors - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - return self.__list_contributors(user, repo) - - def list_contributors_with_anonymous(self, user=None, repo=None): - """ Like :attr:`~pygithub3.services.repos.Repo.list_contributors` plus - anonymous """ - return self.__list_contributors(user, repo, anom=True) - - def list_languages(self, user=None, repo=None): - """ Get repository's languages - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.list_languages', - user=user, repo=repo) - return self._get(request) - - def list_teams(self, user=None, repo=None): - """ Get repository's teams - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.list_teams', user=user, repo=repo) - return self._get_result(request) - - def list_tags(self, user=None, repo=None): - """ Get repository's tags - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.list_tags', user=user, repo=repo) - return self._get_result(request) - - def list_branches(self, user=None, repo=None): - """ Get repository's branches - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.list_branches', - user=user, repo=repo) - return self._get_result(request) diff --git a/pygithub3/services/repos/__init__.py b/pygithub3/services/repos/__init__.py new file mode 100644 index 0000000..6e3627f --- /dev/null +++ b/pygithub3/services/repos/__init__.py @@ -0,0 +1,199 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from ..base import Service, MimeTypeMixin +from .collaborators import Collaborators +from .commits import Commits +from .downloads import Downloads +from .forks import Forks +from .keys import Keys +from .watchers import Watchers + + +class Repos(Service): + """ Consume `Repos API `_ """ + + def __init__(self, **config): + self.collaborators = Collaborators(**config) + self.commits = Commits(**config) + self.downloads = Downloads(**config) + self.forks = Forks(**config) + self.keys = Keys(**config) + self.watchers = Watchers(**config) + super(Repos, self).__init__(**config) + + def list(self, user=None, type='all'): + """ Get user's repositories + + :param str user: Username + :param str type: Filter by type (optional). See `github repo doc`_ + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's repositories + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + repo_service.list('copitux', type='owner') + repo_service.list(type='private') + """ + request = self.make_request('repos.list', user=user) + return self._get_result(request, type=type) + + def list_by_org(self, org, type='all'): + """ Get organization's repositories + + :param str org: Organization name + :param str type: Filter by type (optional). See `github repo doc`_ + :returns: A :doc:`result` + + :: + + repo_service.list_by_org('myorganization', type='member') + """ + request = self.make_request('repos.list_by_org', org=org) + return self._get_result(request, type=type) + + def create(self, data, in_org=None): + """ Create a new repository + + :param dict data: Input. See `github repo doc`_ + :param str in_org: Organization where create the repository (optional) + + .. warning:: + + You must be authenticated + + If you use ``in_org`` arg, the authenticated user must be a member + of + + :: + + repo_service.create(dict(name='new_repo', description='desc')) + repo_service.create(dict(name='new_repo_in_org', team_id=2300), + in_org='myorganization') + """ + request = self.make_request('repos.create', org=in_org, body=data) + return self._post(request) + + def get(self, user=None, repo=None): + """ Get a single repo + + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.get', user=user, repo=repo) + return self._get(request) + + def update(self, data, user=None, repo=None): + """ Update a single repository + + :param dict data: Input. See `github repo doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + .. warning:: + + You must be authenticated + + :: + + repo_service.update(dict(has_issues=True), user='octocat', + repo='oct_repo') + """ + request = self.make_request('repos.update', body=data, + user=user, repo=repo) + return self._patch(request) + + def __list_contributors(self, user=None, repo=None, **kwargs): + request = self.make_request('repos.list_contributors', + user=user, repo=repo) + return self._get_result(request, **kwargs) + + def list_contributors(self, user=None, repo=None): + """ Get repository's contributors + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + return self.__list_contributors(user, repo) + + def list_contributors_with_anonymous(self, user=None, repo=None): + """ Like :attr:`~pygithub3.services.repos.Repos.list_contributors` plus + anonymous """ + return self.__list_contributors(user, repo, anom=True) + + def list_languages(self, user=None, repo=None): + """ Get repository's languages + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_languages', + user=user, repo=repo) + return self._get(request) + + def list_teams(self, user=None, repo=None): + """ Get repository's teams + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_teams', user=user, repo=repo) + return self._get_result(request) + + def list_tags(self, user=None, repo=None): + """ Get repository's tags + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_tags', user=user, repo=repo) + return self._get_result(request) + + def list_branches(self, user=None, repo=None): + """ Get repository's branches + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_branches', + user=user, repo=repo) + return self._get_result(request) diff --git a/pygithub3/services/repos/collaborators.py b/pygithub3/services/repos/collaborators.py new file mode 100644 index 0000000..3bc4c9d --- /dev/null +++ b/pygithub3/services/repos/collaborators.py @@ -0,0 +1,27 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Collaborators(Service): + + def list(self, user=None, repo=None): + request = self.make_request('repos.collaborators.list', + user=user, repo=repo) + return self._get_result(request) + + def add(self, collaborator, user=None, repo=None): + request = self.make_request('repos.collaborators.add', + collaborator=collaborator, user=user, repo=repo) + return self._put(request) + + def is_collaborator(self, collaborator, user=None, repo=None): + request = self.make_request('repos.collaborators.is_collaborator', + collaborator=collaborator, user=user, repo=repo) + return self._bool(request) + + def delete(self, collaborator, user=None, repo=None): + request = self.make_request('repos.collaborators.delete', + collaborator=collaborator, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/commits.py b/pygithub3/services/repos/commits.py new file mode 100644 index 0000000..3d5abb6 --- /dev/null +++ b/pygithub3/services/repos/commits.py @@ -0,0 +1,48 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service, MimeTypeMixin + + +class Commits(Service, MimeTypeMixin): + + """ TODO: Pagination structure differs from usual + def list(self, user=None, repo=None, sha='', path=''): + request = self.make_request('repos.commits.list', user=user, repo=repo) + return self._get_result(request, sha=sha, path=path) + """ + + def get(self, sha, user=None, repo=None): + request = self.make_request('repos.commits.get', + sha=sha, user=user, repo=repo) + return self._get(request) + + def list_comments(self, sha=None, user=None, repo=None): + request = self.make_request('repos.commits.list_comments', + sha=sha, user=user, repo=repo) + return self._get_result(request, **self._get_mimetype_as_header()) + + def create_comment(self, data, sha, user=None, repo=None): + request = self.make_request('repos.commits.create_comment', + sha=sha, user=user, repo=repo, body=data) + return self._post(request, **self._get_mimetype_as_header()) + + def get_comment(self, cid, user=None, repo=None): + request = self.make_request('repos.commits.get_comment', + comment_id=cid, user=user, repo=repo) + return self._get(request, **self._get_mimetype_as_header()) + + def update_comment(self, data, cid, user=None, repo=None): + request = self.make_request('repos.commits.update_comment', + comment_id=cid, user=user, repo=repo, body=data) + return self._patch(request, **self._get_mimetype_as_header()) + + def compare(self, base, head, user=None, repo=None): + request = self.make_request('repos.commits.compare', + base=base, head=head, user=user, repo=repo) + return self._get(request) + + def delete_comment(self, cid, user=None, repo=None): + request = self.make_request('repos.commits.delete_comment', + comment_id=cid, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/downloads.py b/pygithub3/services/repos/downloads.py new file mode 100644 index 0000000..c455021 --- /dev/null +++ b/pygithub3/services/repos/downloads.py @@ -0,0 +1,38 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +import requests + +from . import Service + + +class Downloads(Service): + + def list(self, user=None, repo=None): + request = self.make_request('repos.downloads.list', + user=user, repo=repo) + return self._get_result(request) + + def get(self, id, user=None, repo=None): + request = self.make_request('repos.downloads.get', + id=id, user=user, repo=repo) + return self._get(request) + + def create(self, data, user=None, repo=None): + request = self.make_request('repos.downloads.create', + body=data, user=user, repo=repo) + download = self._post(request) + + # TODO: improve it. e.g Manage all with file desc + def upload(file_path): + body = download.ball_to_upload() + body['file'] = (file_path, open(file_path, 'rb')) + return requests.post(download.s3_url, files=body) + + download.upload = upload + return download + + def delete(self, id=id, user=None, repo=None): + request = self.make_request('repos.downloads.delete', + id=id, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/forks.py b/pygithub3/services/repos/forks.py new file mode 100644 index 0000000..09f23c5 --- /dev/null +++ b/pygithub3/services/repos/forks.py @@ -0,0 +1,17 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Forks(Service): + + def list(self, user=None, repo=None, sort='newest'): + request = self.make_request('repos.forks.list', user=user, repo=repo) + return self._get_result(request, sort=sort) + + def create(self, user=None, repo=None, org=None): + request = self.make_request('repos.forks.create', user=user, repo=repo) + #org = {'org': org} if org else {} + org = org and {'org': org} or {} + return self._post(request, **org) diff --git a/pygithub3/services/repos/keys.py b/pygithub3/services/repos/keys.py new file mode 100644 index 0000000..24a7cb3 --- /dev/null +++ b/pygithub3/services/repos/keys.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Keys(Service): + + def list(self, user=None, repo=None): + request = self.make_request('repos.keys.list', user=user, repo=repo) + return self._get_result(request) + + def get(self, id, user=None, repo=None): + request = self.make_request('repos.keys.get', + id=id, user=user, repo=repo) + return self._get(request) + + def create(self, data, user=None, repo=None): + request = self.make_request('repos.keys.create', + body=data, user=user, repo=repo) + return self._post(request) + + def update(self, id, data, user=None, repo=None): + request = self.make_request('repos.keys.update', + id=id, body=data, user=user, repo=repo) + return self._patch(request) + + def delete(self, id, user=None, repo=None): + request = self.make_request('repos.keys.delete', + id=id, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/watchers.py b/pygithub3/services/repos/watchers.py new file mode 100644 index 0000000..8598590 --- /dev/null +++ b/pygithub3/services/repos/watchers.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Watchers(Service): + + def list(self, user=None, repo=None): + request = self.make_request('repos.watchers.list', + user=user, repo=repo) + return self._get_result(request) + + def list_repos(self, user=None): + request = self.make_request('repos.watchers.list_repos', user=user) + return self._get_result(request) + + def is_watching(self, user=None, repo=None): + request = self.make_request('repos.watchers.is_watching', + user=user, repo=repo) + return self._bool(request) + + def watch(self, user=None, repo=None): + request = self.make_request('repos.watchers.watch', + user=user, repo=repo) + self._put(request) + + def unwatch(self, user=None, repo=None): + request = self.make_request('repos.watchers.unwatch', + user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/users.py b/pygithub3/services/users.py deleted file mode 100644 index 0c8c7aa..0000000 --- a/pygithub3/services/users.py +++ /dev/null @@ -1,233 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -from .base import Service - - -class Keys(Service): - """ Consume `Keys API `_ - - .. warning:: - - You must be authenticated for all requests - """ - - def list(self): - """ Get public keys - - :returns: A :doc:`result` - """ - request = self.make_request('users.keys.list') - return self._get_result(request) - - def get(self, key_id): - """ Get a public key - - :param int key_id: Key id - """ - request = self.make_request('users.keys.get', - key_id=key_id) - return self._get(request) - - def add(self, data): - """ Add a public key - - :param dict data: Key (title and key attributes required) - - :: - - key_service.add(dict(title='host', key='ssh-rsa AAA...')) - """ - request = self.make_request('users.keys.add', - body=data) - return self._post(request) - - def update(self, key_id, data): - """ Update a public key - - :param int key_id: Key id - :param dict data: Key (title and key attributes required) - - :: - - key_service.update(42, dict(title='host', key='ssh-rsa AAA...')) - """ - request = self.make_request('users.keys.update', - key_id=key_id, body=data) - return self._patch(request) - - def delete(self, key_id): - """ Delete a public key - - :param int key_id: Key id - """ - request = self.make_request('users.keys.delete', - key_id=key_id) - self._delete(request) - - -class Followers(Service): - """ Consume `Followers API - `_ - """ - - def list(self, user=None): - """ Get user's followers - - :param str user: Username - :returns: A :doc:`result` - - If you call it without user and you are authenticated, get the - authenticated user's followers - - .. warning:: - - If you aren't authenticated and call without user, it returns 403 - - :: - - followers_service.list() - followers_service.list('octocat') - """ - request = self.make_request('users.followers.list', user=user) - return self._get_result(request) - - def list_following(self, user=None): - """ Get who a user is following - - :param str user: Username - :returns: A :doc:`result` - - If you call it without user and you are authenticated, get the - authenticated user's followings - - .. warning:: - - If you aren't authenticated and call without user, it returns 403 - - :: - - followers_service.list_following() - followers_service.list_following('octocat') - """ - request = self.make_request('users.followers.listfollowing', user=user) - return self._get_result(request) - - def is_following(self, user): - """ Check if you are following a user - - :param str user: Username - """ - request = self.make_request('users.followers.isfollowing', user=user) - return self._bool(request) - - def follow(self, user): - """ Follow a user - - :param str user: Username - - .. warning:: - - You must be authenticated - """ - request = self.make_request('users.followers.follow', user=user) - self._put(request) - - def unfollow(self, user): - """ Unfollow a user - - :param str user: Username - - .. warning:: - - You must be authenticated - """ - request = self.make_request('users.followers.unfollow', user=user) - self._delete(request) - - -class Emails(Service): - """ Consume `Emails API `_ - - .. warning:: - - You must be authenticated for all requests - """ - - def list(self): - """ Get user's emails - - :returns: A :doc:`result` - """ - request = self.make_request('users.emails.list') - return self._get_result(request) - - def add(self, *emails): - """ Add emails - - :param list emails: Emails to add - - .. note:: - - It rejects non-valid emails - - :: - - email_service.add('test1@xample.com', 'test2@xample.com') - """ - request = self.make_request('users.emails.add', body=emails) - return self._post(request) - - def delete(self, *emails): - """ Delete emails - - :param list emails: List of emails - - :: - - email_service.delete('test1@xample.com', 'test2@xample.com') - """ - request = self.make_request('users.emails.delete', body=emails) - self._delete(request) - - -class User(Service): - """ Consume `Users API `_ """ - - def __init__(self, **config): - self.keys = Keys(**config) - self.emails = Emails(**config) - self.followers = Followers(**config) - super(User, self).__init__(**config) - - def get(self, user=None): - """ Get a single user - - :param str user: Username - - If you call it without user and you are authenticated, get the - authenticated user. - - .. warning:: - - If you aren't authenticated and call without user, it returns 403 - - :: - - user_service.get('copitux') - user_service.get() - """ - request = self.make_request('users.get', user=user) - return self._get(request) - - def update(self, data): - """ Update the authenticated user - - :param dict data: Input to update - - :: - - user_service.update(dict(name='new_name', bio='new_bio')) - """ - request = self.make_request('users.update', body=data) - return self._patch(request) diff --git a/pygithub3/services/users/__init__.py b/pygithub3/services/users/__init__.py new file mode 100644 index 0000000..c448319 --- /dev/null +++ b/pygithub3/services/users/__init__.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from ..base import Service +from .keys import Keys +from .emails import Emails +from .followers import Followers + + +class User(Service): + """ Consume `Users API `_ """ + + def __init__(self, **config): + self.keys = Keys(**config) + self.emails = Emails(**config) + self.followers = Followers(**config) + super(User, self).__init__(**config) + + def get(self, user=None): + """ Get a single user + + :param str user: Username + + If you call it without user and you are authenticated, get the + authenticated user. + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + user_service.get('copitux') + user_service.get() + """ + request = self.make_request('users.get', user=user) + return self._get(request) + + def update(self, data): + """ Update the authenticated user + + :param dict data: Input to update + + :: + + user_service.update(dict(name='new_name', bio='new_bio')) + """ + request = self.make_request('users.update', body=data) + return self._patch(request) diff --git a/pygithub3/services/users/emails.py b/pygithub3/services/users/emails.py new file mode 100644 index 0000000..084a29c --- /dev/null +++ b/pygithub3/services/users/emails.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Emails(Service): + """ Consume `Emails API `_ + + .. warning:: + + You must be authenticated for all requests + """ + + def list(self): + """ Get user's emails + + :returns: A :doc:`result` + """ + request = self.make_request('users.emails.list') + return self._get_result(request) + + def add(self, *emails): + """ Add emails + + :param list emails: Emails to add + + .. note:: + + It rejects non-valid emails + + :: + + email_service.add('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.add', body=emails) + return self._post(request) + + def delete(self, *emails): + """ Delete emails + + :param list emails: List of emails + + :: + + email_service.delete('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.delete', body=emails) + self._delete(request) diff --git a/pygithub3/services/users/followers.py b/pygithub3/services/users/followers.py new file mode 100644 index 0000000..d6969e2 --- /dev/null +++ b/pygithub3/services/users/followers.py @@ -0,0 +1,84 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Followers(Service): + """ Consume `Followers API + `_ + """ + + def list(self, user=None): + """ Get user's followers + + :param str user: Username + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's followers + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + followers_service.list() + followers_service.list('octocat') + """ + request = self.make_request('users.followers.list', user=user) + return self._get_result(request) + + def list_following(self, user=None): + """ Get who a user is following + + :param str user: Username + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's followings + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + followers_service.list_following() + followers_service.list_following('octocat') + """ + request = self.make_request('users.followers.listfollowing', user=user) + return self._get_result(request) + + def is_following(self, user): + """ Check if you are following a user + + :param str user: Username + """ + request = self.make_request('users.followers.isfollowing', user=user) + return self._bool(request) + + def follow(self, user): + """ Follow a user + + :param str user: Username + + .. warning:: + + You must be authenticated + """ + request = self.make_request('users.followers.follow', user=user) + self._put(request) + + def unfollow(self, user): + """ Unfollow a user + + :param str user: Username + + .. warning:: + + You must be authenticated + """ + request = self.make_request('users.followers.unfollow', user=user) + self._delete(request) diff --git a/pygithub3/services/users/keys.py b/pygithub3/services/users/keys.py new file mode 100644 index 0000000..996233c --- /dev/null +++ b/pygithub3/services/users/keys.py @@ -0,0 +1,66 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Keys(Service): + """ Consume `Keys API `_ + + .. warning:: + + You must be authenticated for all requests + """ + + def list(self): + """ Get public keys + + :returns: A :doc:`result` + """ + request = self.make_request('users.keys.list') + return self._get_result(request) + + def get(self, key_id): + """ Get a public key + + :param int key_id: Key id + """ + request = self.make_request('users.keys.get', + key_id=key_id) + return self._get(request) + + def add(self, data): + """ Add a public key + + :param dict data: Key (title and key attributes required) + + :: + + key_service.add(dict(title='host', key='ssh-rsa AAA...')) + """ + request = self.make_request('users.keys.add', + body=data) + return self._post(request) + + def update(self, key_id, data): + """ Update a public key + + :param int key_id: Key id + :param dict data: Key (title and key attributes required) + + :: + + key_service.update(42, dict(title='host', key='ssh-rsa AAA...')) + """ + request = self.make_request('users.keys.update', + key_id=key_id, body=data) + return self._patch(request) + + def delete(self, key_id): + """ Delete a public key + + :param int key_id: Key id + """ + request = self.make_request('users.keys.delete', + key_id=key_id) + self._delete(request) diff --git a/pygithub3/tests/requests/test_core.py b/pygithub3/tests/requests/test_core.py index 9e38763..3f2d615 100644 --- a/pygithub3/tests/requests/test_core.py +++ b/pygithub3/tests/requests/test_core.py @@ -4,7 +4,7 @@ from unittest import TestCase from mock import Mock -from pygithub3.requests import Factory, Body, json, Request +from pygithub3.requests.base import Factory, Body, json, Request from pygithub3.exceptions import (UriInvalid, DoesNotExists, ValidationError, InvalidBodySchema) from pygithub3.tests.utils.base import mock_json, DummyRequest diff --git a/pygithub3/tests/services/test_repos.py b/pygithub3/tests/services/test_repos.py index e11bef7..865c5df 100644 --- a/pygithub3/tests/services/test_repos.py +++ b/pygithub3/tests/services/test_repos.py @@ -6,7 +6,7 @@ from unittest import TestCase import requests from mock import patch, Mock -from pygithub3.services.repos import (Repo, Collaborators, Commits, Downloads, +from pygithub3.services.repos import (Repos, Collaborators, Commits, Downloads, Forks, Keys, Watchers) from pygithub3.resources.base import json from pygithub3.tests.utils.base import (mock_response, mock_response_result, @@ -21,7 +21,7 @@ json.loads = Mock(side_effect=mock_json) class TestRepoService(TestCase): def setUp(self): - self.rs = Repo() + self.rs = Repos() self.rs.set_user('octocat') self.rs.set_repo('octocat_repo') diff --git a/pygithub3/tests/utils/base.py b/pygithub3/tests/utils/base.py index d9049c9..49ea2b4 100644 --- a/pygithub3/tests/utils/base.py +++ b/pygithub3/tests/utils/base.py @@ -4,7 +4,7 @@ from mock import Mock from pygithub3.resources.base import Resource -from pygithub3.requests import Request +from pygithub3.requests.base import Request def mock_json(content): -- cgit v1.2.3-59-g8ed1b From 614ed5b2acf916b71803532e499df9068b6273bd Mon Sep 17 00:00:00 2001 From: David Medina Date: Thu, 1 Mar 2012 14:10:48 +0100 Subject: WIP on services.repos doc +services.repos.collaborators doc +services.repos.commits doc --- docs/repos.rst | 14 +++- docs/services.rst | 14 +++- pygithub3/services/repos/__init__.py | 8 +-- pygithub3/services/repos/collaborators.py | 50 +++++++++++++ pygithub3/services/repos/commits.py | 116 ++++++++++++++++++++++++++++-- 5 files changed, 190 insertions(+), 12 deletions(-) diff --git a/docs/repos.rst b/docs/repos.rst index 2a5bbe2..f42796f 100644 --- a/docs/repos.rst +++ b/docs/repos.rst @@ -82,6 +82,7 @@ Collaborators -------------- .. autoclass:: pygithub3.services.repos.Collaborators + :members: .. _Commits service: @@ -89,6 +90,7 @@ Commits ---------- .. autoclass:: pygithub3.services.repos.Commits + :members: .. _Downloads service: @@ -96,6 +98,7 @@ Downloads ------------ .. autoclass:: pygithub3.services.repos.Downloads + :members: .. _Forks service: @@ -104,6 +107,7 @@ Forks --------- .. autoclass:: pygithub3.services.repos.Forks + :members: .. _RepoKeys service: @@ -112,6 +116,7 @@ Keys ---------- .. autoclass:: pygithub3.services.repos.Keys + :members: .. _Watchers service: @@ -120,5 +125,12 @@ Watchers --------- .. autoclass:: pygithub3.services.repos.Watchers + :members: -.. _github repo doc: http://developer.github.com/v3/repos +.. _github repos doc: http://developer.github.com/v3/repos +.. _github collaborators doc: http://developer.github.com/v3/repos +.. _github commits doc: http://developer.github.com/v3/repos +.. _github downloads doc: http://developer.github.com/v3/repos +.. _github forks doc: http://developer.github.com/v3/repos +.. _github watching doc: http://developer.github.com/v3/repos +.. _github hooks doc: http://developer.github.com/v3/repos diff --git a/docs/services.rst b/docs/services.rst index 8611455..7dfec34 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -5,7 +5,7 @@ Services start Overview -.......... +---------- You can access to the API requests through the different services. @@ -28,7 +28,7 @@ from the rest**. .. _config each service: Config each service -..................................... +---------------------- Each service can be configurated with some variables (behind the scenes, each service has her client which is configurated with this variables). @@ -40,8 +40,16 @@ service has her client which is configurated with this variables). .. autoclass:: pygithub3.services.base.Service :members: +.. _mimetypes: + +MimeTypes +---------- + +.. autoclass:: pygithub3.services.base.MimeTypeMixin + :members: + List of services -.................. +------------------- .. toctree:: :maxdepth: 2 diff --git a/pygithub3/services/repos/__init__.py b/pygithub3/services/repos/__init__.py index 6e3627f..e1ed1d8 100644 --- a/pygithub3/services/repos/__init__.py +++ b/pygithub3/services/repos/__init__.py @@ -26,7 +26,7 @@ class Repos(Service): """ Get user's repositories :param str user: Username - :param str type: Filter by type (optional). See `github repo doc`_ + :param str type: Filter by type (optional). See `github repos doc`_ :returns: A :doc:`result` If you call it without user and you are authenticated, get the @@ -48,7 +48,7 @@ class Repos(Service): """ Get organization's repositories :param str org: Organization name - :param str type: Filter by type (optional). See `github repo doc`_ + :param str type: Filter by type (optional). See `github repos doc`_ :returns: A :doc:`result` :: @@ -61,7 +61,7 @@ class Repos(Service): def create(self, data, in_org=None): """ Create a new repository - :param dict data: Input. See `github repo doc`_ + :param dict data: Input. See `github repos doc`_ :param str in_org: Organization where create the repository (optional) .. warning:: @@ -96,7 +96,7 @@ class Repos(Service): def update(self, data, user=None, repo=None): """ Update a single repository - :param dict data: Input. See `github repo doc`_ + :param dict data: Input. See `github repos doc`_ :param str user: Username :param str repo: Repository diff --git a/pygithub3/services/repos/collaborators.py b/pygithub3/services/repos/collaborators.py index 3bc4c9d..5f0703a 100644 --- a/pygithub3/services/repos/collaborators.py +++ b/pygithub3/services/repos/collaborators.py @@ -5,23 +5,73 @@ from . import Service class Collaborators(Service): + """ Consume `Repo Collaborators API + `_ """ def list(self, user=None, repo=None): + """ Get repository's collaborators + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.collaborators.list', user=user, repo=repo) return self._get_result(request) def add(self, collaborator, user=None, repo=None): + """ Add collaborator to a repository + + :param str collaborator: Collaborator's username + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + .. warning:: + + You must be authenticated and have perms in repository + """ request = self.make_request('repos.collaborators.add', collaborator=collaborator, user=user, repo=repo) return self._put(request) def is_collaborator(self, collaborator, user=None, repo=None): + """ Check if a user is collaborator on repository + + :param str collaborator: Collaborator's username + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.collaborators.is_collaborator', collaborator=collaborator, user=user, repo=repo) return self._bool(request) def delete(self, collaborator, user=None, repo=None): + """ Remove collaborator from repository + + :param str collaborator: Collaborator's username + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + .. warning:: + + You must be authenticated and have perms in repository + """ request = self.make_request('repos.collaborators.delete', collaborator=collaborator, user=user, repo=repo) self._delete(request) diff --git a/pygithub3/services/repos/commits.py b/pygithub3/services/repos/commits.py index 3d5abb6..23e6842 100644 --- a/pygithub3/services/repos/commits.py +++ b/pygithub3/services/repos/commits.py @@ -5,44 +5,152 @@ from . import Service, MimeTypeMixin class Commits(Service, MimeTypeMixin): + """ Consume `Commits API + `_ - """ TODO: Pagination structure differs from usual - def list(self, user=None, repo=None, sha='', path=''): - request = self.make_request('repos.commits.list', user=user, repo=repo) - return self._get_result(request, sha=sha, path=path) + .. note:: + This service support :ref:`mimetypes` configuration """ + #TODO: Pagination structure differs from usual + #def list(self, user=None, repo=None, sha='', path=''): + #request = self.make_request('repos.commits.list', user=user, repo=repo) + #return self._get_result(request, sha=sha, path=path) + def get(self, sha, user=None, repo=None): + """ Get a single commit + + :param str sha: Commit's sha + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.commits.get', sha=sha, user=user, repo=repo) return self._get(request) def list_comments(self, sha=None, user=None, repo=None): + """ Get commit's comments + + :param str sha: Commit's sha + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + If you call it without ``sha``, get all commit's comments of a + repository + :: + + commits_service.list_comments('6dcb09', user='octocat', + repo='oct_repo') + commits_service.list_comments(user='octocat', repo='oct_repo') + """ request = self.make_request('repos.commits.list_comments', sha=sha, user=user, repo=repo) return self._get_result(request, **self._get_mimetype_as_header()) def create_comment(self, data, sha, user=None, repo=None): + """ Create a commit comment + + :param dict data: Input. See `github commits doc`_ + :param str sha: Commit's sha + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + :: + + data = { + "body": "Nice change", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "line": 1, + "path": "file1.txt", + "position": 4 + } + commits_service.create_comment(data, '6dcb09', user='octocat', + repo='oct_repo') + """ request = self.make_request('repos.commits.create_comment', sha=sha, user=user, repo=repo, body=data) return self._post(request, **self._get_mimetype_as_header()) def get_comment(self, cid, user=None, repo=None): + """ Get a single commit comment + + :param int cid: Commit comment id + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.commits.get_comment', comment_id=cid, user=user, repo=repo) return self._get(request, **self._get_mimetype_as_header()) def update_comment(self, data, cid, user=None, repo=None): + """ Update a single commit comment + + :param dict data: Input. See `github commits doc`_ + :param int cid: Commit comment id + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + :: + + commits_service.update_comment(dict(body='nice change'), 42, + user='octocat', repo='oct_repo') + """ request = self.make_request('repos.commits.update_comment', comment_id=cid, user=user, repo=repo, body=data) return self._patch(request, **self._get_mimetype_as_header()) def compare(self, base, head, user=None, repo=None): + """ Compare two commits + + :param str base: Base commit sha + :param str head: Head commit sha + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + :: + + commits_service.compare('6dcb09', 'master', user='octocat', + repo='oct_repo') + """ request = self.make_request('repos.commits.compare', base=base, head=head, user=user, repo=repo) return self._get(request) def delete_comment(self, cid, user=None, repo=None): + """ Delete a single commit comment + + :param int cid: Commit comment id + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + """ request = self.make_request('repos.commits.delete_comment', comment_id=cid, user=user, repo=repo) self._delete(request) -- cgit v1.2.3-59-g8ed1b From 5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8 Mon Sep 17 00:00:00 2001 From: David Medina Date: Thu, 1 Mar 2012 19:41:46 +0100 Subject: Complete services.repos doc Also add Mimetypes doc --- docs/index.rst | 2 +- docs/repos.rst | 21 ++++++---- docs/result.rst | 28 -------------- docs/services.rst | 9 ++++- pygithub3/core/result.py | 32 ++++++++++++++++ pygithub3/services/base.py | 20 +++++----- pygithub3/services/repos/__init__.py | 9 ----- pygithub3/services/repos/collaborators.py | 6 --- pygithub3/services/repos/commits.py | 14 +++---- pygithub3/services/repos/downloads.py | 58 +++++++++++++++++++++++++++- pygithub3/services/repos/forks.py | 37 +++++++++++++++++- pygithub3/services/repos/keys.py | 64 +++++++++++++++++++++++++++++++ pygithub3/services/repos/watchers.py | 60 +++++++++++++++++++++++++++++ pygithub3/services/users/__init__.py | 1 - pygithub3/services/users/emails.py | 2 - pygithub3/services/users/followers.py | 4 -- pygithub3/services/users/keys.py | 1 - 17 files changed, 289 insertions(+), 79 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 24561ca..71f377c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -38,7 +38,7 @@ You must apologize my English level. I'm trying to do my best installation github services - resources result + resources .. _Github API v3 documentation: http://developer.github.com diff --git a/docs/repos.rst b/docs/repos.rst index f42796f..2b58f32 100644 --- a/docs/repos.rst +++ b/docs/repos.rst @@ -22,7 +22,8 @@ Some request always need ``user`` and ``repo`` parameters, both, to identify a `repository`. Because there are a lot of requests which need that parameters, you can :ref:`config each service` with ``user`` and ``repo`` globally. -So several requests follow a simple precedence ``user_in_arg > user_in_config`` +So several requests follow a simple precedence +``user_in_arg > user_in_config | repo_in_arg > repo_in_config`` You can see it better with an example: :: @@ -127,10 +128,16 @@ Watchers .. autoclass:: pygithub3.services.repos.Watchers :members: +.. _Hooks service: + +Hooks +--------- + .. _github repos doc: http://developer.github.com/v3/repos -.. _github collaborators doc: http://developer.github.com/v3/repos -.. _github commits doc: http://developer.github.com/v3/repos -.. _github downloads doc: http://developer.github.com/v3/repos -.. _github forks doc: http://developer.github.com/v3/repos -.. _github watching doc: http://developer.github.com/v3/repos -.. _github hooks doc: http://developer.github.com/v3/repos +.. _github collaborators doc: http://developer.github.com/v3/repos/collaborators +.. _github commits doc: http://developer.github.com/v3/repos/commits +.. _github downloads doc: http://developer.github.com/v3/repos/downloads +.. _github forks doc: http://developer.github.com/v3/repos/forks +.. _github keys doc: http://developer.github.com/v3/repos/keys +.. _github watching doc: http://developer.github.com/v3/repos/watching +.. _github hooks doc: http://developer.github.com/v3/repos/hooks diff --git a/docs/result.rst b/docs/result.rst index 2162745..f084807 100644 --- a/docs/result.rst +++ b/docs/result.rst @@ -7,31 +7,3 @@ Some requests returns multiple :doc:`resources`, for that reason the .. autoclass:: pygithub3.core.result.Result -You have several ways to consume it - -1. Iterating over the result:: - - result = some_request() - for page in result: - for resource in page: - print resource - -2. With a generator:: - - result = some_request() - for resource in result.iterator(): - print resource - -3. As a list:: - - result = some_request() - print result.all() - -4. Also you can request some page manually - -.. autoattribute:: pygithub3.core.result.Result.pages -.. automethod:: pygithub3.core.result.Result.get_page - -Each ``Page`` is an iterator and contains resources - - diff --git a/docs/services.rst b/docs/services.rst index 7dfec34..a0fd894 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -40,11 +40,16 @@ service has her client which is configurated with this variables). .. autoclass:: pygithub3.services.base.Service :members: -.. _mimetypes: +.. _mimetypes-section: MimeTypes ---------- +Some services supports `mimetypes`_ + +With them the :doc:`resources` will have ``body``, ``body_text``, ``body_html`` +attributes or all of them. + .. autoclass:: pygithub3.services.base.MimeTypeMixin :members: @@ -56,3 +61,5 @@ List of services users repos + +.. _mimetypes: http://developer.github.com/v3/mime diff --git a/pygithub3/core/result.py b/pygithub3/core/result.py index 9e69e7d..5a2aa80 100644 --- a/pygithub3/core/result.py +++ b/pygithub3/core/result.py @@ -137,6 +137,38 @@ class Page(object): class Result(object): """ Result is a very lazy paginator. It only do a real request when is needed + + You have several ways to consume it + + #. Iterating over the result:: + + result = some_request() + for page in result: + for resource in page: + print resource + + #. With a generator:: + + result = some_request() + for resource in result.iterator(): + print resource + + #. As a list:: + + result = some_request() + print result.all() + + #. Also you can request some page manually + + .. autoattribute:: pygithub3.core.result.Result.pages + .. automethod:: pygithub3.core.result.Result.get_page + + Each ``Page`` is an iterator and contains resources:: + + result = some_request() + assert result.pages > 3 + page3 = result.get_page(3) + page3_resources = list(page3) """ def __init__(self, client, request, **kwargs): diff --git a/pygithub3/services/base.py b/pygithub3/services/base.py index 7fb6133..8602150 100644 --- a/pygithub3/services/base.py +++ b/pygithub3/services/base.py @@ -136,14 +136,9 @@ class Service(object): class MimeTypeMixin(object): """ - Mimetype support to Services that inherit this Mixin + Mimetype support to Services Adds 4 public functions to service: - - 1. set_raw_mimetype - 2. set_text_mimetype - 3. set_html_mimetype - 4. set_full_mimetype """ VERSION = 'beta' @@ -152,16 +147,21 @@ class MimeTypeMixin(object): self.mimetype = 'application/vnd.github.%s.%s+json' % ( self.VERSION, mimetype) - def set_raw_mimetype(self): + def set_raw(self): + """ Resource will have ``body`` attribute """ self.__set_mimetype('raw') - def set_text_mimetype(self): + def set_text(self): + """ Resource will have ``body_text`` attribute """ self.__set_mimetype('text') - def set_html_mimetype(self): + def set_html(self): + """ Resource will have ``body_html`` attribute """ self.__set_mimetype('html') - def set_full_mimetype(self): + def set_full(self): + """ Resource will have ``body`` ``body_text`` and ``body_html`` + attributes """ self.__set_mimetype('full') def _get_mimetype_as_header(self): diff --git a/pygithub3/services/repos/__init__.py b/pygithub3/services/repos/__init__.py index e1ed1d8..484dd49 100644 --- a/pygithub3/services/repos/__init__.py +++ b/pygithub3/services/repos/__init__.py @@ -33,7 +33,6 @@ class Repos(Service): authenticated user's repositories .. warning:: - If you aren't authenticated and call without user, it returns 403 :: @@ -87,7 +86,6 @@ class Repos(Service): :param str repo: Repository .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.get', user=user, repo=repo) @@ -101,11 +99,9 @@ class Repos(Service): :param str repo: Repository .. note:: - Remember :ref:`config precedence` .. warning:: - You must be authenticated :: @@ -130,7 +126,6 @@ class Repos(Service): :returns: A :doc:`result` .. note:: - Remember :ref:`config precedence` """ return self.__list_contributors(user, repo) @@ -148,7 +143,6 @@ class Repos(Service): :returns: A :doc:`result` .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.list_languages', @@ -163,7 +157,6 @@ class Repos(Service): :returns: A :doc:`result` .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.list_teams', user=user, repo=repo) @@ -177,7 +170,6 @@ class Repos(Service): :returns: A :doc:`result` .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.list_tags', user=user, repo=repo) @@ -191,7 +183,6 @@ class Repos(Service): :returns: A :doc:`result` .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.list_branches', diff --git a/pygithub3/services/repos/collaborators.py b/pygithub3/services/repos/collaborators.py index 5f0703a..f80a406 100644 --- a/pygithub3/services/repos/collaborators.py +++ b/pygithub3/services/repos/collaborators.py @@ -16,7 +16,6 @@ class Collaborators(Service): :returns: A :doc:`result` .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.collaborators.list', @@ -31,11 +30,9 @@ class Collaborators(Service): :param str repo: Repository .. note:: - Remember :ref:`config precedence` .. warning:: - You must be authenticated and have perms in repository """ request = self.make_request('repos.collaborators.add', @@ -50,7 +47,6 @@ class Collaborators(Service): :param str repo: Repository .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.collaborators.is_collaborator', @@ -65,11 +61,9 @@ class Collaborators(Service): :param str repo: Repository .. note:: - Remember :ref:`config precedence` .. warning:: - You must be authenticated and have perms in repository """ request = self.make_request('repos.collaborators.delete', diff --git a/pygithub3/services/repos/commits.py b/pygithub3/services/repos/commits.py index 23e6842..8eec3e7 100644 --- a/pygithub3/services/repos/commits.py +++ b/pygithub3/services/repos/commits.py @@ -25,7 +25,6 @@ class Commits(Service, MimeTypeMixin): :param str repo: Repository .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.commits.get', @@ -38,9 +37,9 @@ class Commits(Service, MimeTypeMixin): :param str sha: Commit's sha :param str user: Username :param str repo: Repository + :returns: A :doc:`result` .. note:: - Remember :ref:`config precedence` If you call it without ``sha``, get all commit's comments of a @@ -64,9 +63,11 @@ class Commits(Service, MimeTypeMixin): :param str repo: Repository .. note:: - Remember :ref:`config precedence` + .. warning:: + You must be authenticated + :: data = { @@ -91,7 +92,6 @@ class Commits(Service, MimeTypeMixin): :param str repo: Repository .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.commits.get_comment', @@ -107,9 +107,11 @@ class Commits(Service, MimeTypeMixin): :param str repo: Repository .. note:: - Remember :ref:`config precedence` + .. warning:: + You must be authenticated + :: commits_service.update_comment(dict(body='nice change'), 42, @@ -128,7 +130,6 @@ class Commits(Service, MimeTypeMixin): :param str repo: Repository .. note:: - Remember :ref:`config precedence` :: @@ -148,7 +149,6 @@ class Commits(Service, MimeTypeMixin): :param str repo: Repository .. note:: - Remember :ref:`config precedence` """ request = self.make_request('repos.commits.delete_comment', diff --git a/pygithub3/services/repos/downloads.py b/pygithub3/services/repos/downloads.py index c455021..47c7785 100644 --- a/pygithub3/services/repos/downloads.py +++ b/pygithub3/services/repos/downloads.py @@ -7,24 +7,71 @@ from . import Service class Downloads(Service): + """ Consume `Downloads API + `_ """ def list(self, user=None, repo=None): + """ Get repository's downloads + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.downloads.list', user=user, repo=repo) return self._get_result(request) def get(self, id, user=None, repo=None): + """ Get a single download + + :param int id: Download id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.downloads.get', id=id, user=user, repo=repo) return self._get(request) def create(self, data, user=None, repo=None): + """ Create a new download + + :param dict data: Input. See `github downloads doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + It is a two step process. After you create the download, you must + call the ``upload`` function of ``Download`` resource with + ``file_path`` + + .. warning:: + In `alpha` state + + :: + + # Step 1 + download = downloads_service.create( + dict(name='new_download', size=1130), + user='octocat', repo='oct_repo') + + # Step 2 + download.upload('/home/user/file.ext') + """ request = self.make_request('repos.downloads.create', body=data, user=user, repo=repo) download = self._post(request) # TODO: improve it. e.g Manage all with file desc def upload(file_path): + """ """ body = download.ball_to_upload() body['file'] = (file_path, open(file_path, 'rb')) return requests.post(download.s3_url, files=body) @@ -32,7 +79,16 @@ class Downloads(Service): download.upload = upload return download - def delete(self, id=id, user=None, repo=None): + def delete(self, id, user=None, repo=None): + """ Delete a download + + :param int id: Download id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.downloads.delete', id=id, user=user, repo=repo) self._delete(request) diff --git a/pygithub3/services/repos/forks.py b/pygithub3/services/repos/forks.py index 09f23c5..df51347 100644 --- a/pygithub3/services/repos/forks.py +++ b/pygithub3/services/repos/forks.py @@ -5,13 +5,48 @@ from . import Service class Forks(Service): + """ Consume `Forks API + `_ """ def list(self, user=None, repo=None, sort='newest'): + """ Get repository's forks + + :param str user: Username + :param str repo: Repository + :param str sort: Order resources (optional). See `github forks doc`_ + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + + :: + + forks_service.list(user='octocat', repo='oct_repo', sort='oldest') + """ request = self.make_request('repos.forks.list', user=user, repo=repo) return self._get_result(request, sort=sort) def create(self, user=None, repo=None, org=None): + """ Fork a repository + + :param str user: Username + :param str repo: Repository + :param str org: Organization name (optional) + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + + If you call it with ``org``, the repository will be forked into this + organization. + :: + + forks_service.create(user='octocat', repo='oct_repo') + forks_service.create(user='octocat', repo='oct_repo', + org='myorganization' + """ request = self.make_request('repos.forks.create', user=user, repo=repo) - #org = {'org': org} if org else {} org = org and {'org': org} or {} return self._post(request, **org) diff --git a/pygithub3/services/repos/keys.py b/pygithub3/services/repos/keys.py index 24a7cb3..1ade8a1 100644 --- a/pygithub3/services/repos/keys.py +++ b/pygithub3/services/repos/keys.py @@ -5,27 +5,91 @@ from . import Service class Keys(Service): + """ Consume `Deploy keys API + `_ """ def list(self, user=None, repo=None): + """ Get repository's keys + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.keys.list', user=user, repo=repo) return self._get_result(request) def get(self, id, user=None, repo=None): + """ Get a single repository key + + :param int id: Repository key id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.keys.get', id=id, user=user, repo=repo) return self._get(request) def create(self, data, user=None, repo=None): + """ Create a repository key + + :param dict data: Input. See `github keys doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated and have perms in the repository + + :: + + keys_service.create(dict(title='new key', key='ssh-rsa AAA...'), + user='octocat', repo='oct_repo') + """ request = self.make_request('repos.keys.create', body=data, user=user, repo=repo) return self._post(request) def update(self, id, data, user=None, repo=None): + """ Update a repository key + + :param int id: Repository key id + :param dict data: Input. See `github keys doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated and have perms in the repository + + :: + + keys_service.update(42, dict(title='new title'), + user='octocat', repo='oct_repo') + """ request = self.make_request('repos.keys.update', id=id, body=data, user=user, repo=repo) return self._patch(request) def delete(self, id, user=None, repo=None): + """ Delete a repository key + + :param int id: Repository key id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.keys.delete', id=id, user=user, repo=repo) self._delete(request) diff --git a/pygithub3/services/repos/watchers.py b/pygithub3/services/repos/watchers.py index 8598590..7bcede5 100644 --- a/pygithub3/services/repos/watchers.py +++ b/pygithub3/services/repos/watchers.py @@ -5,27 +5,87 @@ from . import Service class Watchers(Service): + """ Consume `Watching API + `_ """ def list(self, user=None, repo=None): + """ Get repository's watchers + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.watchers.list', user=user, repo=repo) return self._get_result(request) def list_repos(self, user=None): + """ Get repositories being watched by a user + + :param str user: Username + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + repositories being watched by the authenticated user. + + .. warning:: + If you aren't authenticated and call without user, it returns 403 + + :: + + watchers_service.list_repos('copitux') + watchers_service.list_repos() + """ request = self.make_request('repos.watchers.list_repos', user=user) return self._get_result(request) def is_watching(self, user=None, repo=None): + """ Check if authenticated user is watching a repository + + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + """ request = self.make_request('repos.watchers.is_watching', user=user, repo=repo) return self._bool(request) def watch(self, user=None, repo=None): + """ Watch a repository + + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + """ request = self.make_request('repos.watchers.watch', user=user, repo=repo) self._put(request) def unwatch(self, user=None, repo=None): + """ Stop watching a repository + + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + """ request = self.make_request('repos.watchers.unwatch', user=user, repo=repo) self._delete(request) diff --git a/pygithub3/services/users/__init__.py b/pygithub3/services/users/__init__.py index c448319..29a8e1c 100644 --- a/pygithub3/services/users/__init__.py +++ b/pygithub3/services/users/__init__.py @@ -25,7 +25,6 @@ class User(Service): authenticated user. .. warning:: - If you aren't authenticated and call without user, it returns 403 :: diff --git a/pygithub3/services/users/emails.py b/pygithub3/services/users/emails.py index 084a29c..09f6683 100644 --- a/pygithub3/services/users/emails.py +++ b/pygithub3/services/users/emails.py @@ -8,7 +8,6 @@ class Emails(Service): """ Consume `Emails API `_ .. warning:: - You must be authenticated for all requests """ @@ -26,7 +25,6 @@ class Emails(Service): :param list emails: Emails to add .. note:: - It rejects non-valid emails :: diff --git a/pygithub3/services/users/followers.py b/pygithub3/services/users/followers.py index d6969e2..5a8176d 100644 --- a/pygithub3/services/users/followers.py +++ b/pygithub3/services/users/followers.py @@ -19,7 +19,6 @@ class Followers(Service): authenticated user's followers .. warning:: - If you aren't authenticated and call without user, it returns 403 :: @@ -40,7 +39,6 @@ class Followers(Service): authenticated user's followings .. warning:: - If you aren't authenticated and call without user, it returns 403 :: @@ -65,7 +63,6 @@ class Followers(Service): :param str user: Username .. warning:: - You must be authenticated """ request = self.make_request('users.followers.follow', user=user) @@ -77,7 +74,6 @@ class Followers(Service): :param str user: Username .. warning:: - You must be authenticated """ request = self.make_request('users.followers.unfollow', user=user) diff --git a/pygithub3/services/users/keys.py b/pygithub3/services/users/keys.py index 996233c..2884881 100644 --- a/pygithub3/services/users/keys.py +++ b/pygithub3/services/users/keys.py @@ -8,7 +8,6 @@ class Keys(Service): """ Consume `Keys API `_ .. warning:: - You must be authenticated for all requests """ -- cgit v1.2.3-59-g8ed1b