Formiko
=======
:author: Ondřej Tůma <mcbig@zeropage.cz>
Formiko is reStructuredText and MarkDown editor and live previewer. It is
written in Python with Gtk3, GtkSourceView and Webkit2. Use Docutils and
recommonmark Common Mark parser. If you want to **donate** development, you
can do by `paypal link <https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=4F4EJ3SV8JGYJ&item_name=Formiko+editor¤cy_code=EUR&source=url>`_.
Features:
---------
* GtkSourceView based editor with syntax highlighting
* possible use Vim editor
* vertical or horizontal window splitting
* preview mode with auto scroll
* periodic save file
* json and html preview
* spell check
* linked file opening
It support these parsers and writers:
* Docutils reStructuredText parser - http://docutils.sourceforge.net
* MarkDown to reStructuredText convertor (M2R) -
https://github.com/miyakogi/m2r
* Common Mark parser - https://github.com/rtfd/recommonmark
* Docutils HTML4, S5/HTML slide show and PEP HTML writer -
http://docutils.sourceforge.net
* Tiny HTML writer - https://github.com/ondratu/docutils-tinyhtmlwriter
* Yet another HTML writer - https://github.com/masayuko/docutils-htmlwriter
* HTML 5 writer - https://github.com/Kozea/docutils-html5-writer
Vim support
~~~~~~~~~~~
Formiko have Vim editor support aka ``formiko-vim`` command. This run `Vim
<https://vim.sourceforge.io/>`_ editor in GtkSocket. At this moment, this
socket work only on X11 backend, so this is not work on Wayland yet.
There is bug for GTK+:
Bug `721224 <https://bugzilla.gnome.org/show_bug.cgi?id=721224>`_ - please
add support for GtkSocket/GtkPlug in Wayland backend
Requirements:
-------------
* python 2.7 or 3
* GTK+3
* gobject-introspection
* PyGObject
* Webkit2 4.x
* GtkSourceView 3.x
* gir files for all Gtk libraries
* GtkSpell3
* docutils - reStrucured support
recommended:
~~~~~~~~~~~~
* m2r - converting MarkDown to reStructuredText
* recommonmark - for Common Mark support (MarkDown)
* Pygments - syntax color in html output code blocks
optionally:
~~~~~~~~~~~
**Python**:
* docutils-tinyhtmlwriter
* docutils-html5-writer
**System**:
* vim-gtk or vim-gnome for ``formiko-vim``
development:
~~~~~~~~~~~~
* pygobject-stubs
Installation
------------
Flatpak
~~~~~~~
Formiko exist in Flathub repository as cz.zeropage.Formiko. If you are new with
Flatpak, see `setup guide <https://flatpak.org/setup/>`_.
.. code:: sh
# add Flathub repository as root
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
# install Formiko as user
flatpak install flathub cz.zeropage.Formiko
# run Formiko
flatpak run cz.zeropage.Formiko
Debian based
~~~~~~~~~~~~
Debian based distributions use sometimes versions in package names. Here are
example for Debian Stretch version. If you use different version, your
gtksource or webkit2 could have another version name.
.. code:: sh
# python3.5, gtk3, librsvg etc are in dependencies
apt install python3-pip python3-gi python3-docutils gir1.2-gtksource-4 \
gir1.2-webkit2-4.1 gir1.2-gtkspell3-3.0 python3-mr2
pip3 install formiko
# optionaly
apt install vim-gtk3
pip3 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer
**Formiko is in Debian and Ubuntu repository**. So you can install it standard
way.
NetBSD
~~~~~~
There is not GtkSpell3 on NetBSD, which is need for next 1.3.x version. So you
must use 1.2.x bug fix release.
Installation process can be different for each BSD releases. It's about which
Python release is default. By this, you can change ``pyXX`` to your right
version.
NetBSD use pkgsrc, so some binaries are stored in ``/usr/pkg/bin`` directory.
Formiko call vim and gvim directly. If you want to use vim version with
pkgsrc, you must fix ``VIM_PATH`` variable in ``formiko/vim.py`` file.
.. code:: sh
# python3.6 is in dependecies as like gtk3
pkgin install py36-pip py36-gobject3 py36-docutils gtksourceview4 \
librsvg webkit-gtk py36-pygments
pip3.6 install formiko
# optionaly
pkgin install vim-gtk3
pip3.6 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer
FreeBSD
~~~~~~~
Installation process can be different for each BSD releases. It's about which
Python release is default. By this, you can change ``pyXX`` to your right
version.
On FreeBSD you must install all these packages:
.. code:: sh
pkg install py37-gobject3 py37-docutils py37-pygments py37-pip \
gtksourceview4 webkit2-gtk3 gtkspell3 gobject-introspection \
librsvg2 adwaita-icon-theme
**Optionaly**
.. code:: sh
pkg install en-hunspell # or other language you want
pip-3.7 install docutils-tinyhtmlwriter docutils-html5-writer m2r
Raw data
{
"_id": null,
"home_page": "https://github.com/ondratu/formiko",
"name": "formiko",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "doc, html, rst, docutils, md, markdown, editor",
"author": "Ondrej Tuma",
"author_email": "mcbig@zeropage.cz",
"download_url": "https://files.pythonhosted.org/packages/9b/4b/623af4287b12f34d495a71aac5a46481c7bd3ed66755cec2d2bcf88e5844/formiko-1.5.0.tar.gz",
"platform": null,
"description": "Formiko\n=======\n\n:author: Ond\u0159ej T\u016fma <mcbig@zeropage.cz>\n\nFormiko is reStructuredText and MarkDown editor and live previewer. It is\nwritten in Python with Gtk3, GtkSourceView and Webkit2. Use Docutils and\nrecommonmark Common Mark parser. If you want to **donate** development, you\ncan do by `paypal link <https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=4F4EJ3SV8JGYJ&item_name=Formiko+editor¤cy_code=EUR&source=url>`_.\n\nFeatures:\n---------\n* GtkSourceView based editor with syntax highlighting\n* possible use Vim editor\n* vertical or horizontal window splitting\n* preview mode with auto scroll\n* periodic save file\n* json and html preview\n* spell check\n* linked file opening\n\nIt support these parsers and writers:\n\n* Docutils reStructuredText parser - http://docutils.sourceforge.net\n* MarkDown to reStructuredText convertor (M2R) -\n https://github.com/miyakogi/m2r\n* Common Mark parser - https://github.com/rtfd/recommonmark\n* Docutils HTML4, S5/HTML slide show and PEP HTML writer -\n http://docutils.sourceforge.net\n* Tiny HTML writer - https://github.com/ondratu/docutils-tinyhtmlwriter\n* Yet another HTML writer - https://github.com/masayuko/docutils-htmlwriter\n* HTML 5 writer - https://github.com/Kozea/docutils-html5-writer\n\nVim support\n~~~~~~~~~~~\nFormiko have Vim editor support aka ``formiko-vim`` command. This run `Vim\n<https://vim.sourceforge.io/>`_ editor in GtkSocket. At this moment, this\nsocket work only on X11 backend, so this is not work on Wayland yet.\n\nThere is bug for GTK+:\n Bug `721224 <https://bugzilla.gnome.org/show_bug.cgi?id=721224>`_ - please\n add support for GtkSocket/GtkPlug in Wayland backend\n\nRequirements:\n-------------\n* python 2.7 or 3\n* GTK+3\n* gobject-introspection\n* PyGObject\n* Webkit2 4.x\n* GtkSourceView 3.x\n* gir files for all Gtk libraries\n* GtkSpell3\n* docutils - reStrucured support\n\nrecommended:\n~~~~~~~~~~~~\n* m2r - converting MarkDown to reStructuredText\n* recommonmark - for Common Mark support (MarkDown)\n* Pygments - syntax color in html output code blocks\n\noptionally:\n~~~~~~~~~~~\n**Python**:\n\n* docutils-tinyhtmlwriter\n* docutils-html5-writer\n\n**System**:\n\n* vim-gtk or vim-gnome for ``formiko-vim``\n\ndevelopment:\n~~~~~~~~~~~~\n\n* pygobject-stubs\n\nInstallation\n------------\n\nFlatpak\n~~~~~~~\nFormiko exist in Flathub repository as cz.zeropage.Formiko. If you are new with\nFlatpak, see `setup guide <https://flatpak.org/setup/>`_.\n\n.. code:: sh\n\n # add Flathub repository as root\n flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo\n\n # install Formiko as user\n flatpak install flathub cz.zeropage.Formiko\n\n # run Formiko\n flatpak run cz.zeropage.Formiko\n\nDebian based\n~~~~~~~~~~~~\nDebian based distributions use sometimes versions in package names. Here are\nexample for Debian Stretch version. If you use different version, your\ngtksource or webkit2 could have another version name.\n\n.. code:: sh\n\n # python3.5, gtk3, librsvg etc are in dependencies\n apt install python3-pip python3-gi python3-docutils gir1.2-gtksource-4 \\\n gir1.2-webkit2-4.1 gir1.2-gtkspell3-3.0 python3-mr2\n pip3 install formiko\n\n # optionaly\n apt install vim-gtk3\n pip3 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer\n\n**Formiko is in Debian and Ubuntu repository**. So you can install it standard\nway.\n\nNetBSD\n~~~~~~\nThere is not GtkSpell3 on NetBSD, which is need for next 1.3.x version. So you\nmust use 1.2.x bug fix release.\n\nInstallation process can be different for each BSD releases. It's about which\nPython release is default. By this, you can change ``pyXX`` to your right\nversion.\n\nNetBSD use pkgsrc, so some binaries are stored in ``/usr/pkg/bin`` directory.\nFormiko call vim and gvim directly. If you want to use vim version with\npkgsrc, you must fix ``VIM_PATH`` variable in ``formiko/vim.py`` file.\n\n.. code:: sh\n\n # python3.6 is in dependecies as like gtk3\n pkgin install py36-pip py36-gobject3 py36-docutils gtksourceview4 \\\n librsvg webkit-gtk py36-pygments\n pip3.6 install formiko\n\n # optionaly\n pkgin install vim-gtk3\n pip3.6 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer\n\nFreeBSD\n~~~~~~~\nInstallation process can be different for each BSD releases. It's about which\nPython release is default. By this, you can change ``pyXX`` to your right\nversion.\n\nOn FreeBSD you must install all these packages:\n\n.. code:: sh\n\n pkg install py37-gobject3 py37-docutils py37-pygments py37-pip \\\n gtksourceview4 webkit2-gtk3 gtkspell3 gobject-introspection \\\n librsvg2 adwaita-icon-theme\n\n**Optionaly**\n\n.. code:: sh\n\n pkg install en-hunspell # or other language you want\n pip-3.7 install docutils-tinyhtmlwriter docutils-html5-writer m2r\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Formiko is reStructuredText and MarkDown editor and live previewer.",
"version": "1.5.0",
"project_urls": {
"Homepage": "https://github.com/ondratu/formiko"
},
"split_keywords": [
"doc",
" html",
" rst",
" docutils",
" md",
" markdown",
" editor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a65ecee4414628caae5c8a1dedaf15fbd2901e85bc1fd385fb2a7df82808dc7d",
"md5": "8f3f72a37a46754b223d8f79afeb7d8f",
"sha256": "534c6c20c3b5883ee878742af07d8f69e7d737f0968c221e5293e5ce103c4d69"
},
"downloads": -1,
"filename": "formiko-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f3f72a37a46754b223d8f79afeb7d8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 117609,
"upload_time": "2024-11-15T18:10:05",
"upload_time_iso_8601": "2024-11-15T18:10:05.892575Z",
"url": "https://files.pythonhosted.org/packages/a6/5e/cee4414628caae5c8a1dedaf15fbd2901e85bc1fd385fb2a7df82808dc7d/formiko-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b4b623af4287b12f34d495a71aac5a46481c7bd3ed66755cec2d2bcf88e5844",
"md5": "a1663205c4a2c4c72e7f0353bdca09df",
"sha256": "2d0fd315cc9e1ef9c113a752a3e618dc27d2127227c199323d4002ecf3c04622"
},
"downloads": -1,
"filename": "formiko-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "a1663205c4a2c4c72e7f0353bdca09df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 104958,
"upload_time": "2024-11-15T18:10:08",
"upload_time_iso_8601": "2024-11-15T18:10:08.023474Z",
"url": "https://files.pythonhosted.org/packages/9b/4b/623af4287b12f34d495a71aac5a46481c7bd3ed66755cec2d2bcf88e5844/formiko-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 18:10:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ondratu",
"github_project": "formiko",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "formiko"
}
JSON
