diff --git a/LICENSE b/LICENSE index cea0adc..8ea4a12 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2018 Jeremy Lainé. +Copyright (c) Jeremy Lainé. All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/README.rst b/README.rst index a517ae5..075b6ae 100644 --- a/README.rst +++ b/README.rst @@ -1,28 +1,29 @@ pylibsrtp ========= -|rtd| |pypi-v| |pypi-pyversions| |pypi-l| |pypi-wheel| |tests| |codecov| +.. image:: https://img.shields.io/pypi/l/pylibsrtp.svg + :target: https://pypi.python.org/pypi/pylibsrtp + :alt: License -.. |rtd| image:: https://readthedocs.org/projects/pylibsrtp/badge/?version=latest - :target: https://pylibsrtp.readthedocs.io/ - -.. |pypi-v| image:: https://img.shields.io/pypi/v/pylibsrtp.svg - :target: https://pypi.python.org/pypi/pylibsrtp +.. image:: https://img.shields.io/pypi/v/pylibsrtp.svg + :target: https://pypi.python.org/pypi/pylibsrtp + :alt: Version -.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/pylibsrtp.svg - :target: https://pypi.python.org/pypi/pylibsrtp +.. image:: https://img.shields.io/pypi/pyversions/pylibsrtp.svg + :target: https://pypi.python.org/pypi/pylibsrtp + :alt: Python versions -.. |pypi-l| image:: https://img.shields.io/pypi/l/pylibsrtp.svg - :target: https://pypi.python.org/pypi/pylibsrtp +.. image:: https://github.com/aiortc/pylibsrtp/workflows/tests/badge.svg + :target: https://github.com/aiortc/pylibsrtp/actions + :alt: Tests -.. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/pylibsrtp.svg - :target: https://pypi.python.org/pypi/pylibsrtp +.. image:: https://img.shields.io/codecov/c/github/aiortc/pylibsrtp.svg + :target: https://codecov.io/gh/aiortc/pylibsrtp + :alt: Coverage -.. |tests| image:: https://github.com/aiortc/pylibsrtp/workflows/tests/badge.svg - :target: https://github.com/aiortc/pylibsrtp/actions - -.. |codecov| image:: https://img.shields.io/codecov/c/github/aiortc/pylibsrtp.svg - :target: https://codecov.io/gh/aiortc/pylibsrtp +.. image:: https://readthedocs.org/projects/pylibsrtp/badge/?version=latest + :target: https://pylibsrtp.readthedocs.io/ + :alt: Documentation What is ``pylibsrtp``? ---------------------- diff --git a/docs/conf.py b/docs/conf.py index 7641979..e1538d5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,31 +1,17 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- +# Configuration file for the Sphinx documentation builder. # -# pylibsrtp documentation build configuration file, created by -# sphinx-quickstart on Thu Feb 8 17:22:14 2018. -# -# 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. +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -import os -import sys +# -- Project information ----------------------------------------------------- -# 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.insert(0, os.path.abspath("..")) +project = "pylibsrtp" +author = "Jeremy Lainé" +copyright = author -# -- General configuration ------------------------------------------------ -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' +# -- General configuration ------------------------------------------------ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -35,46 +21,12 @@ # Add any paths that contain templates here, relative to this directory. 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" - -# The master toctree document. -master_doc = "index" - -# General information about the project. -project = "pylibsrtp" -copyright = "2018, Jeremy Lainé" -author = "Jeremy Lainé" - -# 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 = "" -# The full version, including alpha/beta/rc tags. -release = "" - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -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"] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False +language = "en" # -- Options for HTML output ---------------------------------------------- @@ -89,6 +41,7 @@ # documentation. # html_theme_options = { + "description": "Python wrapper around the libsrtp library.", "github_button": True, "github_user": "aiortc", "github_repo": "pylibsrtp", @@ -110,59 +63,3 @@ "searchbox.html", ] } - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = "pylibsrtpdoc" - - -# -- 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': '', - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, "pylibsrtp.tex", "pylibsrtp Documentation", "Jeremy Lainé", "manual"), -] - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "pylibsrtp", "pylibsrtp Documentation", [author], 1)] - - -# -- 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 = [ - ( - master_doc, - "pylibsrtp", - "pylibsrtp Documentation", - author, - "pylibsrtp", - "One line description of project.", - "Miscellaneous", - ), -] diff --git a/docs/index.rst b/docs/index.rst index 97c969f..05fc068 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,25 +1,25 @@ pylibsrtp ========= -|pypi-v| |pypi-pyversions| |pypi-l| |pypi-wheel| |tests| |codecov| +.. image:: https://img.shields.io/pypi/l/pylibsrtp.svg + :target: https://pypi.python.org/pypi/pylibsrtp + :alt: License -.. |pypi-v| image:: https://img.shields.io/pypi/v/pylibsrtp.svg - :target: https://pypi.python.org/pypi/pylibsrtp +.. image:: https://img.shields.io/pypi/v/pylibsrtp.svg + :target: https://pypi.python.org/pypi/pylibsrtp + :alt: Version -.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/pylibsrtp.svg - :target: https://pypi.python.org/pypi/pylibsrtp +.. image:: https://img.shields.io/pypi/pyversions/pylibsrtp.svg + :target: https://pypi.python.org/pypi/pylibsrtp + :alt: Python versions -.. |pypi-l| image:: https://img.shields.io/pypi/l/pylibsrtp.svg - :target: https://pypi.python.org/pypi/pylibsrtp +.. image:: https://github.com/aiortc/pylibsrtp/workflows/tests/badge.svg + :target: https://github.com/aiortc/pylibsrtp/actions + :alt: Tests -.. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/pylibsrtp.svg - :target: https://pypi.python.org/pypi/pylibsrtp - -.. |tests| image:: https://github.com/aiortc/pylibsrtp/workflows/tests/badge.svg - :target: https://github.com/aiortc/pylibsrtp/actions - -.. |codecov| image:: https://img.shields.io/codecov/c/github/aiortc/pylibsrtp.svg - :target: https://codecov.io/gh/aiortc/pylibsrtp +.. image:: https://img.shields.io/codecov/c/github/aiortc/pylibsrtp.svg + :target: https://codecov.io/gh/aiortc/pylibsrtp + :alt: Coverage ``pylibsrtp`` is a Python wrapper around `libsrtp`_, making it possible to encrypt and decrypt Secure Real-time Transport Protocol (SRTP) packets from