Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacotsu committed Apr 12, 2020
1 parent 9897d54 commit ad3f862
Show file tree
Hide file tree
Showing 64 changed files with 13,575 additions and 1,347 deletions.
21 changes: 18 additions & 3 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
Changelog
=========

0.6.1 (2020-)
0.7.0 (2020-04-13)
------------------
New
~~~
- Added MAC OS installation instructions to README [DCDRJ]
- Added support for MAC OS Catalina [DCDRJ]
- Added more startup options [DCDRJ]

- `--sync-on-startup`: lets you override your settings file, and sync
the course files on application startup
- `--sync-interval`: lets you override your settings file sync frequency
- Added built in backup certificate to mitigate malformed beep ones [DCDRJ]

Fix
~~~
- Added missing dependency to setup.py [DCDRJ]
- Added missing dependencies to setup.py [DCDRJ]
- Minor UI improvements [DCDRJ]
- Minor code cleanup [DCDRJ]
- Increased info logging [DCDRJ]
- Fixed bug that hid some logging messages [DCDRJ]
- Added a default file version (0) to manage files that have None [DCDRJ]
- Added exception handling for invalid uuids [DCDRJ]
- Renewed copyright year in documentation [DCDRJ]
- Changed default professor name separator from `/` to `;` [DCDRJ]
- Updated documentation [DCDRJ]

0.6.0 (2020-03-10)
------------------
Expand Down
36 changes: 27 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,8 @@ open the downloaded file and follow the installer instructions.

MAC OS
------
::

pip3 install --user polibeepsync
echo 'export PATH=/Library/Frameworks/Python.framework/Versions/3.7/bin:$PATH' >>.bashrc

Riaprire il terminale ed avviare *PoliBeePsync* con il comando
::

polibeepsync-gui
Download the .app.zip file from the `latest release <https://github.com/Jacotsu/polibeepsync/releases/latest>`_ and then
drag it from the Downloads to Applications.


Manual
Expand All @@ -89,6 +82,31 @@ Manual
Changelog
=========

0.7.0 (2020-04-13)
------------------
New
~~~
- Added support for MAC OS Catalina [DCDRJ]
- Added more startup options [DCDRJ]

- `--sync-on-startup`: lets you override your settings file, and sync
the course files on application startup
- `--sync-interval`: lets you override your settings file sync frequency
- Added built in backup certificate to mitigate malformed beep ones [DCDRJ]

Fix
~~~
- Added missing dependencies to setup.py [DCDRJ]
- Minor UI improvements [DCDRJ]
- Minor code cleanup [DCDRJ]
- Increased info logging [DCDRJ]
- Fixed bug that hid some logging messages [DCDRJ]
- Added a default file version (0) to manage files that have None [DCDRJ]
- Added exception handling for invalid uuids [DCDRJ]
- Renewed copyright year in documentation [DCDRJ]
- Changed default professor name separator from `/` to `;` [DCDRJ]
- Updated documentation [DCDRJ]

0.6.1 (2020-)
------------------
New
Expand Down
9 changes: 8 additions & 1 deletion TODO.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## To Do


- [ ] Use qsettings for gui status persistency

- [ ] Fix interface hanging when downloading a lot of files
Expand All @@ -19,7 +20,13 @@

- [ ] Update docs to explain new command line options

- [ ] Try to package for Mac Os
- [ ] Docs version autoupdate

- [ ] Write tests for invalid returned file dictionaries

- ~~[ ] Bypass BeeP's login api and use directly unicalogin (not possible without serious patching)~~

- [X] Try to package for Mac Os

- [X] Write Tests

Expand Down
Binary file modified docs/build/doctrees/debug.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/developing.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/installation.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/modules.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/polibeepsync.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/quickstart.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 48e3095bf711b5dc6e90d1b99d7913b6
config: 6463dd90ee08595f02f68d122dfe6099
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/build/html/_images/mac_installed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/build/html/_images/mac_installing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/build/html/_images/mac_uninstall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/build/html/_images/pbs-courses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/build/html/_images/pbs-general.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions docs/build/html/_modules/index.html
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Overview: module code &#8212; PoliBeePsync 0.4.4 documentation</title>
<title>Overview: module code &#8212; PoliBeePsync 0.7.0 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />

Expand Down Expand Up @@ -78,7 +78,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<script>$('#searchbox').show(0);</script>



Expand All @@ -93,10 +93,10 @@ <h3 id="searchlabel">Quick search</h3>
</div>

<div class="footer">
&copy;2019, Davide Olianas, Raffaele Di Campli.
&copy;2020, Davide Olianas, Raffaele Di Campli.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.1.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>
Expand Down
77 changes: 56 additions & 21 deletions docs/build/html/_modules/polibeepsync/cmdlineparser.html
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<html lang="en">
<head>
<meta charset="utf-8" />
<title>polibeepsync.cmdlineparser &#8212; PoliBeePsync 0.4.4 documentation</title>
<title>polibeepsync.cmdlineparser &#8212; PoliBeePsync 0.7.0 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />

Expand All @@ -31,7 +31,39 @@
<div class="body" role="main">

<h1>Source code for polibeepsync.cmdlineparser</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">argparse</span>
<span></span><span class="n">__copyright__</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;Copyright 2020 Davide Olianas ([email protected]), Di</span>
<span class="s2">Campli Raffaele ([email protected]).&quot;&quot;&quot;</span>

<span class="n">__license__</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;This f is part of poliBeePsync.</span>
<span class="s2">poliBeePsync is free software: you can redistribute it and/or modify</span>
<span class="s2">it under the terms of the GNU General Public License as published by</span>
<span class="s2">the Free Software Foundation, either version 3 of the License, or</span>
<span class="s2">any later version.</span>

<span class="s2">poliBeePsync is distributed in the hope that it will be useful,</span>
<span class="s2">but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="s2">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="s2">GNU General Public License for more details.</span>

<span class="s2">You should have received a copy of the GNU General Public License</span>
<span class="s2">along with poliBeePsync. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<span class="s2">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">argparse</span>

<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Thanks</span>
<span class="sd">https://stackoverflow.com/questions/14117415/in-python-using-argparse-allow</span>
<span class="sd">-only-positive-integers</span>
<span class="sd">&quot;&quot;&quot;</span>


<div class="viewcode-block" id="check_positive"><a class="viewcode-back" href="../../polibeepsync.html#polibeepsync.cmdlineparser.check_positive">[docs]</a><span class="k">def</span> <span class="nf">check_positive</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="n">ivalue</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ivalue</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentTypeError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">: 0 and negative numbers are not allowed&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ivalue</span></div>


<div class="viewcode-block" id="create_parser"><a class="viewcode-back" href="../../polibeepsync.html#polibeepsync.cmdlineparser.create_parser">[docs]</a><span class="k">def</span> <span class="nf">create_parser</span><span class="p">():</span>
Expand All @@ -41,22 +73,25 @@ <h1>Source code for polibeepsync.cmdlineparser</h1><div class="highlight"><pre>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--hidden&#39;</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s1">&#39;store_true&#39;</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">&quot;Don&#39;t show the main window, just the icon&quot;</span>
<span class="s2">&quot; in the system tray&quot;</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--debug&#39;</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s1">&#39;store&#39;</span><span class="p">,</span> <span class="n">choices</span><span class="o">=</span><span class="n">debug_levels</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">&quot;Show debug information.&quot;</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--log-level&#39;</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s1">&#39;store&#39;</span><span class="p">,</span> <span class="n">choices</span><span class="o">=</span><span class="n">debug_levels</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">&#39;Choose logging report verbosity&#39;</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;-s&#39;</span><span class="p">,</span> <span class="s1">&#39;--use_theme&#39;</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s1">&#39;store_true&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">&quot;Choose Qt theme over gtk&quot;</span><span class="p">)</span>

<span class="k">return</span> <span class="n">parser</span></div>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
<span class="s1">&#39;--sync-interval&#39;</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="n">check_positive</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s1">&#39;store&#39;</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">&#39;[Non persistent override] Choose how often (in minutes) the &#39;</span>
<span class="s1">&#39;courses files should be synced&#39;</span><span class="p">)</span>

<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
<span class="s1">&#39;--sync-on-startup&#39;</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s1">&#39;store_true&#39;</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">&#39;[Non persistent override] Synces the courses files on startup&#39;</span><span class="p">)</span>

<div class="viewcode-block" id="main"><a class="viewcode-back" href="../../polibeepsync.html#polibeepsync.cmdlineparser.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
<span class="n">parser</span> <span class="o">=</span> <span class="n">create_parser</span><span class="p">()</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="n">args</span><span class="p">)</span></div>

<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
<span class="n">main</span><span class="p">()</span>
<span class="k">return</span> <span class="n">parser</span></div>
</pre></div>

</div>
Expand Down Expand Up @@ -99,7 +134,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<script>$('#searchbox').show(0);</script>



Expand All @@ -114,10 +149,10 @@ <h3 id="searchlabel">Quick search</h3>
</div>

<div class="footer">
&copy;2019, Davide Olianas, Raffaele Di Campli.
&copy;2020, Davide Olianas, Raffaele Di Campli.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.1.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>
Expand Down
Loading

0 comments on commit ad3f862

Please sign in to comment.