From 5e5108e99aebe73c619b1e4cc14c6ffef6ec9670 Mon Sep 17 00:00:00 2001 From: "Kacper Kowalik (Xarthisius)" Date: Thu, 29 Jan 2026 10:39:40 -0600 Subject: [PATCH] Migrate docs to .md --- .readthedocs.yaml | 6 +- AUTHORS.rst | 13 --- HISTORY.rst | 8 -- README.md | 112 ++++++++++++++++++++++ README.rst | 114 ---------------------- docs/authors.md | 9 ++ docs/authors.rst | 1 - docs/conf.py | 7 +- CONTRIBUTING.rst => docs/contributing.md | 115 ++++++++++------------- docs/contributing.rst | 1 - docs/history.md | 5 + docs/history.rst | 1 - docs/index.md | 15 +++ docs/index.rst | 19 ---- docs/installation.md | 49 ++++++++++ docs/installation.rst | 51 ---------- docs/readme.md | 2 + docs/readme.rst | 1 - docs/requirements.txt | 3 + docs/usage.md | 7 ++ docs/usage.rst | 7 -- 21 files changed, 261 insertions(+), 285 deletions(-) delete mode 100644 AUTHORS.rst delete mode 100644 HISTORY.rst create mode 100644 README.md delete mode 100644 README.rst create mode 100644 docs/authors.md delete mode 100644 docs/authors.rst rename CONTRIBUTING.rst => docs/contributing.md (50%) delete mode 100644 docs/contributing.rst create mode 100644 docs/history.md delete mode 100644 docs/history.rst create mode 100644 docs/index.md delete mode 100644 docs/index.rst create mode 100644 docs/installation.md delete mode 100644 docs/installation.rst create mode 100644 docs/readme.md delete mode 100644 docs/readme.rst create mode 100644 docs/requirements.txt create mode 100644 docs/usage.md delete mode 100644 docs/usage.rst diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f72c324..22cfb7e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -17,6 +17,6 @@ sphinx: # Optionally, but recommended, # declare the Python requirements required to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - requirements: docs/requirements.txt diff --git a/AUTHORS.rst b/AUTHORS.rst deleted file mode 100644 index ac6edb2..0000000 --- a/AUTHORS.rst +++ /dev/null @@ -1,13 +0,0 @@ -======= -Credits -======= - -Development Lead ----------------- - -* Kacper Kowalik - -Contributors ------------- - -None yet. Why not be the first? diff --git a/HISTORY.rst b/HISTORY.rst deleted file mode 100644 index fd4df6a..0000000 --- a/HISTORY.rst +++ /dev/null @@ -1,8 +0,0 @@ -======= -History -======= - -0.1.0 (2024-02-29) ------------------- - -* First release on PyPI. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e2e861f --- /dev/null +++ b/README.md @@ -0,0 +1,112 @@ +# Transparent Research Object utils + +[![PyPI version](https://img.shields.io/pypi/v/tro_utils.svg)](https://pypi.python.org/pypi/tro-utils) +[![Zenodo](https://zenodo.org/badge/765298086.svg)](https://zenodo.org/doi/10.5281/zenodo.11130420) +[![Documentation Status](https://readthedocs.org/projects/tro-utils/badge/?version=latest)](https://tro-utils.readthedocs.io/en/latest/?version=latest) + +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. + +2. **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. + +3. **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. + +## Installation + +### Pre-requisites +Before you begin, you need to have the following installed on your system: + +- GPG +- OpenSSL +- Python 3.8+ + +You can do this by running the following commands: + +```bash +$ sudo apt-get install gnupg openssl python3 python3-pip # on Debian/Ubuntu +$ brew install gnupg openssl python3 # on macOS with Homebrew +``` + +## 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: + +```bash +$ 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](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template. diff --git a/README.rst b/README.rst deleted file mode 100644 index 4f0f611..0000000 --- a/README.rst +++ /dev/null @@ -1,114 +0,0 @@ -================================= -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 `_. - -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 diff --git a/docs/authors.md b/docs/authors.md new file mode 100644 index 0000000..d7f8e15 --- /dev/null +++ b/docs/authors.md @@ -0,0 +1,9 @@ +# Credits + +## Development Lead + +* Kacper Kowalik + +## Contributors + +None yet. Why not be the first? diff --git a/docs/authors.rst b/docs/authors.rst deleted file mode 100644 index e122f91..0000000 --- a/docs/authors.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../AUTHORS.rst diff --git a/docs/conf.py b/docs/conf.py index 3051a4f..8257b0d 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,7 @@ # 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'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'myst_parser'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -40,7 +40,10 @@ # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} # The master toctree document. master_doc = 'index' diff --git a/CONTRIBUTING.rst b/docs/contributing.md similarity index 50% rename from CONTRIBUTING.rst rename to docs/contributing.md index 9fad30b..f798ed4 100644 --- a/CONTRIBUTING.rst +++ b/docs/contributing.md @@ -1,19 +1,12 @@ -.. highlight:: shell +# Contributing -============ -Contributing -============ - -Contributions are welcome, and they are greatly appreciated! Every little bit -helps, and credit will always be given. +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 ----------------------- +## Types of Contributions -Report Bugs -~~~~~~~~~~~ +### Report Bugs Report bugs at https://github.com/Xarthisius/tro_utils/issues. @@ -23,27 +16,19 @@ If you are reporting a bug, please include: * Any details about your local setup that might be helpful in troubleshooting. * Detailed steps to reproduce the bug. -Fix Bugs -~~~~~~~~ +### Fix Bugs -Look through the GitHub issues for bugs. Anything tagged with "bug" and "help -wanted" is open to whoever wants to implement it. +Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it. -Implement Features -~~~~~~~~~~~~~~~~~~ +### Implement Features -Look through the GitHub issues for features. Anything tagged with "enhancement" -and "help wanted" is open to whoever wants to implement it. +Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it. -Write Documentation -~~~~~~~~~~~~~~~~~~~ +### 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. +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 -~~~~~~~~~~~~~~~ +### Submit Feedback The best way to send feedback is to file an issue at https://github.com/Xarthisius/tro_utils/issues. @@ -51,78 +36,80 @@ 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 :) +* Remember that this is a volunteer-driven project, and that contributions are welcome :) -Get Started! ------------- +## 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 +2. Clone your fork locally: + + ```bash + $ 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:: +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 + ```bash + $ mkvirtualenv tro_utils + $ cd tro_utils/ + $ python setup.py develop + ``` -4. Create a branch for local development:: +4. Create a branch for local development: - $ git checkout -b name-of-your-bugfix-or-feature + ```bash + $ 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:: +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 + ```bash + $ 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:: +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 + ```bash + $ 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 ------------------------ +## 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. +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.md. +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 ----- +## Tips -To run a subset of tests:: +To run a subset of tests: +```bash $ pytest tests.test_tro_utils +``` +## Deploying -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:: +A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.md). Then run: +```bash $ bump2version patch # possible: major / minor / patch $ git push $ git push --tags +``` Travis will then deploy to PyPI if tests pass. diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index e582053..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CONTRIBUTING.rst diff --git a/docs/history.md b/docs/history.md new file mode 100644 index 0000000..618addd --- /dev/null +++ b/docs/history.md @@ -0,0 +1,5 @@ +# History + +## 0.1.0 (2024-02-29) + +* First release on PyPI. diff --git a/docs/history.rst b/docs/history.rst deleted file mode 100644 index 2506499..0000000 --- a/docs/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../HISTORY.rst diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..fdad746 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,15 @@ +# Welcome to Transparent Research Object utils's documentation! + +## Contents + +- [Installation](installation.md) +- [Usage](usage.md) +- [Contributing](contributing.md) +- [Authors](authors.md) +- [History](history.md) + +## Indices and tables + +* Index +* Module Index +* Search diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index a4a673a..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -Welcome to Transparent Research Object utils's documentation! -============================================================= - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - readme - installation - usage - contributing - authors - history - -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..830b66c --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,49 @@ +# Installation + +## Pre-requisites +Before you begin, you need to have the following installed on your system: + +- GPG +- OpenSSL +- Python 3.8+ + +You can do this by running the following commands: + +```bash +$ sudo apt-get install gnupg openssl python3 python3-pip # on Debian/Ubuntu +$ brew install gnupg openssl python3 # on macOS with Homebrew +``` + +## Stable release + +To install Transparent Research Object utils, run this command in your terminal: + +```console +$ pip install tro_utils +``` + +This is the preferred method to install Transparent Research Object utils, as it will always install the most recent stable release. + +If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process. + +## From sources + +The sources for Transparent Research Object utils can be downloaded from the [Github repo](https://github.com/Xarthisius/tro_utils). + +You can either clone the public repository: + +```console +$ git clone git://github.com/Xarthisius/tro_utils +``` + +Or download the [tarball](https://github.com/Xarthisius/tro_utils/tarball/master): + +```console +$ curl -OJL https://github.com/Xarthisius/tro_utils/tarball/master +``` + +Once you have a copy of the source, you can install it with: + +```console +$ python setup.py install +``` diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index ddc6838..0000000 --- a/docs/installation.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. highlight:: shell - -============ -Installation -============ - - -Stable release --------------- - -To install Transparent Research Object utils, run this command in your terminal: - -.. code-block:: console - - $ pip install tro_utils - -This is the preferred method to install Transparent Research Object utils, as it will always install the most recent stable release. - -If you don't have `pip`_ installed, this `Python installation guide`_ can guide -you through the process. - -.. _pip: https://pip.pypa.io -.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ - - -From sources ------------- - -The sources for Transparent Research Object utils can be downloaded from the `Github repo`_. - -You can either clone the public repository: - -.. code-block:: console - - $ git clone git://github.com/Xarthisius/tro_utils - -Or download the `tarball`_: - -.. code-block:: console - - $ curl -OJL https://github.com/Xarthisius/tro_utils/tarball/master - -Once you have a copy of the source, you can install it with: - -.. code-block:: console - - $ python setup.py install - - -.. _Github repo: https://github.com/Xarthisius/tro_utils -.. _tarball: https://github.com/Xarthisius/tro_utils/tarball/master diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 0000000..8997d46 --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,2 @@ + +See [README.md](../README.md) diff --git a/docs/readme.rst b/docs/readme.rst deleted file mode 100644 index 72a3355..0000000 --- a/docs/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..d568200 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx +myst_parser +alabaster diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..0465f17 --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,7 @@ +# Usage + +To use Transparent Research Object utils in a project: + +```python +import tro_utils +``` diff --git a/docs/usage.rst b/docs/usage.rst deleted file mode 100644 index 1ace5cc..0000000 --- a/docs/usage.rst +++ /dev/null @@ -1,7 +0,0 @@ -===== -Usage -===== - -To use Transparent Research Object utils in a project:: - - import tro_utils