.. polib documentation master file

Welcome to polib's documentation!
=================================

|pypi-version| |pypi-stats| |build-status-image| |codecov-image| |documentation-status-image| |py-versions|

polib is a library to manipulate, create, modify gettext files (pot, po and mo
files). You can load existing files, iterate through it's entries, add, modify
entries, comments or metadata, etc. or create new po files from scratch.

polib supports out of the box any version of python ranging from 2.7 to latest
3.X version.

polib is pretty stable now and is used by many
:ref:`opensource projects <projects>`.

polib is completely free and opensource, the license used is
`the MIT license <http://www.opensource.org/licenses/mit-license.php>`_.
It was developed back in 2006 by `David Jean Louis <izimobil@gmail.com>`_
and it is still actively maintained.

To get up and running quickly, consult the :ref:`quick-start guide
<quickstart>`, which describes all the necessary steps to install and use
polib.
For more detailed information about how to install and how to use polib,
read through the documentation listed below.

Contents:

.. toctree::
   :maxdepth: 2

   quickstart
   installation
   api
   contributing
   projects

.. |build-status-image| image:: https://secure.travis-ci.org/izimobil/polib.svg?branch=master
   :target: http://travis-ci.org/izimobil/polib?branch=master
   :alt: Travis build

.. |codecov-image| image:: https://codecov.io/gh/izimobil/polib/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/izimobil/polib

.. |pypi-version| image:: https://img.shields.io/pypi/v/polib.svg
   :target: https://pypi.python.org/pypi/djangorestframework-datatables
   :alt: Pypi version

.. |pypi-stats| image:: https://img.shields.io/pypi/dm/polib.svg
   :target: https://pypistats.org/packages/polib
   :alt: Pypi downloads

.. |documentation-status-image| image:: https://readthedocs.org/projects/polib/badge/?version=latest
   :target: http://polib.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. |py-versions| image:: https://img.shields.io/pypi/pyversions/polib.svg
   :target: https://img.shields.io/pypi/pyversions/polib.svg
   :alt: Python versions
