py-encase


Namepy-encase JSON
Version 0.0.6 PyPI version JSON
download
home_pageNone
SummaryTool for encased python script environment.
upload_time2025-07-09 16:24:00
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseBSD 3-Clause License Copyright (c) 2025, Nanigashi Uji Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords pip template development
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            py-encase
=========

py-encase: Tool for encased python script environment.

Requirement
-----------

- Python >= 3.9
- pip3

Usage
-----

1. Initialization of working environment under certain directory
   (“${prefix}”) with creating new python script ‘newscript.py’ from
   template and installing specified python modules specified in CLI.

::

   # Create environment
   % py_encase --manage init -r -g -v --prefix=${prefix} -m pytz -m tzlocal newscript.py
   .....
   # Check file produced
   % ( cd ${prefix} ls -ltrd {bin,lib/python,lib/python/site-packages/*}/* )
   .... bin/py_encase.py
   .... bin/mng_encase -> py_encase.py
   .... bin/newscript -> py_encase.py
   .... lib/python/site-packages
   .... lib/python/newscript.py
   .... lib/python/site-packages/3.13.4/pytz
   .... lib/python/site-packages/3.13.4/pytz-2025.2.dist-info
   .... lib/python/site-packages/3.13.4/tzlocal
   .... lib/python/site-packages/3.13.4/tzlocal-5.3.1.dist-info

The entity of this tool will be copied to ``${prefix}/py_encase.py`` New
script is created as ``lib/python/newscript.py``.

The symbolic link under ``bin/`` (=\ ``bin/newscript``) is run
``lib/python/newscript.py`` by dealing with environmental variable
``PYTHONPATH`` to use python modules that are locally installed by pip
under ``lib/python/site-packages``.

::

   % ${prefix}/bin/newscript -d
   Hello, World! It is "Wed Jul  2 16:26:06 2025."
   Python : 3.13.4 ({somewhere}/bin/python3.13)
   1  : ${prefix}/lib/python
   2  : ${prefix}/lib/python/site-packages/3.13.4
   3  : ....

Another symbolic link ``bin/mng_encase`` can be used to make another
python script and symbolic link for execution from template.

::

   % ${prefix}/bin/mng_encase add another_script_can_be_run.py

another python script for library/module from template also can be
created.

::

   % ${prefix}bin/mng_encase addlib another_script_can_be_run.py

It is also possible to install module by ``pip`` locally under
‘${prefix}/lib/python/site-packages’.

::

   % ${prefix}bin/mng_encase install modulename1 modulename2 ....

The moduled installed locally by this tool can be deleted by
sub-commands ``clean`` or ``distclean``

::

   # Removing module installed locally by currently used python/pip version
   % ${prefix}bin/mng_encase clean
   # Removing all module installed locally by pip
   % ${prefix}bin/mng_encase distclean

Please refer the help messages for further usage.

::

   % ${prefix}/bin/mng_encase --help

   usage: mng_encase [-P PYTHON] [-I PIP] [-p PREFIX] [-G GIT_COMMAND] [-v] [-n] [-h]
                     {info,init,add,addlib,newmodule,clean,distclean,selfupdate,install,download,freeze,inspect,list,cache,piphelp} ...

   positional arguments:
     {info,init,add,addlib,newmodule,clean,distclean,selfupdate,install,download,freeze,inspect,list,cache,piphelp}
       info                Show information
       init                Initialise Environment
       add                 add new script files
       addlib              add new script files
       newmodule           add new module source
       clean               clean-up
       distclean           Entire clean-up
       selfupdate          Self update of py_encase.py
       install             PIP command : install
       download            PIP command : download
       freeze              PIP command : freeze
       inspect             PIP command : inspect
       list                PIP command : list
       cache               PIP command : cache
       piphelp             PIP command : help

   optional arguments:
     -P PYTHON, --python PYTHON
                           Python path / command
     -I PIP, --pip PIP     PIP path / command
     -p PREFIX, --prefix PREFIX
                           prefix of the directory tree. (Default:
                           Grandparent directory if the name of parent
                           directory of mng_encase is bin, otherwise
                           current working directory.
     -G GIT_COMMAND, --git-command GIT_COMMAND
                           git path / command
     -v, --verbose         Verbose output
     -n, --dry-run         Dry Run Mode
     -h, --help

Author
------

::

   Nanigashi Uji (53845049+nanigashi-uji@users.noreply.github.com)
   Nanigashi Uji (4423013-nanigashi_uji@users.noreply.gitlab.com)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "py-encase",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Nanigashi Uji <53845049+nanigashi-uji@users.noreply.github.com>, Nanigashi Uji <4423013-nanigashi_uji@users.noreply.gitlab.com>",
    "keywords": "pip, template, development",
    "author": null,
    "author_email": "Nanigashi Uji <53845049+nanigashi-uji@users.noreply.github.com>, Nanigashi Uji <4423013-nanigashi_uji@users.noreply.gitlab.com>",
    "download_url": "https://files.pythonhosted.org/packages/79/58/4bce6f0d57b61dd4fea366232859ec0f313f792f155ed8bdc4dbfeb41fdc/py_encase-0.0.6.tar.gz",
    "platform": null,
    "description": "py-encase\n=========\n\npy-encase: Tool for encased python script environment.\n\nRequirement\n-----------\n\n- Python >= 3.9\n- pip3\n\nUsage\n-----\n\n1. Initialization of working environment under certain directory\n   (\u201c${prefix}\u201d) with creating new python script \u2018newscript.py\u2019 from\n   template and installing specified python modules specified in CLI.\n\n::\n\n   # Create environment\n   % py_encase --manage init -r -g -v --prefix=${prefix} -m pytz -m tzlocal newscript.py\n   .....\n   # Check file produced\n   % ( cd ${prefix} ls -ltrd {bin,lib/python,lib/python/site-packages/*}/* )\n   .... bin/py_encase.py\n   .... bin/mng_encase -> py_encase.py\n   .... bin/newscript -> py_encase.py\n   .... lib/python/site-packages\n   .... lib/python/newscript.py\n   .... lib/python/site-packages/3.13.4/pytz\n   .... lib/python/site-packages/3.13.4/pytz-2025.2.dist-info\n   .... lib/python/site-packages/3.13.4/tzlocal\n   .... lib/python/site-packages/3.13.4/tzlocal-5.3.1.dist-info\n\nThe entity of this tool will be copied to ``${prefix}/py_encase.py`` New\nscript is created as ``lib/python/newscript.py``.\n\nThe symbolic link under ``bin/`` (=\\ ``bin/newscript``) is run\n``lib/python/newscript.py`` by dealing with environmental variable\n``PYTHONPATH`` to use python modules that are locally installed by pip\nunder ``lib/python/site-packages``.\n\n::\n\n   % ${prefix}/bin/newscript -d\n   Hello, World! It is \"Wed Jul  2 16:26:06 2025.\"\n   Python : 3.13.4 ({somewhere}/bin/python3.13)\n   1  : ${prefix}/lib/python\n   2  : ${prefix}/lib/python/site-packages/3.13.4\n   3  : ....\n\nAnother symbolic link ``bin/mng_encase`` can be used to make another\npython script and symbolic link for execution from template.\n\n::\n\n   % ${prefix}/bin/mng_encase add another_script_can_be_run.py\n\nanother python script for library/module from template also can be\ncreated.\n\n::\n\n   % ${prefix}bin/mng_encase addlib another_script_can_be_run.py\n\nIt is also possible to install module by ``pip`` locally under\n\u2018${prefix}/lib/python/site-packages\u2019.\n\n::\n\n   % ${prefix}bin/mng_encase install modulename1 modulename2 ....\n\nThe moduled installed locally by this tool can be deleted by\nsub-commands ``clean`` or ``distclean``\n\n::\n\n   # Removing module installed locally by currently used python/pip version\n   % ${prefix}bin/mng_encase clean\n   # Removing all module installed locally by pip\n   % ${prefix}bin/mng_encase distclean\n\nPlease refer the help messages for further usage.\n\n::\n\n   % ${prefix}/bin/mng_encase --help\n\n   usage: mng_encase [-P PYTHON] [-I PIP] [-p PREFIX] [-G GIT_COMMAND] [-v] [-n] [-h]\n                     {info,init,add,addlib,newmodule,clean,distclean,selfupdate,install,download,freeze,inspect,list,cache,piphelp} ...\n\n   positional arguments:\n     {info,init,add,addlib,newmodule,clean,distclean,selfupdate,install,download,freeze,inspect,list,cache,piphelp}\n       info                Show information\n       init                Initialise Environment\n       add                 add new script files\n       addlib              add new script files\n       newmodule           add new module source\n       clean               clean-up\n       distclean           Entire clean-up\n       selfupdate          Self update of py_encase.py\n       install             PIP command : install\n       download            PIP command : download\n       freeze              PIP command : freeze\n       inspect             PIP command : inspect\n       list                PIP command : list\n       cache               PIP command : cache\n       piphelp             PIP command : help\n\n   optional arguments:\n     -P PYTHON, --python PYTHON\n                           Python path / command\n     -I PIP, --pip PIP     PIP path / command\n     -p PREFIX, --prefix PREFIX\n                           prefix of the directory tree. (Default:\n                           Grandparent directory if the name of parent\n                           directory of mng_encase is bin, otherwise\n                           current working directory.\n     -G GIT_COMMAND, --git-command GIT_COMMAND\n                           git path / command\n     -v, --verbose         Verbose output\n     -n, --dry-run         Dry Run Mode\n     -h, --help\n\nAuthor\n------\n\n::\n\n   Nanigashi Uji (53845049+nanigashi-uji@users.noreply.github.com)\n   Nanigashi Uji (4423013-nanigashi_uji@users.noreply.gitlab.com)\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License\n        \n        Copyright (c) 2025, Nanigashi Uji\n        \n        Redistribution and use in source and binary forms, with or without\n        modification, are permitted provided that the following conditions are met:\n        \n        1. Redistributions of source code must retain the above copyright notice, this\n           list of conditions and the following disclaimer.\n        \n        2. Redistributions in binary form must reproduce the above copyright notice,\n           this list of conditions and the following disclaimer in the documentation\n           and/or other materials provided with the distribution.\n        \n        3. Neither the name of the copyright holder nor the names of its\n           contributors may be used to endorse or promote products derived from\n           this software without specific prior written permission.\n        \n        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n        ",
    "summary": "Tool for encased python script environment.",
    "version": "0.0.6",
    "project_urls": {
        "Homepage": "https://github.com/nanigashi-uji/py-encase"
    },
    "split_keywords": [
        "pip",
        " template",
        " development"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7b36164e902346dfb73abac6bcefced4d368b755f32921d0394b32d22168ca85",
                "md5": "dfe3b28bcba0f9f01198f7becc3d0a3c",
                "sha256": "28ac0f356120de88ac10460790a7eb155458463b20990f7d55db1ecc595016bf"
            },
            "downloads": -1,
            "filename": "py_encase-0.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dfe3b28bcba0f9f01198f7becc3d0a3c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 31599,
            "upload_time": "2025-07-09T16:23:59",
            "upload_time_iso_8601": "2025-07-09T16:23:59.281038Z",
            "url": "https://files.pythonhosted.org/packages/7b/36/164e902346dfb73abac6bcefced4d368b755f32921d0394b32d22168ca85/py_encase-0.0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "79584bce6f0d57b61dd4fea366232859ec0f313f792f155ed8bdc4dbfeb41fdc",
                "md5": "71f1b1488644cd6ff3af543b842baf54",
                "sha256": "3e09dc1be26875d1658a9866adbf37bbdbc125fb5d2b1dcece96ac84479be4a6"
            },
            "downloads": -1,
            "filename": "py_encase-0.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "71f1b1488644cd6ff3af543b842baf54",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 35031,
            "upload_time": "2025-07-09T16:24:00",
            "upload_time_iso_8601": "2025-07-09T16:24:00.877571Z",
            "url": "https://files.pythonhosted.org/packages/79/58/4bce6f0d57b61dd4fea366232859ec0f313f792f155ed8bdc4dbfeb41fdc/py_encase-0.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 16:24:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nanigashi-uji",
    "github_project": "py-encase",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "py-encase"
}
        
Elapsed time: 2.16238s