Skip to content

Commit

Permalink
Restructure submodules and rename them to avoid conflict
Browse files Browse the repository at this point in the history
Add more test cases and add pypi_upload.sh for local builds
  • Loading branch information
dormant-user committed Jan 10, 2023
1 parent fc9203a commit 9a4c51c
Show file tree
Hide file tree
Showing 20 changed files with 125 additions and 81 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ notify(title="Test title", message="Test message")
### Optional arguments
- **icon:** Custom icon to be used for `Linux` and `Windows` operating systems.
- Linux: Choose any [pre-defined icons](https://wiki.ubuntu.com/Artwork/BreatheIconSet/Icons) or a `.png` file as icon.
- Windows: Choose any `.ico` file as icon. Defaults to [notification.ico](https://github.com/thevickypedia/pynotification/tree/main/notifier/notification.ico)
- Windows: Choose any `.ico` file as icon. Defaults to [notification.ico](https://github.com/thevickypedia/pynotification/tree/main/pynotification/notification.ico)
- **destroy:** Boolean value to destroy the notification box on `Windows` operating system after notifying.
- **debug:** Display logs in the form of `info`, `warnings` and `errors` messages.
- **logger:** Bring your own [`Logger`](https://docs.python.org/3/library/logging.html#logging.Logger) for custom logging.
Expand Down
11 changes: 4 additions & 7 deletions doc_gen/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,15 @@ Welcome to pynotification's documentation!
README


--------PyNotification--------
==============================

Notify
======
.. automodule:: notifier.notify
PyNotification
==============
.. automodule:: pynotification.pynotifier
:members:
:undoc-members:

Module
======
.. automodule:: notifier.mod
.. automodule:: pynotification.mod
:members:
:undoc-members:

Expand Down
2 changes: 1 addition & 1 deletion docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h2>Optional arguments<a class="headerlink" href="#optional-arguments" title="Pe
<li><p><strong>icon:</strong> Custom icon to be used for <code class="docutils literal notranslate"><span class="pre">Linux</span></code> and <code class="docutils literal notranslate"><span class="pre">Windows</span></code> operating systems.</p>
<ul>
<li><p>Linux: Choose any <a class="reference external" href="https://wiki.ubuntu.com/Artwork/BreatheIconSet/Icons">pre-defined icons</a> or a <code class="docutils literal notranslate"><span class="pre">.png</span></code> file as icon.</p></li>
<li><p>Windows: Choose any <code class="docutils literal notranslate"><span class="pre">.ico</span></code> file as icon. Defaults to <a class="reference external" href="https://github.com/thevickypedia/pynotification/tree/main/notifier/notification.ico">notification.ico</a></p></li>
<li><p>Windows: Choose any <code class="docutils literal notranslate"><span class="pre">.ico</span></code> file as icon. Defaults to <a class="reference external" href="https://github.com/thevickypedia/pynotification/tree/main/pynotification/notification.ico">notification.ico</a></p></li>
</ul>
</li>
<li><p><strong>destroy:</strong> Boolean value to destroy the notification box on <code class="docutils literal notranslate"><span class="pre">Windows</span></code> operating system after notifying.</p></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ notify(title="Test title", message="Test message")
### Optional arguments
- **icon:** Custom icon to be used for `Linux` and `Windows` operating systems.
- Linux: Choose any [pre-defined icons](https://wiki.ubuntu.com/Artwork/BreatheIconSet/Icons) or a `.png` file as icon.
- Windows: Choose any `.ico` file as icon. Defaults to [notification.ico](https://github.com/thevickypedia/pynotification/tree/main/notifier/notification.ico)
- Windows: Choose any `.ico` file as icon. Defaults to [notification.ico](https://github.com/thevickypedia/pynotification/tree/main/pynotification/notification.ico)
- **destroy:** Boolean value to destroy the notification box on `Windows` operating system after notifying.
- **debug:** Display logs in the form of `info`, `warnings` and `errors` messages.
- **logger:** Bring your own [`Logger`](https://docs.python.org/3/library/logging.html#logging.Logger) for custom logging.
Expand Down
11 changes: 4 additions & 7 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,15 @@ Welcome to pynotification's documentation!
README


--------PyNotification--------
==============================

Notify
======
.. automodule:: notifier.notify
PyNotification
==============
.. automodule:: pynotification.pynotifier
:members:
:undoc-members:

Module
======
.. automodule:: notifier.mod
.. automodule:: pynotification.mod
:members:
:undoc-members:

Expand Down
47 changes: 26 additions & 21 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,15 @@ <h1 id="index">Index</h1>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#O"><strong>O</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#W"><strong>W</strong></a>

</div>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#notifier.notify.default_logger">default_logger() (in module notifier.notify)</a>
<li><a href="index.html#pynotification.pynotifier.default_logger">default_logger() (in module pynotification.pynotifier)</a>
</li>
</ul></td>
</tr></table>
Expand All @@ -64,9 +65,9 @@ <h2 id="M">M</h2>
module

<ul>
<li><a href="index.html#module-notifier.mod">notifier.mod</a>
<li><a href="index.html#module-pynotification.mod">pynotification.mod</a>
</li>
<li><a href="index.html#module-notifier.notify">notifier.notify</a>
<li><a href="index.html#module-pynotification.pynotifier">pynotification.pynotifier</a>
</li>
</ul></li>
</ul></td>
Expand All @@ -75,51 +76,55 @@ <h2 id="M">M</h2>
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
notifier.mod
<li><a href="index.html#pynotification.mod.WindowsBalloonTip.notify">notify() (pynotification.mod.WindowsBalloonTip method)</a>
</li>
</ul></td>
</tr></table>

<ul>
<li><a href="index.html#module-notifier.mod">module</a>
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#pynotification.mod.WindowsBalloonTip.on_destroy">on_destroy() (pynotification.mod.WindowsBalloonTip method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
notifier.notify
pynotification.mod

<ul>
<li><a href="index.html#module-notifier.notify">module</a>
<li><a href="index.html#module-pynotification.mod">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#notifier.notify.notify">notify() (in module notifier.notify)</a>
<li>
pynotification.pynotifier

<ul>
<li><a href="index.html#notifier.mod.WindowsBalloonTip.notify">(notifier.mod.WindowsBalloonTip method)</a>
<li><a href="index.html#module-pynotification.pynotifier">module</a>
</li>
</ul></li>
</ul></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#notifier.mod.WindowsBalloonTip.on_destroy">on_destroy() (notifier.mod.WindowsBalloonTip method)</a>
<li><a href="index.html#pynotification.pynotifier.pynotifier">pynotifier() (in module pynotification.pynotifier)</a>
</li>
</ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#notifier.mod.WindowsBalloonTip.run">run() (notifier.mod.WindowsBalloonTip method)</a>
<li><a href="index.html#pynotification.mod.WindowsBalloonTip.run">run() (pynotification.mod.WindowsBalloonTip method)</a>
</li>
</ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#notifier.mod.WindowsBalloonTip">WindowsBalloonTip (class in notifier.mod)</a>
<li><a href="index.html#pynotification.mod.WindowsBalloonTip">WindowsBalloonTip (class in pynotification.mod)</a>
</li>
</ul></td>
</tr></table>
Expand Down
Loading

0 comments on commit 9a4c51c

Please sign in to comment.