tro-utils 0.1.3__tar.gz

tro_utils-0.1.3/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Kacper Kowalik <xarthisius.kk@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

tro_utils-0.1.3/CONTRIBUTING.rst

@@ -0,0 +1,128 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/Xarthisius/tro_utils/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Transparent Research Object utils could always use more documentation, whether as part of the
+official Transparent Research Object utils docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/Xarthisius/tro_utils/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `tro_utils` for local development.
+
+1. Fork the `tro_utils` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/tro_utils.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv tro_utils
+    $ cd tro_utils/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ flake8 tro_utils tests
+    $ python setup.py test or pytest
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
+   https://travis-ci.com/Xarthisius/tro_utils/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ pytest tests.test_tro_utils
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.

tro_utils-0.1.3/HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2024-02-29)
+------------------
+
+* First release on PyPI.

tro_utils-0.1.3/LICENSE

@@ -0,0 +1,32 @@
+
+
+BSD License
+
+Copyright (c) 2024, Kacper Kowalik
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
+

tro_utils-0.1.3/MANIFEST.in

@@ -0,0 +1,11 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

tro_utils-0.1.3/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: tro-utils
+Version: 0.1.3
+Summary: Utilities for creating, editing and interacting with TROs
+Author-email: Kacper Kowalik <xarthisius.kk@gmail.com>, Craig Willis <willis8@illinois.edu>
+Maintainer-email: Kacper Kowalik <xarthisius.kk@gmail.com>
+License: 
+        
+        BSD License
+        
+        Copyright (c) 2024, Kacper Kowalik
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without modification,
+        are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        * Redistributions in binary form must reproduce the above copyright notice, this
+          list of conditions and the following disclaimer in the documentation and/or
+          other materials provided with the distribution.
+        
+        * Neither the name of the copyright holder nor the names of its
+          contributors may be used to endorse or promote products derived from this
+          software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+        IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+        INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+        BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+        OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+        OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+        OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+        
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: Click>=7.0
+Requires-Dist: jinja2
+Requires-Dist: requests
+Requires-Dist: python-gnupg
+Requires-Dist: python-magic
+Requires-Dist: rfc3161ng
+Requires-Dist: graphviz
+Requires-Dist: rich
+Provides-Extra: test
+Requires-Dist: pytest>=6.2.4; extra == "test"
+Requires-Dist: pytest-cov>=7.0.0; extra == "test"
+Requires-Dist: coverage>=7.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=6.2.4; extra == "dev"
+Requires-Dist: pytest-cov>=7.0.0; extra == "dev"
+Requires-Dist: coverage>=7.0; extra == "dev"
+Requires-Dist: bump2version>=0.5.11; extra == "dev"
+Requires-Dist: wheel>=0.33.6; extra == "dev"
+Requires-Dist: watchdog>=0.9.0; extra == "dev"
+Requires-Dist: flake8>=3.7.8; extra == "dev"
+Requires-Dist: tox>=3.14.0; extra == "dev"
+Requires-Dist: Sphinx>=1.8.5; extra == "dev"
+Requires-Dist: twine>=1.14.0; extra == "dev"
+Dynamic: license-file
+
+=================================
+Transparent Research Object utils
+=================================
+
+.. image:: https://img.shields.io/pypi/v/tro_utils.svg
+        :target: https://pypi.python.org/pypi/tro-utils
+
+.. image:: https://zenodo.org/badge/765298086.svg
+        :target: https://zenodo.org/doi/10.5281/zenodo.11130420
+
+.. image:: https://readthedocs.org/projects/tro-utils/badge/?version=latest
+        :target: https://tro-utils.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+This package provides a set of utilities for working with Transparent Research Objects (TROs). It is designed to be used in
+conjunction with the `TRO specification <https://transparency-certified.github.io/trace-specification/docs/specifications/tro/0.1/index.html>`_.
+
+It uses the ``Click`` library to define commands and options. Here's a summary of the main features:
+
+1. **Global Options**: The script defines several global options that can be used with any command,
+   such as ``--declaration``, ``--profile``, ``--gpg-fingerprint``, ``--gpg-passphrase``, ``--tro-creator``,
+   ``--tro-name``, and ``--tro-description``. These options can be used to specify various parameters for the TRO.
+
+1. **Commands**: The script defines several commands, each with its own set of options and arguments. The commands include:
+
+   - ``verify``: Verifies that the TRO is signed and timestamped correctly.
+
+   - ``arrangement``: Manages arrangements in the TRO. It has subcommands like ``add`` (adds a directory as a composition to the TRO)
+     and ``list`` (lists available arrangements in the TRO).
+
+   - ``composition``: Manages compositions in the TRO. It has a subcommand ``info`` that gets info about the current composition.
+
+   - ``performance``: Manages performances in the TRO. It has a subcommand ``add`` that adds a performance to the TRO.
+
+   - ``sign``: Signs the TRO.
+
+   - ``report``: Generates a report of the TRO.
+
+1. **TRO Interaction**: The script interacts with the TRO using the ``TRO`` class from the ``tro_utils`` module.
+   It uses this class to create a new TRO, add arrangements and performances to the TRO, verify the TRO,
+   and generate a report of the TRO.
+
+Example Usage
+-------------
+
+Assumes that:
+
+* this package is installed
+* your GPG key is present
+* ``trs.jsonld`` is available and defines TRS capabilities (see below for an example)
+
+Example workflow::
+
+   $ cd /tmp
+   $ cat trs.jsonld
+     {
+       "rdfs:comment": "TRS that can monitor netowork accesses or provide Internet isolation",
+       "trov:hasCapability": [
+         {
+           "@id": "trs/capability/1",
+           "@type": "trov:CanRecordInternetAccess"
+         },
+         {
+           "@id": "trs/capability/2",
+           "@type": "trov:CanProvideInternetIsolation"
+         }
+       ],
+       "trov:owner": "Kacper Kowalik",
+       "trov:description": "My local system",
+       "trov:contact": "root@dev.null",
+       "trov:url": "http://127.0.0.1/",
+       "trov:name": "shakuras"
+     }
+   $ export GPG_FINGERPRINT=...
+   $ export GPG_PASSPHRASE=...
+   $ git clone https://github.com/transparency-certified/sample-trace-workflow /tmp/sample
+   # It's sufficient to pass the profile only once
+   $ tro-utils --declaration sample_tro.jsonld --profile trs.jsonld arrangement add /tmp/sample \
+       -m "Before executing workflow" -i .git
+     Loading profile from trs.jsonld
+   $ tro-utils --declaration sample_tro.jsonld arrangement list
+     Arrangement(id=arrangement/0): Before executing workflow
+   $ pushd /tmp/sample && \
+     docker build -t xarthisius/sample . && \
+     ./run_locally.sh latest xarthisius && \
+     popd
+   $ tro-utils --declaration sample_tro.jsonld arrangement add /tmp/sample \
+       -m "After executing workflow" -i .git
+   $ tro-utils --declaration sample_tro.jsonld arrangement list
+     Arrangement(id=arrangement/0): Before executing workflow
+     Arrangement(id=arrangement/1): After executing workflow
+   $ tro-utils --declaration sample_tro.jsonld performance add \
+     -m "My magic workflow" \
+     -s 2024-03-01T09:22:01 \
+     -e 2024-03-02T10:00:11 \
+     -c trov:InternetIsolation \
+     -c trov:InternetAccessRecording \
+     -a arrangement/0 \
+     -M arrangement/1
+    $ tro-utils --declaration sample_tro.jsonld sign
+    $ tro-utils --declaration sample_tro.jsonld verify
+      ...
+      Verification: OK
+    $ curl -LO https://raw.githubusercontent.com/craig-willis/trace-report/main/templates/tro.md.jinja2
+    $ tro-utils --declaration sample_tro.jsonld report --template tro.md.jinja2 -o report.md
+
+
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

tro_utils-0.1.3/README.rst

@@ -0,0 +1,114 @@
+=================================
+Transparent Research Object utils
+=================================
+
+.. image:: https://img.shields.io/pypi/v/tro_utils.svg
+        :target: https://pypi.python.org/pypi/tro-utils
+
+.. image:: https://zenodo.org/badge/765298086.svg
+        :target: https://zenodo.org/doi/10.5281/zenodo.11130420
+
+.. image:: https://readthedocs.org/projects/tro-utils/badge/?version=latest
+        :target: https://tro-utils.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+This package provides a set of utilities for working with Transparent Research Objects (TROs). It is designed to be used in
+conjunction with the `TRO specification <https://transparency-certified.github.io/trace-specification/docs/specifications/tro/0.1/index.html>`_.
+
+It uses the ``Click`` library to define commands and options. Here's a summary of the main features:
+
+1. **Global Options**: The script defines several global options that can be used with any command,
+   such as ``--declaration``, ``--profile``, ``--gpg-fingerprint``, ``--gpg-passphrase``, ``--tro-creator``,
+   ``--tro-name``, and ``--tro-description``. These options can be used to specify various parameters for the TRO.
+
+1. **Commands**: The script defines several commands, each with its own set of options and arguments. The commands include:
+
+   - ``verify``: Verifies that the TRO is signed and timestamped correctly.
+
+   - ``arrangement``: Manages arrangements in the TRO. It has subcommands like ``add`` (adds a directory as a composition to the TRO)
+     and ``list`` (lists available arrangements in the TRO).
+
+   - ``composition``: Manages compositions in the TRO. It has a subcommand ``info`` that gets info about the current composition.
+
+   - ``performance``: Manages performances in the TRO. It has a subcommand ``add`` that adds a performance to the TRO.
+
+   - ``sign``: Signs the TRO.
+
+   - ``report``: Generates a report of the TRO.
+
+1. **TRO Interaction**: The script interacts with the TRO using the ``TRO`` class from the ``tro_utils`` module.
+   It uses this class to create a new TRO, add arrangements and performances to the TRO, verify the TRO,
+   and generate a report of the TRO.
+
+Example Usage
+-------------
+
+Assumes that:
+
+* this package is installed
+* your GPG key is present
+* ``trs.jsonld`` is available and defines TRS capabilities (see below for an example)
+
+Example workflow::
+
+   $ cd /tmp
+   $ cat trs.jsonld
+     {
+       "rdfs:comment": "TRS that can monitor netowork accesses or provide Internet isolation",
+       "trov:hasCapability": [
+         {
+           "@id": "trs/capability/1",
+           "@type": "trov:CanRecordInternetAccess"
+         },
+         {
+           "@id": "trs/capability/2",
+           "@type": "trov:CanProvideInternetIsolation"
+         }
+       ],
+       "trov:owner": "Kacper Kowalik",
+       "trov:description": "My local system",
+       "trov:contact": "root@dev.null",
+       "trov:url": "http://127.0.0.1/",
+       "trov:name": "shakuras"
+     }
+   $ export GPG_FINGERPRINT=...
+   $ export GPG_PASSPHRASE=...
+   $ git clone https://github.com/transparency-certified/sample-trace-workflow /tmp/sample
+   # It's sufficient to pass the profile only once
+   $ tro-utils --declaration sample_tro.jsonld --profile trs.jsonld arrangement add /tmp/sample \
+       -m "Before executing workflow" -i .git
+     Loading profile from trs.jsonld
+   $ tro-utils --declaration sample_tro.jsonld arrangement list
+     Arrangement(id=arrangement/0): Before executing workflow
+   $ pushd /tmp/sample && \
+     docker build -t xarthisius/sample . && \
+     ./run_locally.sh latest xarthisius && \
+     popd
+   $ tro-utils --declaration sample_tro.jsonld arrangement add /tmp/sample \
+       -m "After executing workflow" -i .git
+   $ tro-utils --declaration sample_tro.jsonld arrangement list
+     Arrangement(id=arrangement/0): Before executing workflow
+     Arrangement(id=arrangement/1): After executing workflow
+   $ tro-utils --declaration sample_tro.jsonld performance add \
+     -m "My magic workflow" \
+     -s 2024-03-01T09:22:01 \
+     -e 2024-03-02T10:00:11 \
+     -c trov:InternetIsolation \
+     -c trov:InternetAccessRecording \
+     -a arrangement/0 \
+     -M arrangement/1
+    $ tro-utils --declaration sample_tro.jsonld sign
+    $ tro-utils --declaration sample_tro.jsonld verify
+      ...
+      Verification: OK
+    $ curl -LO https://raw.githubusercontent.com/craig-willis/trace-report/main/templates/tro.md.jinja2
+    $ tro-utils --declaration sample_tro.jsonld report --template tro.md.jinja2 -o report.md
+
+
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

tro_utils-0.1.3/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = tro_utils
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

tro_utils-0.1.3/docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst

tro_utils-0.1.3/docs/conf.py

@@ -0,0 +1,162 @@
+#!/usr/bin/env python
+#
+# tro_utils documentation build configuration file, created by
+# sphinx-quickstart on Fri Jun  9 13:47:02 2017.
+#
+# 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.
+
+# 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.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+import tro_utils
+
+# -- 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.viewcode']
+
+# 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 = 'Transparent Research Object utils'
+copyright = "2024, Kacper Kowalik"
+author = "Kacper Kowalik"
+
+# 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 = tro_utils.__version__
+# The full version, including alpha/beta/rc tags.
+release = tro_utils.__version__
+
+# 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
+
+
+# -- 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 = '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
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+
+# -- Options for HTMLHelp output ---------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'tro_utilsdoc'
+
+
+# -- 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, 'tro_utils.tex',
+     'Transparent Research Object utils Documentation',
+     'Kacper Kowalik', '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, 'tro_utils',
+     'Transparent Research Object utils 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, 'tro_utils',
+     'Transparent Research Object utils Documentation',
+     author,
+     'tro_utils',
+     'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

tro_utils-0.1.3/docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst