Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pysimone committed Jul 23, 2023
1 parent af87ce6 commit 5d6909f
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 19 deletions.
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,50 @@
# PySigVi
Simple Gui to verify file signatures with GPG - The GNU Privacy Guard
Simple Gui to verify file signatures with GPG - The GNU Privacy Guard.

PySigVi is a GUI (Graphical User Interface) for [GNU Privacy Guard GPG](https://gnupg.org/)
PySigVi is a GUI (Graphical User Interface) for [GNU Privacy Guard GPG](https://gnupg.org/).

It checks the detached signatures of a file.

Under the hood it repeat:

`gpg --verify detached_signature file_to_verify`
*gpg --verify detached_signature file_to_verify*

for each detached signature.

PySigVi does not create the signatures! It only checks the existing ones created with some other software.

## Installation
**For windows user:**

+ download the [latest release](https://github.com/pysimone/PySigVi/releases/latest) of *pysigvi-installer.exe*
+ run *pysigvi-installer.exe* to install PySigVi in your system
+ launch PySigVi from the menu of Windows or double-clicking the icon in the
desktop

or

+ download the [latest release](https://github.com/pysimone/PySigVi/releases/latest) of *pysigvi.exe*
+ execute *pysigvi.exe* to run PySigVi without installing it in your system

**For linux user:**

+ download the [latest release](https://github.com/pysimone/PySigVi/releases/latest) of *pysigvi*
+ execute *sudo install ./pysigvi /usr/bin/* to install PySigVi in your system
+ execute *pysigvi* ro run PySigVi

or

+ make *pysigvi* executable with *chmod a+x pysigvi*
+ execute *./pysigvi* to launch PySigVi without installing it in your system

##Usage (fast version)##

![Screen Shot](screen_shot.png)

+ Click the button with the three dots.
+ Select the file you want to verify the signatures.
+ Click "Add Signatures".
+ Select the signatures.
+ Click on "Check Signatures" to verify the signature of the file.
+ Look at the "Check" field.
+ If everything is green the file is correctly signed!
2 changes: 1 addition & 1 deletion docs/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ <h1 style="text-align: center;">About PySigVi</h1>
<h2>Description</h2>
<p>Simple Gui to verify file signatures with <a href="https://gnupg.org/">GPG</a> - The GNU Privacy Guard.</p>
<h2>Version</h2>
<p>version: 0.1</p>
<p>version: 1.0.2</p>
<p>year: 2023</p>
<h2>Author</h2>
<p>Simone B.</p>
Expand Down
30 changes: 27 additions & 3 deletions docs/license.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,32 @@ <h2>GNU General Public License v3.0</h2>
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.</p>

<p>You should have received a copy of the GNU General Public License
along with this program.
If not, see <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.</p>
along with this program. If not, see <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.</p>

<h2>Attribution 3.0 Unported (CC BY 3.0) </h2>

<p>Images and icons are released with</p>

<p><a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons CC BY 3.0 License.</a></p>

<p>You are free to:</p>

<p>Share — copy and redistribute the material in any medium or format<br>
Adapt — remix, transform, and build upon the material for any purpose, even commercially.</p>

<p>This license is acceptable for Free Cultural Works.</p>

<p>The licensor cannot revoke these freedoms as long as you follow the license terms.</p>

<p>Under the following terms:</p>

<p>Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made.
You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.</p>

<p>No additional restrictions — You may not apply legal terms or technological measures that legally restrict others
from doing anything the license permits.</p>

</body>
</html>
</html>
13 changes: 2 additions & 11 deletions docs/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ <h1>PySigVi Manual</h1>

<h2>In a hurry? Read This!</h2>
<ul>
<li>Click on the button with the three dots.</li>
<li>Click the button with the three dots.</li>
<li>Select the file you want to verify the signatures.</li>
<li>Click "Add Signatures".</li>
<li>Select the signatures.</li>
Expand All @@ -18,7 +18,7 @@ <h2>In a hurry? Read This!</h2>
<li>If everything is green the file is correctly signed!</li>
</ul>

<h2 id="Index">Index</h2>
<h2 id="Index">Long Version Index</h2>
<ul>
<li><a href="#Introduction">Introduction</a></li>
<li><a href="#Prerequisites">Prerequisites</a></li>
Expand Down Expand Up @@ -72,19 +72,10 @@ <h3>For python users</h3>
<p><a href="#Index">Index</a></p>
<h3>For Windows User</h3>
<p>If not already installed, download and install <a href="https://gnupg.org/">GPG</a>.</p>
<h4>without the installer</h4>
<p>Download the latest executable pysigvi.exe</p>
<p>from this url: <a href="https://github.com/pysimone/PySigVi/releases/latest">
https://github.com/pysimone/PySigVi/releases/latest</a> .</p>
<p>Double click on pysigvi.exe to run the script.</p>
<h4>with the installer</h4>
<p>If you want to install PySigVi in your system</p>
<p>download the latest installer pysigvi-installer.exe</p>
<p>from this url: <a href="https://github.com/pysimone/PySigVi/releases/latest">
https://github.com/pysimone/PySigVi/releases/latest</a> .</p>
<p>Double click on the installer and follow the instructions.</p>
<p>If everything works fine you can find PySigVi icon on your desktop and in the menu.</p>
<p></p>
<p><a href="#Index">Index</a></p>
<h3>For Linux User</h3>
<p>If not already installed, install <a href="https://gnupg.org/">GPG</a>:</p>
Expand Down
2 changes: 1 addition & 1 deletion pysigvi.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def __init__(self, parent=None):
class MainWindow(QMainWindow):
def __init__(self):
super().__init__()
self.setWindowTitle('Signatures Verify') # Main Window
self.setWindowTitle('PySigVi - Signatures Verify') # Main Window
self.setMinimumSize(QSize(640, 480))
# Labels
file_label = QLabel('File to verify: ') # File to verify
Expand Down
Binary file added screen_shot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5d6909f

Please sign in to comment.