Skip to content

Commit

Permalink
docs: add v0.0.2 changelog entry
Browse files Browse the repository at this point in the history
Generate docs.
  • Loading branch information
cofiem committed Oct 1, 2022
1 parent 1fa42a0 commit d482144
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 37 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## [v0.0.2](https://github.com/anotherbyte-net/gather-vision/compare/v0.0.1...v0.0.2)

*unreleased*
- Added WebData base class
- Changed CI to run via tox and not release to PyPI

## [v0.0.1](https://github.com/anotherbyte-net/gather-vision/commits/v0.0.1)

Expand Down
1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ Test the installed package.
gather-vision --version
gather-vision --help
gather-vision list
gather-vision show name
gather-vision update name
```

Expand Down
14 changes: 7 additions & 7 deletions docs/gather_vision/app.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h1 class="title">Module <code>gather_vision.app</code></h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/app.py#L1-L89" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/app.py#L1-L89" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;The main application features.&#34;&#34;&#34;
import typing
Expand Down Expand Up @@ -136,7 +136,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/app.py#L9-L89" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/app.py#L9-L89" class="git-link">Browse git</a>
</summary>
<pre><code class="python">class App:
&#34;&#34;&#34;The main application.&#34;&#34;&#34;
Expand Down Expand Up @@ -247,7 +247,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/app.py#L17-L25" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/app.py#L17-L25" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def collect(self) -&gt; EntryPoints:
&#34;&#34;&#34;Collect the available plugins.
Expand Down Expand Up @@ -275,7 +275,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/app.py#L38-L55" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/app.py#L38-L55" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def get(self, name: str) -&gt; typing.Optional[plugin.Entry]:
&#34;&#34;&#34;Get the class for a plugin.
Expand Down Expand Up @@ -312,7 +312,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/app.py#L74-L89" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/app.py#L74-L89" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def list(self, args: model.ListArgs) -&gt; model.ListResult:
&#34;&#34;&#34;List all available plugins.
Expand Down Expand Up @@ -342,7 +342,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/app.py#L27-L36" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/app.py#L27-L36" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def load(self) -&gt; typing.Dict[str, plugin.Entry]:
&#34;&#34;&#34;Load the plugin class for each plugin.
Expand Down Expand Up @@ -371,7 +371,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/app.py#L57-L72" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/app.py#L57-L72" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def update(self, args: model.UpdateArgs) -&gt; model.UpdateResult:
&#34;&#34;&#34;Execute the update action for the plugin with the given name.
Expand Down
8 changes: 4 additions & 4 deletions docs/gather_vision/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h1 class="title">Module <code>gather_vision.cli</code></h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/cli.py#L1-L156" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/cli.py#L1-L156" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;Command line for gather vision.&#34;&#34;&#34;

Expand Down Expand Up @@ -208,7 +208,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/cli.py#L30-L52" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/cli.py#L30-L52" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def cli_list(
args: argparse.Namespace, # noqa: U100 pylint: disable=unused-argument
Expand Down Expand Up @@ -250,7 +250,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/cli.py#L11-L27" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/cli.py#L11-L27" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def cli_update(args: argparse.Namespace) -&gt; bool:
&#34;&#34;&#34;Run the update action from the cli.
Expand Down Expand Up @@ -289,7 +289,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/cli.py#L55-L152" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/cli.py#L55-L152" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def main(args: typing.Optional[typing.List[str]] = None) -&gt; int:
&#34;&#34;&#34;Run as a command line program.
Expand Down
7 changes: 5 additions & 2 deletions docs/gather_vision/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@ <h2 id="install">Install</h2>
<a href="https://github.com/anotherbyte-net/gather-vision/actions"><img alt="GitHub Workflow Status (branch)" src="https://img.shields.io/github/workflow/status/anotherbyte-net/gather-vision/Test%20Package/main"></a></p>
<h1 id="change-log">Change log</h1>
<h2 id="v002"><a href="https://github.com/anotherbyte-net/gather-vision/compare/v0.0.1...v0.0.2">v0.0.2</a></h2>
<p><em>unreleased</em></p>
<ul>
<li>Added WebData base class</li>
<li>Changed CI to run via tox and not release to PyPI</li>
</ul>
<h2 id="v001"><a href="https://github.com/anotherbyte-net/gather-vision/commits/v0.0.1">v0.0.1</a></h2>
<ul>
<li>Created initial plugin implementation using <a href="https://setuptools.pypa.io/en/latest/userguide/entry_point.html#entry-points-for-plugins">entry points</a></li>
Expand All @@ -44,7 +47,7 @@ <h2 id="v001"><a href="https://github.com/anotherbyte-net/gather-vision/commits/
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/__init__.py#L1-L5" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/__init__.py#L1-L5" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;Documentation for the gather vision package.

Expand Down
20 changes: 10 additions & 10 deletions docs/gather_vision/model.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h1 class="title">Module <code>gather_vision.model</code></h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L1-L109" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L1-L109" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;Models used by other modules.&#34;&#34;&#34;
import abc
Expand Down Expand Up @@ -157,7 +157,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L77-L82" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L77-L82" class="git-link">Browse git</a>
</summary>
<pre><code class="python">class IsDataclass(typing_extensions.Protocol):
&#34;&#34;&#34;Allows specifying type to be any dataclass.&#34;&#34;&#34;
Expand All @@ -181,7 +181,7 @@ <h3>Ancestors</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L26-L34" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L26-L34" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@dataclasses.dataclass
class ListArgs:
Expand Down Expand Up @@ -214,7 +214,7 @@ <h3>Class variables</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L37-L42" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L37-L42" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@dataclasses.dataclass
class ListResult:
Expand All @@ -240,7 +240,7 @@ <h3>Class variables</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L10-L18" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L10-L18" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@dataclasses.dataclass
class UpdateArgs:
Expand Down Expand Up @@ -272,7 +272,7 @@ <h3>Class variables</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L21-L23" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L21-L23" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@dataclasses.dataclass
class UpdateResult:
Expand All @@ -287,7 +287,7 @@ <h3>Class variables</h3>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L85-L109" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L85-L109" class="git-link">Browse git</a>
</summary>
<pre><code class="python">class WebData(abc.ABC):
&#34;&#34;&#34;A class that retrieves web data and converts it into more urls and/or items.&#34;&#34;&#34;
Expand Down Expand Up @@ -331,7 +331,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L88-L95" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L88-L95" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@abc.abstractmethod
def initial_urls(self) -&gt; typing.Iterable[str]:
Expand All @@ -358,7 +358,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L97-L109" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L97-L109" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@abc.abstractmethod
def parse_response(
Expand Down Expand Up @@ -386,7 +386,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/model.py#L45-L74" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/model.py#L45-L74" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@dataclasses.dataclass
class WebDataAvailable:
Expand Down
8 changes: 4 additions & 4 deletions docs/gather_vision/plugin.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h1 class="title">Module <code>gather_vision.plugin</code></h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/plugin.py#L1-L35" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/plugin.py#L1-L35" class="git-link">Browse git</a>
</summary>
<pre><code class="python">&#34;&#34;&#34;Available to plugins.&#34;&#34;&#34;
import abc
Expand Down Expand Up @@ -83,7 +83,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/plugin.py#L7-L35" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/plugin.py#L7-L35" class="git-link">Browse git</a>
</summary>
<pre><code class="python">class Entry(abc.ABC):
&#34;&#34;&#34;The entry point class for plugins.
Expand Down Expand Up @@ -136,7 +136,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/plugin.py#L25-L35" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/plugin.py#L25-L35" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@abc.abstractmethod
def list(self, args: model.ListArgs) -&gt; model.ListResult: # noqa: U100
Expand Down Expand Up @@ -166,7 +166,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/7d45e6f120950d15af3632387da1d30ceaea2a32/src/gather_vision/plugin.py#L13-L23" class="git-link">Browse git</a>
<a href="https://github.com/anotherbyte-net/gather-vision/blob/1fa42a08998ca33b6c39300ff984a7b27297bc1d/src/gather_vision/plugin.py#L13-L23" class="git-link">Browse git</a>
</summary>
<pre><code class="python">@abc.abstractmethod
def update(self, args: model.UpdateArgs) -&gt; model.UpdateResult: # noqa: U100
Expand Down
Loading

1 comment on commit d482144

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/gather_vision
   app.py38976%35, 48, 52–53, 71–72, 86–88
   cli.py671578%27, 49–51, 65, 122, 131–132, 138, 144, 149–152, 156
   model.py42295%95, 109
   plugin.py9278%23, 35
   utils.py351654%23, 30–33, 38–40, 49–60
TOTAL1914477% 

Tests Skipped Failures Errors Time
7 0 💤 0 ❌ 0 🔥 0.285s ⏱️

Please sign in to comment.