{"parents": [], "prev": null, "next": {"link": "quickstart/", "title": "Quick start guide"}, "title": "Welcome to polib\u2019s documentation!", "meta": null, "body": "<section id=\"welcome-to-polib-s-documentation\">\n<h1>Welcome to polib\u2019s documentation!<a class=\"headerlink\" href=\"#welcome-to-polib-s-documentation\" title=\"Link to this heading\">\u00b6</a></h1>\n<p><a class=\"reference external\" href=\"https://pypi.python.org/pypi/djangorestframework-datatables\"><img alt=\"Pypi version\" src=\"https://img.shields.io/pypi/v/polib.svg\" /></a> <a class=\"reference external\" href=\"https://pypistats.org/packages/polib\"><img alt=\"Pypi downloads\" src=\"https://img.shields.io/pypi/dm/polib.svg\" /></a> <a class=\"reference external\" href=\"http://travis-ci.org/izimobil/polib?branch=master\"><img alt=\"Travis build\" src=\"https://secure.travis-ci.org/izimobil/polib.svg?branch=master\" /></a> <a class=\"reference external\" href=\"https://codecov.io/gh/izimobil/polib\"><img alt=\"codecov-image\" src=\"https://codecov.io/gh/izimobil/polib/branch/master/graph/badge.svg\" /></a> <a class=\"reference external\" href=\"http://polib.readthedocs.io/en/latest/?badge=latest\"><img alt=\"Documentation Status\" src=\"https://readthedocs.org/projects/polib/badge/?version=latest\" /></a> <a class=\"reference external\" href=\"https://img.shields.io/pypi/pyversions/polib.svg\"><img alt=\"Python versions\" src=\"https://img.shields.io/pypi/pyversions/polib.svg\" /></a></p>\n<p>polib is a library to manipulate, create, modify gettext files (pot, po and mo\nfiles). You can load existing files, iterate through it\u2019s entries, add, modify\nentries, comments or metadata, etc. or create new po files from scratch.</p>\n<p>polib supports out of the box any version of python ranging from 2.7 to latest\n3.X version.</p>\n<p>polib is pretty stable now and is used by many\n<a class=\"reference internal\" href=\"projects/#projects\"><span class=\"std std-ref\">opensource projects</span></a>.</p>\n<p>polib is completely free and opensource, the license used is\n<a class=\"reference external\" href=\"http://www.opensource.org/licenses/mit-license.php\">the MIT license</a>.\nIt was developed back in 2006 by <a class=\"reference external\" href=\"mailto:izimobil&#37;&#52;&#48;gmail&#46;com\">David Jean Louis</a>\nand it is still actively maintained.</p>\n<p>To get up and running quickly, consult the <a class=\"reference internal\" href=\"quickstart/#quickstart\"><span class=\"std std-ref\">quick-start guide</span></a>, which describes all the necessary steps to install and use\npolib.\nFor more detailed information about how to install and how to use polib,\nread through the documentation listed below.</p>\n<p>Contents:</p>\n<div class=\"toctree-wrapper compound\">\n<ul>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"quickstart/\">Quick start guide</a><ul>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"quickstart/#installing-polib\">Installing polib</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"quickstart/#some-basics-about-gettext-catalogs\">Some basics about gettext catalogs</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"quickstart/#loading-existing-catalogs\">Loading existing catalogs</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"quickstart/#loading-a-catalog-from-a-string\">Loading a catalog from a string</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"quickstart/#loading-an-mo-file-from-a-bytes-object\">Loading an mo file from a bytes object</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"quickstart/#creating-po-catalogs-from-scratch\">Creating po catalogs from scratch</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"quickstart/#more-examples\">More examples</a></li>\n</ul>\n</li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"installation/\">Installation guide</a><ul>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"installation/#requirements\">Requirements</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"installation/#installing-polib\">Installing polib</a></li>\n</ul>\n</li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"api/\">polib API</a><ul>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-pofile-function\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">pofile</span></code> function</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-mofile-function\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">mofile</span></code> function</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-detect-encoding-function\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">detect_encoding</span></code> function</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-escape-function\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">escape</span></code> function</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-unescape-function\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">unescape</span></code> function</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-pofile-class\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">POFile</span></code> class</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-mofile-class\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">MOFile</span></code> class</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-poentry-class\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">POEntry</span></code> class</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/#the-moentry-class\">The <code class=\"docutils literal notranslate\"><span class=\"pre\">MOEntry</span></code> class</a></li>\n</ul>\n</li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"contributing/\">Contributing to polib</a><ul>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"contributing/#how-to-contribute\">How to contribute</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"contributing/#running-the-test-suite\">Running the test suite</a></li>\n</ul>\n</li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"projects/\">Projects using polib</a></li>\n</ul>\n</div>\n</section>\n", "metatags": "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n", "rellinks": [["genindex", "General Index", "I", "index"], ["quickstart", "Quick start guide", "N", "next"]], "sourcename": "index.rst.txt", "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">Welcome to polib\u2019s documentation!</a></li>\n</ul>\n", "display_toc": false, "page_source_suffix": ".rst", "current_page_name": "index", "sidebars": ["localtoc.html", "relations.html", "sourcelink.html", "searchbox.html"], "alabaster_version": "1.0.0", "alabaster_version_info": [1, 0, 0]}