{ "info": { "author": "Pawe\u0142 Tomulik", "author_email": "ptomulik@meil.pw.edu.pl", "bugtrack_url": null, "classifiers": [], "description": "scons-tool-texas\n================\n\n.. image:: https://badge.fury.io/py/scons-tool-texas.svg\n :target: https://badge.fury.io/py/scons-tool-texas\n :alt: PyPi package version\n\n.. image:: https://travis-ci.org/ptomulik/scons-tool-texas.svg?branch=master\n :target: https://travis-ci.org/ptomulik/scons-tool-texas\n :alt: Travis CI build status\n\n.. image:: https://ci.appveyor.com/api/projects/status/github/ptomulik/scons-tool-texas?svg=true\n :target: https://ci.appveyor.com/project/ptomulik/scons-tool-texas\n\nThis is a SCons tool (set) named TeX Automated with SCons (``TeXAS``). It\nwraps several SCons builders with the aim of simplifying compilation of ``TeX``\nprojects. It brings several features, that you may find useful:\n\n- compact syntax,\n- consistent interface between builders provided by ``TeXAS``,\n- oriented towards compiling named \"projects\",\n- automatic generation of SCons aliases for predefined targets,\n- automatic deduction of target file names based on project name,\n- builders for creating tarballs with document sources,\n- support for VariantDir,\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 texas tool from pypi_, type (within your wirtualenv):\n\n.. code-block:: shell\n\n pip install scons-tool-loader scons-tool-texas\n\nor, if your project uses pipenv_:\n\n.. code-block:: shell\n\n pipenv install --dev scons-tool-loader scons-tool-texas\n\nAlternatively, you may add this to your ``Pipfile``\n\n.. code-block::\n\n [dev-packages]\n scons-tool-loader = \"*\"\n scons-tool-texas = \"*\"\n\n\nThe tool will be installed as a namespaced package ``sconstool.texas``\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-texas`_ as a submodule:\n\n .. code-block:: shell\n\n git submodule add git://github.com/ptomulik/scons-tool-texas.git site_scons/site_tools/texas\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.texas`` (this may be required by other tools).\n\nUSAGE EXAMPLE\n-------------\n\nAssume you have a paper named ``'foo'`` which compiles from single source\n``foo.tex``. The paper's current version is ``1.0``. The source file\n``foo.tex`` includes ``bar.tex`` which, in turn, includes ``bar.eps`` image.\nYou're unsure, whether LaTeX scanner adds ``bar.eps`` to implicit dependencies\nor not. To compile paper and distribute its sources (for editorial manager\ne.g.) you may write simple SCons script::\n\n # SConstruct\n env = Environment(tools = ['texas'])\n dvi = env.TeXASDVI('foo', version = '1.0', dvi_deps = ['bar.eps'])\n src = env.TeXASRmDup( dvi[0].children() )\n tar = env.TeXASTarGz('foo', src, version = '1.0')\n\nYou may compile entire project, or just parts of it::\n\n scons -Q # build all (papers)\n scons -Q foo-dvi # Build only foo-1.0.dvi\n scons -Q foo-tgz # Create only the source tarball foo-1.0.tar.gz\n scons -Q foo # Build paper 'foo' (there may be more in the source tree)\n\nFor more examples, see user manual (see the section `GENERATING DOCUMENTATION`_).\n\nPREREQUISITES\n-------------\n\nTo perform certain activities, you may need the following packages (listed per\ntask).\n\nTO GENERATE API DOCUMENTATION\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n - epydoc_,\n - python-docutils_,\n - python-pygments_.\n\nTO GENERATE USER DOCUMENTATION\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n - docbook-xml_,\n - xsltproc_,\n\nGENERATING DOCUMENTATION\n------------------------\n\nScons gnuplot tool has an API documentation and user manual. The documentation\nmay be generated as follows (see also REQUIREMENTS).\n\nAPI DOCUMENTATION\n^^^^^^^^^^^^^^^^^\n\nTo generate API documentation type::\n\n pipenv run scons api-doc\n\nThe generated API documentation will be written to ``build/doc/api/``.\n\nUSER MANUAL\n^^^^^^^^^^^\n\nTo generate user manual type::\n\n pipenv run scons user-doc\n\nThe generated documentation will be written to ``build/doc/user/``.\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.. _epydoc: http://epydoc.sourceforge.net/\n.. _python-docutils: http://pypi.python.org/pypi/docutils\n.. _python-pygments: http://pygments.org/\n.. _docbook-xml: http://www.oasis-open.org/docbook/xml/\n.. _xsltproc: http://xmlsoft.org/libxslt/\n.. _SCons docbook tool: https://bitbucket.org/dirkbaechle/scons_docbook/\n.. _git: http://git-scm.com/\n.. _SCons dvipdfm tool: https://github.com/ptomulik/scons-tool-dvipdfm\n.. _SCons kpsewhich tool: https://github.com/ptomulik/scons-tool-kpsewhich\n.. _scons-tool-loader: https://github.com/ptomulik/scons-tool-loader\n.. _pipenv: https://pipenv.readthedocs.io/\n.. _pypi: https://pypi.org/\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-texas", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "scons-tool-texas", "package_url": "https://pypi.org/project/scons-tool-texas/", "platform": "", "project_url": "https://pypi.org/project/scons-tool-texas/", "project_urls": { "Homepage": "https://github.com/ptomulik/scons-tool-texas" }, "release_url": "https://pypi.org/project/scons-tool-texas/0.1.2/", "requires_dist": [ "scons-tool-util (>=0.1.10)", "scons-tool-kpsewhich (>=0.1.1)", "scons-tool-dvipdfm (>=0.1.0)", "scons-tool-archives (>=0.1.1)" ], "requires_python": ">=2.7", "summary": "TeX Automated with SCons", "version": "0.1.2" }, "last_serial": 5177107, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "c2f4f3b1eed6aaea1ecc595930f4fac7", "sha256": "282aeaac8d2cf05165a98ff360851a06ac98b8714588d64dbe9f0804c43f8cb2" }, "downloads": -1, "filename": "scons_tool_texas-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "c2f4f3b1eed6aaea1ecc595930f4fac7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 15282, "upload_time": "2018-11-28T16:50:23", "url": "https://files.pythonhosted.org/packages/62/ec/182c773e6fc0061f27c3911547e81d1fc5cb158ada8770258fe023bfd688/scons_tool_texas-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e391e362ef5ca3a9919fe1b845aee337", "sha256": "e76421ad97cf1e37dc1919cec40a03fe1fea6a4a77b772f9f0d77cf70707852d" }, "downloads": -1, "filename": "scons-tool-texas-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e391e362ef5ca3a9919fe1b845aee337", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 13123, "upload_time": "2018-11-28T16:50:26", "url": "https://files.pythonhosted.org/packages/9d/c2/be12a7f7ed085e78853659985a21ec8a77f48b4aa1d9e73007cefe3a721f/scons-tool-texas-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "9bef4d037b44a66cda8eebf919382e4d", "sha256": "ca5481328e62bef5cc61bf8b38bb8d36b86ba5983b4d74269235c6e26b30bffa" }, "downloads": -1, "filename": "scons_tool_texas-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "9bef4d037b44a66cda8eebf919382e4d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 15272, "upload_time": "2018-11-28T16:53:05", "url": "https://files.pythonhosted.org/packages/d4/e4/96f2d252361095af5173c38cb49e6dc35b44f666acf6f5fa8acdd6030038/scons_tool_texas-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "942094caab8ffaa9eddc8d4b730a6d10", "sha256": "00117e43e5db43ee234c55f204bc9882c39046cda8618e8e1f85d9276c1ec5af" }, "downloads": -1, "filename": "scons-tool-texas-0.1.1.tar.gz", "has_sig": false, "md5_digest": "942094caab8ffaa9eddc8d4b730a6d10", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 13125, "upload_time": "2018-11-28T16:53:07", "url": "https://files.pythonhosted.org/packages/a1/63/bdfca37351ea43dd2cf76f95b825b9c54836522dc17c2422c8a7023e3843/scons-tool-texas-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "883128868aad6cbfc673d88cfafebcb8", "sha256": "0e58523776e3c6276225e0b7858f14a3697c20533ed317b8d16f92dd7dc12b28" }, "downloads": -1, "filename": "scons_tool_texas-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "883128868aad6cbfc673d88cfafebcb8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 15274, "upload_time": "2019-04-23T12:27:24", "url": "https://files.pythonhosted.org/packages/86/a4/1456b763f41ff55efeaaf048531bd6f71cf43f2d9d49549933db8ac70b69/scons_tool_texas-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "152ac23b997cf3ed62ea1812f587809c", "sha256": "a109e43e6850ca1546252438dadb1bb76bd327138ae903970b527f83acb50697" }, "downloads": -1, "filename": "scons-tool-texas-0.1.2.tar.gz", "has_sig": false, "md5_digest": "152ac23b997cf3ed62ea1812f587809c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 12954, "upload_time": "2019-04-23T12:27:26", "url": "https://files.pythonhosted.org/packages/55/85/f55f34b8cb52d5ee97228ae08f7a5b413aab90ba765b77b2089486f3f6c6/scons-tool-texas-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "883128868aad6cbfc673d88cfafebcb8", "sha256": "0e58523776e3c6276225e0b7858f14a3697c20533ed317b8d16f92dd7dc12b28" }, "downloads": -1, "filename": "scons_tool_texas-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "883128868aad6cbfc673d88cfafebcb8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 15274, "upload_time": "2019-04-23T12:27:24", "url": "https://files.pythonhosted.org/packages/86/a4/1456b763f41ff55efeaaf048531bd6f71cf43f2d9d49549933db8ac70b69/scons_tool_texas-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "152ac23b997cf3ed62ea1812f587809c", "sha256": "a109e43e6850ca1546252438dadb1bb76bd327138ae903970b527f83acb50697" }, "downloads": -1, "filename": "scons-tool-texas-0.1.2.tar.gz", "has_sig": false, "md5_digest": "152ac23b997cf3ed62ea1812f587809c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 12954, "upload_time": "2019-04-23T12:27:26", "url": "https://files.pythonhosted.org/packages/55/85/f55f34b8cb52d5ee97228ae08f7a5b413aab90ba765b77b2089486f3f6c6/scons-tool-texas-0.1.2.tar.gz" } ] }