{ "info": { "author": "Pawe\u0142 Tomulik", "author_email": "ptomulik@meil.pw.edu.pl", "bugtrack_url": null, "classifiers": [], "description": "scons-tool-kpsewhich\n====================\n\n.. image:: https://badge.fury.io/py/scons-tool-kpsewhich.svg\n :target: https://badge.fury.io/py/scons-tool-kpsewhich\n :alt: PyPi package version\n\n.. image:: https://travis-ci.org/ptomulik/scons-tool-kpsewhich.svg?branch=master\n :target: https://travis-ci.org/ptomulik/scons-tool-kpsewhich\n :alt: Travis CI build status\n\n.. image:: https://ci.appveyor.com/api/projects/status/github/ptomulik/scons-tool-kpsewhich?svg=true\n :target: https://ci.appveyor.com/project/ptomulik/scons-tool-kpsewhich\n\nThis tool provides `SCons`_ with interface to kpsewhich utility. The kpsewhich\nprogram is a part of `kpathsea`_ library, which in turn is a part of TeX Live\ndistribution. Its purpose is to search within the `TeX directory structure`_\n(TDS) for files such as TeX classes, styles, BibTeX databases, fonts etc. For\nmore informations see `kpathsea manual`_ and informations about `TeX directory\nstructure`_ (TDS).\n\nThis tool appends new methods to the SCons Environment. It does not provide any\nbuilders, but rather equips SCons Environment with methods that call\n``kpsewhich`` program during the SConscript-reading phase. This tool does not\nproduce any files, it is thought as an extension for obtaining textual\ninformation from external program.\n\nINSTALLATION\n------------\n\nThere are few ways to install this tool for your project.\n\nFrom pypi_\n^^^^^^^^^^\n\nThis method may be preferable if you build your project under a virtualenv. To\nadd kpsewhich tool from pypi_, type (within your wirtualenv):\n\n.. code-block:: shell\n\n pip install scons-tool-loader scons-tool-kpsewhich\n\nor, if your project uses pipenv_:\n\n.. code-block:: shell\n\n pipenv install --dev scons-tool-loader scons-tool-kpsewhich\n\nAlternatively, you may add this to your ``Pipfile``\n\n.. code-block::\n\n [dev-packages]\n scons-tool-loader = \"*\"\n scons-tool-kpsewhich = \"*\"\n\n\nThe tool will be installed as a namespaced package ``sconstool.kpsewhich``\nin project's virtual environment. You may further use scons-tool-loader_\nto load the tool.\n\nAs a git submodule\n^^^^^^^^^^^^^^^^^^\n\n#. Create new git repository:\n\n .. code-block:: shell\n\n mkdir /tmp/prj && cd /tmp/prj\n touch README.rst\n git init\n\n#. Add the `scons-tool-kpsewhich`_ as a submodule:\n\n .. code-block:: shell\n\n git submodule add git://github.com/ptomulik/scons-tool-kpsewhich.git site_scons/site_tools/kpsewhich\n\n#. For python 2.x create ``__init__.py`` in ``site_tools`` directory:\n\n .. code-block:: shell\n\n touch site_scons/site_tools/__init__.py\n\n this will allow to directly import ``site_tools.kpsewhich`` (this may be required by other tools).\n\n\nUSAGE EXAMPLES\n--------------\n\nFind files ``article.cls`` and ``amsmath.sty`` used by ``latex``:\n\n.. code-block:: python\n\n env = Environment(tools = ['tex', 'kpsewhich'])\n files = env.KPSFindFiles(['article.cls','amsmath.sty'], progname='$LATEX')\n\nFind all occurrences of ``unicode.sty`` file in TDS:\n\n.. code-block:: python\n\n env = Environment(tools = ['kpsewhich'])\n files = env.KPSFindAllFiles('unicode.sty')\n\nOther functions (correspond directly to ``kpsewhich`` function options):\n\n.. code-block:: python\n\n texmf = env.KPSExpandBraces('a{b,c}d')# kpsewhich -expand-braces 'a{b,c}d'\n texmf = env.KPSExpandPath('$TEXMF') # kpsewhich -expand-path '$TEXMF'\n texmf = env.KPSExpandVar('$TEXMF') # kpsewhich -expand-var '$TEXMF'\n texpath = env.KPSShowPath('tex') # kpsewhich -show-path 'tex'\n home = env.KPSVarValue('TEXMFHOME') # kpsewhich -var-value 'TEXMFHOME'\n\n\n\nCONSTRUCTION VARIABLES\n----------------------\n\nThe following construction variables may be used to configure the ``kpsewhich``\ntool. They may be also provided as keyword arguments to ``KPSXxx()`` methods.\n\n============================== ==============================================\n Variable Description\n============================== ==============================================\n ``KPSEWHICH`` the ``kpsewhich`` executable\n------------------------------ ----------------------------------------------\n ``KPSEWHICHFLAGS`` additional flags to ``kpsewhich``\n------------------------------ ----------------------------------------------\n ``KPSVARIABLES`` (re)define variables for ``kpsewhich``\n============================== ==============================================\n\n``KPSVARIABLES`` must be a dictionary in form ``{ NAME : VALUE }``,\nfor example:\n\n.. code-block:: python\n\n KPSVARIABLES = {\"TEXMFHOME\" : \"/home/ptomulik/texmf\"}\n\nARGUMENTS\n---------\n\nThese arguments are accepted by some ``KPSXxx()`` methods. All the methods accept\n``progname``. All other arguments are accepted by ``KPSFindFiles`` and\n``KPSFindAllFiles``.\n\n============================== ==============================================\n Variable Description\n============================== ==============================================\n ``dpi`` corresponds to ``-dpi`` flag,\n------------------------------ ----------------------------------------------\n ``format`` corresponds to ``-format`` flag,\n------------------------------ ----------------------------------------------\n ``path`` corresponds to ``-path`` flag\n------------------------------ ----------------------------------------------\n ``progname`` corresponds to ``-progname`` flag\n------------------------------ ----------------------------------------------\n ``subdir`` corresponds to ``-subdir`` flag\n============================== ==============================================\n\n\nLICENSE\n-------\nCopyright (c) 2013-2018 by Pawel Tomulik\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE\n\n.. _SCons: http://scons.org\n.. _SCons test framework: https://bitbucket.org/dirkbaechle/scons_test_framework\n.. _mercurial: http://mercurial.selenic.com/\n.. _TeX directory structure: http://tug.org/twg/tds/\n.. _kpathsea: http://tug.org/kpathsea/\n.. _kpathsea manual: http://tug.org/texinfohtml/kpathsea.html\n.. _pipenv: https://pipenv.readthedocs.io/\n.. _pypi: https://pypi.org/\n.. _scons-tool-loader: https://github.com/ptomulik/scons-tool-loader/\n\n.. \n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ptomulik/scons-tool-kpsewhich", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "scons-tool-kpsewhich", "package_url": "https://pypi.org/project/scons-tool-kpsewhich/", "platform": "", "project_url": "https://pypi.org/project/scons-tool-kpsewhich/", "project_urls": { "Homepage": "https://github.com/ptomulik/scons-tool-kpsewhich" }, "release_url": "https://pypi.org/project/scons-tool-kpsewhich/0.1.2/", "requires_dist": null, "requires_python": ">=2.7", "summary": "KpseWhich tool for SCons", "version": "0.1.2" }, "last_serial": 5176861, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "93584cae389ecf4a08da9c03f50fc6f9", "sha256": "7293e8b5fdccf05a32e82c8413f6f13d822e4f423294ead2074c5e4e75a9ed5c" }, "downloads": -1, "filename": "scons_tool_kpsewhich-0.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "93584cae389ecf4a08da9c03f50fc6f9", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.7", "size": 7885, "upload_time": "2018-11-08T17:58:47", "url": "https://files.pythonhosted.org/packages/f3/2f/ca9526fae1663e0c678756353b681945835bc7c59996cf9c521ac8c1e122/scons_tool_kpsewhich-0.1.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c0aa77492789aaad0b62fd7912c8db57", "sha256": "28f0f67641ed6401545a87c9ba46286ad20b44a24b55dc25f9349423350ae1c9" }, "downloads": -1, "filename": "scons-tool-kpsewhich-0.1.0.tar.gz", "has_sig": false, "md5_digest": "c0aa77492789aaad0b62fd7912c8db57", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 6980, "upload_time": "2018-11-08T17:58:49", "url": "https://files.pythonhosted.org/packages/cb/ad/aecb9dd102c754ebefb13f440d8b6726205f6ae2f0c362635643907b6342/scons-tool-kpsewhich-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "e2d1c3c5df87bc8498e0c30123b55633", "sha256": "2fcb6916e85abb64b6394098b1fb8a60c231f05e37eb1e56a8b01275ffbd7fcd" }, "downloads": -1, "filename": "scons_tool_kpsewhich-0.1.1-py2-none-any.whl", "has_sig": false, "md5_digest": "e2d1c3c5df87bc8498e0c30123b55633", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.7", "size": 7895, "upload_time": "2018-11-28T16:11:08", "url": "https://files.pythonhosted.org/packages/92/ca/295b2a9fe709761395b7742e78cdc97f712aa9026d87097639b2a5903328/scons_tool_kpsewhich-0.1.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "90983461555aca23c3fe5f404abdc51f", "sha256": "98a2fdf9d8ad3b78fff82ca4bf397a2a42e2e84414614360df1542613b0748aa" }, "downloads": -1, "filename": "scons-tool-kpsewhich-0.1.1.tar.gz", "has_sig": false, "md5_digest": "90983461555aca23c3fe5f404abdc51f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 7000, "upload_time": "2018-11-28T16:11:09", "url": "https://files.pythonhosted.org/packages/ac/4a/05fa8783eb352cd1648e3ee2b16b5927255a19729839bb28fe8fd42bff36/scons-tool-kpsewhich-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "832a4b8c89fb0da2db1801634f91624c", "sha256": "ce7fa17873064243a074de152011b5fdedb8defb3b9fdd10a55be6a1fb250f17" }, "downloads": -1, "filename": "scons_tool_kpsewhich-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "832a4b8c89fb0da2db1801634f91624c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 7895, "upload_time": "2019-04-23T11:47:18", "url": "https://files.pythonhosted.org/packages/05/3f/20d30d6d87bb1deb7d38f2d528bc430cac5a7d782a8c95c946998992c2d0/scons_tool_kpsewhich-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b779737bdc7bf8760ff13c2def7249e4", "sha256": "0603ee67d49d17f9b204a76a66f654e704a801dba0a3b4bfb95e8e26278a9b69" }, "downloads": -1, "filename": "scons-tool-kpsewhich-0.1.2.tar.gz", "has_sig": false, "md5_digest": "b779737bdc7bf8760ff13c2def7249e4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 6888, "upload_time": "2019-04-23T11:47:19", "url": "https://files.pythonhosted.org/packages/71/05/9c5035786ab4078d7231d37276f3da45b7daf1857224acbffee65110cfba/scons-tool-kpsewhich-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "832a4b8c89fb0da2db1801634f91624c", "sha256": "ce7fa17873064243a074de152011b5fdedb8defb3b9fdd10a55be6a1fb250f17" }, "downloads": -1, "filename": "scons_tool_kpsewhich-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "832a4b8c89fb0da2db1801634f91624c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 7895, "upload_time": "2019-04-23T11:47:18", "url": "https://files.pythonhosted.org/packages/05/3f/20d30d6d87bb1deb7d38f2d528bc430cac5a7d782a8c95c946998992c2d0/scons_tool_kpsewhich-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b779737bdc7bf8760ff13c2def7249e4", "sha256": "0603ee67d49d17f9b204a76a66f654e704a801dba0a3b4bfb95e8e26278a9b69" }, "downloads": -1, "filename": "scons-tool-kpsewhich-0.1.2.tar.gz", "has_sig": false, "md5_digest": "b779737bdc7bf8760ff13c2def7249e4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 6888, "upload_time": "2019-04-23T11:47:19", "url": "https://files.pythonhosted.org/packages/71/05/9c5035786ab4078d7231d37276f3da45b7daf1857224acbffee65110cfba/scons-tool-kpsewhich-0.1.2.tar.gz" } ] }