Skip to content
Snippets Groups Projects
Commit b8a0203a authored by Moul's avatar Moul
Browse files

Proofread/rewrite deathreaper doc (#433/#443) 

Introduce DeathReaper logo
parent 7047a99e
No related branches found
No related tags found
1 merge request!271Set up new website structure with MkDocs (#433)
Hide whitespace changes
Inline Side-by-side
docs/deathreaper.md
+ 15
− 10
View file @ b8a0203a
# DeathReaper # DeathReaper
DeathReaper is a service reporting WoT exclusions on Discourse forums. <center>
![DeathReaper logo](images/deathreaper_logo.svg)
</center>
DeathReaper is a service reporting Web of Trust exclusions on [Discourse forums](https://www.discourse.org/).
Images are created containing Silkaj + DeathReaper. Images are created containing Silkaj + DeathReaper.
These images are operated on https://git.duniter.org/clients/python/deathreaper repository with schedule pipeline. These images are operated on [DeathReaper repository](https://git.duniter.org/clients/python/deathreaper) with pipeline schedules.
### Installation ### Installation
When installing Silkaj, you have to specify `pydiscourse` extra in order to get DeathReaper dependency `pydiscourse` which will "activate" the command/feature. When installing Silkaj, you have to specify the optional [extra](https://peps.python.org/pep-0508/#extras) `deathreaper` distribution in order to get DeathReaper’s dependency [`pydiscourse`](https://pypi.org/project/pydiscourse/) installed.
It will therefore "activate" the feature, and `silkaj wot exclusions` command will become available.
```sh ```sh
pipx install silkaj[deathreaper] pipx install silkaj[deathreaper]
``` ```
If you are running the development environment with Poetry: With Poetry development environment:
```sh ```sh
poetry install --extras deathreaper poetry install --extras deathreaper
...@@ -20,13 +25,13 @@ poetry install --extras deathreaper ...@@ -20,13 +25,13 @@ poetry install --extras deathreaper
### Usage ### Usage
DeathReaper was first available in a release from v0.12.0. DeathReaper was first released in Silkaj codebase with version 0.12.0.
Make sure `exclusions` command is present under `silkaj wot`, otherwise the installation when wrong. Make sure `exclusions` command is present under `silkaj wot`, otherwise something probably went wrong with the installation.
Then run `silkaj wot exclusions --help` to know how to use it. Then run `silkaj wot exclusions --help` to check how to use it.
By default it will report the exclusions for last day from now till 24 hours in the past. By default it will report the exclusions for the last day, from 24 hours in the past till now.
You can specify an other duration `silkaj wot exclusions 0.5` for 12 hours. You can specify an other duration with `silkaj wot exclusions 0.5` for the last 12 hours, half a day, for example.
By default the report will be displayed in the terminal. By default the report will be displayed in the terminal.
To have it published on a Discourse forum, `--api-id` `--*-api-key`, `--publish` has to be passed. To have the report published on a Discourse forum, you have to pass following options `--api-id` `--*-api-key`, `--publish`.
Further code changes have to be done in order to support additional Discourse forums. Further code changes have to be done in order to support additional Discourse forums.
docs/images/deathreaper_logo.svg 0 → 100644
+ 40
− 0
View file @ b8a0203a
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- Generator: Adobe Illustrator 15.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="140px" height="140px" viewBox="0 0 140 140" style="enable-background:new 0 0 140 140;" xml:space="preserve">
<g>
<path style="fill:#F2F2F2;" d="M70,130c-33.084,0-60-26.916-60-60s26.916-60,60-60s60,26.916,60,60S103.084,130,70,130z"/>
<circle style="fill:#F5DD9E;" cx="70" cy="70" r="58.064"/>
<g>
<path style="fill:#754C24;" d="M46.774,78.71c-0.203,0-0.408-0.063-0.582-0.195c-0.427-0.322-0.512-1.236-0.19-1.664
c0.617-0.817,3.986-5.184,10.053-5.184c0.038,0,0.076,0,0.114,0c0.535,0,0.964,0.748,0.96,1.283
c-0.004,0.531-0.437,1.113-0.968,1.113c-0.029-0.002-0.068,0.076-0.103,0.076c-5.262,0-8.192,3.723-8.511,4.146
C47.357,78.538,47.067,78.71,46.774,78.71z"/>
<path style="fill:#1C0D1A;" d="M92.533,109.667H60.085c-0.274,0-0.536-0.111-0.719-0.314c-0.184-0.202-0.272-0.474-0.243-0.746
c0,0,2.69-25.619,3.671-35.172c0.395-3.84,1.954-7.494,4.306-10.131c-0.348-0.986-0.524-2.014-0.524-3.063
c0-4.64,3.878-16.083,9.732-16.083c5.854,0,9.731,11.478,9.731,16.13c0,1.098-0.189,2.194-0.553,3.209
c2.408,2.723,3.942,6.3,4.336,10.146c0.98,9.551,3.672,34.968,3.672,34.968c0.029,0.272-0.06,0.54-0.242,0.744
C93.068,109.556,92.808,109.667,92.533,109.667z"/>
<path style="fill:#1A1A1A;" d="M89.355,108.667c-2.904-2-4.645-27.846-5.345-34.66c-0.269-2.621-1.312-5.109-2.862-6.848
c0,0-2.439-2.971-4.375-2.971c0-0.97,3.871-1.935,3.871-3.869c0-2.948-2.066-10.125-4.354-10.125
c-2.288,0-4.355,7.179-4.355,10.127c0,1.936,3.871,2.904,3.871,3.871c-1.936,0-4.375,2.978-4.375,2.978
c-1.55,1.737-2.593,4.216-2.862,6.837c-0.7,6.815-2.44,32.66-5.344,34.66H89.355L89.355,108.667z"/>
<path style="fill:#E6E6E6;" d="M96.635,44.172c0-0.001,0.096-0.002,0.094-0.004c-11.23-13.304-42.711-12.603-50.188-11.147
c-0.448,0.088-0.652,0.646-0.678,0.646h-0.228v10h0.917c-0.025,0-0.053,0.271-0.053,0.363c0,0.535,0.433,1.02,0.967,1.02
c1.923,0,5.196-0.621,9.338-1.438c11.604-2.287,31.022-6.102,38.625,1.882c0.058,0.062,0.131,0.1,0.199,0.144
c0.04,0.024-0.175,0.063-0.134,0.082c0.125,0.055,0.142,0.084,0.142,0.084v0.002c0,0,0.478-0.021,0.586-0.063
c0.036-0.015,0.19-0.039,0.224-0.058c0.063-0.031,0.188-0.058,0.244-0.104c0.008-0.007,0.043-0.018,0.049-0.023
c0.008-0.008,0.035-0.01,0.043-0.018c0.043-0.039,0.069-0.09,0.102-0.134c0.038-0.052,0.086-0.099,0.113-0.156
s0.037-0.116,0.053-0.177s0.038-0.118,0.041-0.182c0.003-0.062-0.012-0.119-0.02-0.182s-0.01-0.124-0.031-0.184
c-0.02-0.061-0.057-0.11-0.09-0.166c-0.027-0.047-0.14-0.101-0.176-0.146C96.76,44.2,96.635,44.187,96.635,44.172
C96.635,44.173,96.635,44.172,96.635,44.172z"/>
<path style="fill:#CCCCCC;" d="M46.704,35.972c7.336-1.351,36.64-2.166,50.289,8.363c-0.016-0.025-0.027,0-0.043-0.027
c-0.027-0.048-0.14-0.072-0.176-0.117c-0.014-0.016-0.139-0.002-0.139-0.017c0-0.001,0-0.002,0-0.002
c0-0.001,0.096-0.002,0.094-0.004c-11.23-13.304-42.711-12.603-50.188-11.147c-0.448,0.088-0.652,0.646-0.678,0.646h-0.228v3
h0.231C45.894,35.667,46.231,36.058,46.704,35.972z"/>
<path style="fill:#603813;" d="M46.635,107.742c-0.535,0-1-0.434-1-0.968V34.192c0-0.534,0.465-0.967,1-0.967
c0.534,0,1,0.433,1,0.967v72.582C47.635,107.31,47.169,107.742,46.635,107.742z"/>
</g>
</g>
</svg>
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment