Skip to content
Snippets Groups Projects
Unverified Commit 99995460 authored by Georg Krause's avatar Georg Krause
Browse files

Change package names

parent 52c58e1b
No related branches found
No related tags found
No related merge requests found
requests-http-signature: A Requests auth module for HTTP Signature
requests-http-message-signatures: A Requests auth module for HTTP Signature
==================================================================
**requests-http-signature** is a `Requests <https://github.com/requests/requests>`_ `authentication plugin
**requests-http-message-signatures** is a `Requests <https://github.com/requests/requests>`_ `authentication plugin
<http://docs.python-requests.org/en/master/user/authentication/>`_ (``requests.auth.AuthBase`` subclass) implementing
the `IETF HTTP Signatures draft RFC <https://tools.ietf.org/html/draft-richanna-http-message-signatures>`_. It has no
required dependencies outside the standard library. If you wish to use algorithms other than HMAC (namely, RSA and
......@@ -11,7 +11,7 @@ Installation
------------
::
$ pip install requests-http-signature
$ pip install requests-http-message-signatures
Usage
-----
......@@ -58,7 +58,8 @@ Links
-----
* `IETF HTTP Signatures draft <https://tools.ietf.org/html/draft-richanna-http-message-signatures>`_
* https://github.com/joyent/node-http-signature
* `Project home page (GitHub) <https://github.com/kislyuk/requests-http-signature>`_
* `Project home page (GitHub)
<https://dev.funkwhale.audio/funkwhale/requests-http-message-signatures>`_
* `Documentation (Read the Docs) <https://requests-http-signature.readthedocs.io/en/latest/>`_
* `Package distribution (PyPI) <https://pypi.python.org/pypi/requests-http-signature>`_
* `Change log <https://github.com/kislyuk/requests-http-signature/blob/master/Changes.rst>`_
......
......@@ -30,35 +30,33 @@
# 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.viewcode',
'sphinx.ext.githubpages']
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.githubpages"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General information about the project.
project = u'requests-http-signature'
copyright = u'2017, Andrey Kislyuk'
author = u'Andrey Kislyuk'
project = "requests-http-message-signatures"
copyright = "2017, Andrey Kislyuk"
author = "Andrey Kislyuk"
# 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 = u''
version = ""
# The full version, including alpha/beta/rc tags.
release = u''
release = ""
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -70,10 +68,10 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
......@@ -84,7 +82,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = "alabaster"
# 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
......@@ -95,13 +93,13 @@ html_theme = 'alabaster'
# 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']
html_static_path = ["_static"]
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'requests-http-signaturedoc'
htmlhelp_basename = "requests-http-signaturedoc"
# -- Options for LaTeX output ---------------------------------------------
......@@ -110,15 +108,12 @@ 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': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
......@@ -128,8 +123,13 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'requests-http-signature.tex', u'requests-http-signature Documentation',
u'Andrey Kislyuk', 'manual'),
(
master_doc,
"requests-http-signature.tex",
"requests-http-signature Documentation",
"Andrey Kislyuk",
"manual",
),
]
......@@ -138,8 +138,13 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'requests-http-signature', u'requests-http-signature Documentation',
[author], 1)
(
master_doc,
"requests-http-signature",
"requests-http-signature Documentation",
[author],
1,
)
]
......@@ -149,10 +154,13 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'requests-http-signature', u'requests-http-signature Documentation',
author, 'requests-http-signature', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"requests-http-signature",
"requests-http-signature Documentation",
author,
"requests-http-signature",
"One line description of project.",
"Miscellaneous",
),
]
......@@ -3,7 +3,7 @@
API documentation
=================
.. automodule:: requests_http_signature
.. automodule:: requests_http_message_signatures
:members:
:special-members:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment