Formiko, un editor de text structurat pentru documentația Python

Despre formiko

În articolul următor vom analiza Formiko. Este un mic editor construit cu Python pe care l-am găsit întâmplător pe GitHub. Formiko este o aplicație reStructuredText cu un editor MarkDown și previzualizare pentru a verifica progresul muncii efectuate.

ReStructuredText este parte a proiectului Docutils și este folosit de programatorii Python pentru a crea documentație tehnică. Sunt sigur că vor fi mulți oameni care nu au auzit niciodată de reStructuredText, dar prin acest program și câteva concepte de bază veți vedea că este ușor de utilizat acest sistem de sintaxă. Programul este scris în Python cu Gtk3, GtkSourceView și Webkit2. Folosiți Docutils și recomandați marca comună analizor.

Trebuie spus că Reduceri și reStructuredText au capacități similare. Ca o diferență, trebuie remarcat faptul că reStructuredText este conceput pentru a crea documentație, acceptă tabele și note de subsol și note finale.

ReStructuredText este un sistem de sintaxă și parser ușor de citit. Este util pentru documentarea programului online, șiruri de documente Python, pentru crearea rapidă de pagini web simple și pentru documente de sine stătătoare. Analizatorul reStructuredText este o componentă a Docutils și este o revizuire și reinterpretare a sistemelor de marcare ușoare StructuredText și Setext.

Caracteristicile generale ale Formiko

foriko gtk

Formiko

Conform paginii GitHub a proiectului, Formiko include următoarele caracteristici:

  • Am pozat un editor bazat pe GtkSourceView cu evidențierea sintaxei și un editor Vim.
  • Noi mergem împărțiți zona de lucru vertical sau orizontal.
  • Oferă o modul de previzualizare pentru a vedea cum este munca.
  • JSON și previzualizare a HTML.
  • Verificare a ortografiei.

De asemenea, este compatibil cu:

Instalarea Formiko pe Ubuntu

Pentru acest articol o voi face instalați Formiko pe Ubuntu 18.04. Vom găsi acest program disponibil pentru Debian și BSD așa cum putem vedea în programul său Pagina GitHub.

Proiectul Formiko Vim

Formiko vim

Requisitos

Înainte de a continua instalarea, trebuie spus că, conform paginii lor GitHub, va trebui să o facem repara unele Cerințe care cere programului să funcționeze corect atunci când îl instalăm cu pip3.

  • python 2.7 sau 3
  • GTK+3
  • gobject-introspecție
  • PyGObject
  • kit web
  • GtkSourceView

Deschidem un terminal (Ctrl + Alt + T) și scriem:

sudo apt install python3-pip python3-gi python3-docutils gir1.2-gtksource-3.0 \
gir1.2-webkit2-4.0 gir1.2-gtkspell3-3.0

Vreau să clarific din nou că fac această instalare pe Ubuntu 18.04. Odată ce cerințele sunt îndeplinite, vom vedea asta instalarea programului se va face prin pip sau apt pe măsură ce suntem interesați. Pentru folosiți pip3 în instalare vom scrie în terminal (Ctrl + Alt + T):

pip3 install formiko

În caz că preferați folosi apt, în același terminal scriem:

instalare apt formiko

sudo apt update && sudo apt install formiko

Trebuie spus că ambele instalații ne vor oferi aceeași versiune a programului. Opțional, putem instala și:

sudo apt install vim-gtk3
pip3 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer

Când îl instalăm, se vor adăuga două intrări în meniul aplicației: Formiko y Formiko vim.

Lansatorul Formiko și Formiko Vim

Va trebui să-l găsim pe cel care se potrivește cel mai bine nevoilor noastre.

Dezinstalați Formiko

După cum am văzut două opțiuni de instalare, vom vedea și două comenzi pentru a elimina programul din sistemul nostru de operare.

Prima dintre comenzi va fi cea care se referă la instalare realizată cu pip3. Pentru a elimina programul, vom deschide un terminal (Ctrl + Alt + T) și vom scrie în el:

sudo pip3 uninstall formiko

Acum vom vedea comanda pentru cei care au ales instalare cu apt. Într-un terminal (Ctrl + Alt + T) scriem:

sudo apt purge formiko && sudo apt autoremove

Este posibil să nu fie cel mai bun dintre programe pentru funcția sa, dar trebuie să spun că Formiko a funcționat fără probleme în timp ce l-am testat. Nu vreau să termin fără să vorbesc mai întâi despre ceea ce este probabil cel mai mare punct negru al acestui program, limitarea formatului cu care ne permite să lucrăm

Puteți obține mai multe informații despre acest program pe pagina Proiect GitHub.


Lasă comentariul tău

Adresa ta de email nu va fi publicată. Câmpurile obligatorii sunt marcate cu *

*

*

  1. Responsabil pentru date: Miguel Ángel Gatón
  2. Scopul datelor: Control SPAM, gestionarea comentariilor.
  3. Legitimare: consimțământul dvs.
  4. Comunicarea datelor: datele nu vor fi comunicate terților decât prin obligație legală.
  5. Stocarea datelor: bază de date găzduită de Occentus Networks (UE)
  6. Drepturi: în orice moment vă puteți limita, recupera și șterge informațiile.