{"parents": [], "prev": {"link": "../quickstart/", "title": "Quick start guide"}, "next": {"link": "../api/", "title": "polib API"}, "title": "Installation guide", "meta": {}, "body": "<section id=\"installation-guide\">\n<span id=\"installation\"></span><h1>Installation guide<a class=\"headerlink\" href=\"#installation-guide\" title=\"Link to this heading\">\u00b6</a></h1>\n<section id=\"requirements\">\n<h2>Requirements<a class=\"headerlink\" href=\"#requirements\" title=\"Link to this heading\">\u00b6</a></h2>\n<p>polib requires python 2.7 or higher.</p>\n</section>\n<section id=\"installing-polib\">\n<h2>Installing polib<a class=\"headerlink\" href=\"#installing-polib\" title=\"Link to this heading\">\u00b6</a></h2>\n<p>There are several ways to install polib:</p>\n<ul class=\"simple\">\n<li><p>Automatically, via a package manager.</p></li>\n<li><p>Manually, by downloading a copy of the release package and\ninstalling it yourself.</p></li>\n<li><p>Manually, by performing a Mercurial checkout of the latest code.</p></li>\n</ul>\n<section id=\"automatic-installation-via-a-package-manager\">\n<h3>Automatic installation via a package manager<a class=\"headerlink\" href=\"#automatic-installation-via-a-package-manager\" title=\"Link to this heading\">\u00b6</a></h3>\n<p>Several automatic package-installation tools are available for Python;\nthe most popular are <a class=\"reference external\" href=\"http://pip.openplans.org/\">pip</a> and <a class=\"reference external\" href=\"http://peak.telecommunity.com/DevCenter/EasyInstall\">easy_install</a>  .\nEither can be used to install polib.</p>\n<p>Using <code class=\"docutils literal notranslate\"><span class=\"pre\">pip</span></code>, type:</p>\n<div class=\"highlight-default notranslate\"><div class=\"highlight\"><pre><span></span><span class=\"n\">pip</span> <span class=\"n\">install</span> <span class=\"n\">polib</span>\n</pre></div>\n</div>\n<p>Using <code class=\"docutils literal notranslate\"><span class=\"pre\">easy_install</span></code>, type:</p>\n<div class=\"highlight-default notranslate\"><div class=\"highlight\"><pre><span></span><span class=\"n\">easy_install</span> <span class=\"n\">polib</span>\n</pre></div>\n</div>\n<p>It is also possible that your operating system distributor provides a\npackaged version of polib. Consult your operating system\u2019s package list for\ndetails, but be aware that third-party distributions may be providing older\nversions of polib, and so you should consult the documentation which comes\nwith your operating system\u2019s package.</p>\n</section>\n<section id=\"manual-installation-from-a-downloaded-package\">\n<h3>Manual installation from a downloaded package<a class=\"headerlink\" href=\"#manual-installation-from-a-downloaded-package\" title=\"Link to this heading\">\u00b6</a></h3>\n<p>If you prefer not to use an automated package installer, you can download a\ncopy of polib and install it manually. The latest release package can be\ndownloaded from <a class=\"reference external\" href=\"http://pypi.python.org/pypi/polib/\">polib\u2019s page on the Python Package Index</a>.</p>\n<p>Once you\u2019ve downloaded the package, unpack it, this will create the directory\n<code class=\"docutils literal notranslate\"><span class=\"pre\">polib-X-Y-Z</span></code>, which contains the <code class=\"docutils literal notranslate\"><span class=\"pre\">setup.py</span></code> installation script.\nFrom a command line in that directory, type:</p>\n<div class=\"highlight-default notranslate\"><div class=\"highlight\"><pre><span></span><span class=\"n\">python</span> <span class=\"n\">setup</span><span class=\"o\">.</span><span class=\"n\">py</span> <span class=\"n\">install</span>\n</pre></div>\n</div>\n<div class=\"admonition note\">\n<p class=\"admonition-title\">Note</p>\n<p>On some systems you may need to execute this with administrative\nprivileges (e.g., <code class=\"docutils literal notranslate\"><span class=\"pre\">sudo</span> <span class=\"pre\">python</span> <span class=\"pre\">setup.py</span> <span class=\"pre\">install</span></code>).</p>\n</div>\n</section>\n<section id=\"manual-installation-from-a-git-checkout\">\n<h3>Manual installation from a Git checkout<a class=\"headerlink\" href=\"#manual-installation-from-a-git-checkout\" title=\"Link to this heading\">\u00b6</a></h3>\n<p>If you\u2019d like to try out the latest in-development code, you can obtain it\nfrom the polib repository, which is hosted at\n<a class=\"reference external\" href=\"https://github.com/\">Github</a> and uses <a class=\"reference external\" href=\"https://git-scm.com/\">Git</a> for version control.</p>\n<p>To obtain the latest code and documentation, you\u2019ll need to have Git\ninstalled, at which point you can type:</p>\n<div class=\"highlight-default notranslate\"><div class=\"highlight\"><pre><span></span><span class=\"n\">git</span> <span class=\"n\">clone</span> <span class=\"n\">https</span><span class=\"p\">:</span><span class=\"o\">//</span><span class=\"n\">github</span><span class=\"o\">.</span><span class=\"n\">com</span><span class=\"o\">/</span><span class=\"n\">izimobil</span><span class=\"o\">/</span><span class=\"n\">polib</span><span class=\"o\">/</span>\n</pre></div>\n</div>\n<p>This will create a copy of the polib Git repository on your computer;\nyou can then add the <code class=\"docutils literal notranslate\"><span class=\"pre\">polib.py</span></code> file to your Python import path, or use the\n<code class=\"docutils literal notranslate\"><span class=\"pre\">setup.py</span></code> script to install as a package.</p>\n</section>\n</section>\n</section>\n", "metatags": "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n", "rellinks": [["genindex", "General Index", "I", "index"], ["api", "polib API", "N", "next"], ["quickstart", "Quick start guide", "P", "previous"]], "sourcename": "installation.rst.txt", "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">Installation guide</a><ul>\n<li><a class=\"reference internal\" href=\"#requirements\">Requirements</a></li>\n<li><a class=\"reference internal\" href=\"#installing-polib\">Installing polib</a><ul>\n<li><a class=\"reference internal\" href=\"#automatic-installation-via-a-package-manager\">Automatic installation via a package manager</a></li>\n<li><a class=\"reference internal\" href=\"#manual-installation-from-a-downloaded-package\">Manual installation from a downloaded package</a></li>\n<li><a class=\"reference internal\" href=\"#manual-installation-from-a-git-checkout\">Manual installation from a Git checkout</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n", "display_toc": true, "page_source_suffix": ".rst", "current_page_name": "installation", "sidebars": ["localtoc.html", "relations.html", "sourcelink.html", "searchbox.html"], "alabaster_version": "1.0.0", "alabaster_version_info": [1, 0, 0]}