lib-programname

get reliably the name of the executed script


License
MIT
Install
pip install lib-programname==2.0.9

Documentation

lib_programname

Version v2.0.9 as of 2023-07-14 see Changelog

build_badge codeql license jupyter pypi PyPI - Downloads black codecov Maintainability Maintainability Code Coverage snyk

This little Library returns the path of the executed Python Script.

Finding the name of the program from which a Python module is running can be trickier than it would seem at first, so lets make it damned easy. This works under pycharm, pytest, pytest-docrunner, uwsgi, dreampie etc. correctly.

You might dive into Dough Hellmans article about that issue.

$> python -m pip install lib_programname
$> python
>>> import lib_programname
>>> path_to_program = lib_programname.get_path_executed_script()    # type: pathlib.Path

This also works now if the script does not have any extension and if the scripts is symlinked.

In case the script is called via a symlink, the actual script location is returned, not the symlink !

$ # the test script
$ cat test.py
#!/usr/bin/env python3
import lib_programname
# this returns the fully resolved path to the launched python program
path_to_program = lib_programname.get_path_executed_script()  # type: pathlib.Path
print(path_to_program)

$ # running the script directly works
$ ./test.py
/Users/tester/test.py

$ # running the script with a .py named symlink works
$ ln -s test.py link2test.py
$ ./link2test.py
/Users/tester/test.py
$ rm link2test.py

$ # running the script with a symlink without an extension works
$ ln -s test.py link2test
$ ./link2test
/Users/tester/test.py
$ rm link2test

$ # running the script directly also works if it has no extension
$ mv test.py testme
$ ./testme
/Users/tester/testme

$ # running the extension-less script with a .py named symlink works
$ ln -s testme link2test.py
$ ./link2test.py
/Users/tester/testme

automated tests, Github Actions, Documentation, Badges, etc. are managed with PizzaCutter (cookiecutter on steroids)

Python version required: 3.8.0 or newer

tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12-dev, pypy-3.9, pypy-3.10 - architectures: amd64

100% code coverage, flake8 style checking ,mypy static type checking ,tested under Linux, macOS, Windows, automatic daily builds and monitoring



Try it Online

You might try it right away in Jupyter Notebook by using the "launch binder" badge, or click here

Usage

import lib_programname
# this returns the fully resolved path to the launched python program
path_to_program = lib_programname.get_path_executed_script()    # type: pathlib.Path

Usage from Commandline

Usage: lib_programname [OPTIONS] COMMAND [ARGS]...

  get reliably the name of the executed script

Options:
  --version                     Show the version and exit.
  --traceback / --no-traceback  return traceback information on cli
  -h, --help                    Show this message and exit.

Commands:
  info  get program informations

Installation and Upgrade

  • Before You start, its highly recommended to update pip and setup tools:
python -m pip --upgrade pip
python -m pip --upgrade setuptools
  • to install the latest release from PyPi via pip (recommended):
python -m pip install --upgrade lib_programname
  • to install the latest release from PyPi via pip, including test dependencies:
python -m pip install --upgrade lib_programname[test]
  • to install the latest version from github via pip:
python -m pip install --upgrade git+https://github.com/bitranox/lib_programname.git
  • include it into Your requirements.txt:
# Insert following line in Your requirements.txt:
# for the latest Release on pypi:
lib_programname

# for the latest development version :
lib_programname @ git+https://github.com/bitranox/lib_programname.git

# to install and upgrade all modules mentioned in requirements.txt:
python -m pip install --upgrade -r /<path>/requirements.txt
  • to install the latest development version, including test dependencies from source code:
# cd ~
$ git clone https://github.com/bitranox/lib_programname.git
$ cd lib_programname
python -m pip install -e .[test]
  • via makefile: makefiles are a very convenient way to install. Here we can do much more, like installing virtual environments, clean caches and so on.
# from Your shell's homedirectory:
$ git clone https://github.com/bitranox/lib_programname.git
$ cd lib_programname

# to run the tests:
$ make test

# to install the package
$ make install

# to clean the package
$ make clean

# uninstall the package
$ make uninstall

Requirements

following modules will be automatically installed :

## Project Requirements
click
cli_exit_tools
lib_detect_testenv

Acknowledgements

  • special thanks to "uncle bob" Robert C. Martin, especially for his books on "clean code" and "clean architecture"

Contribute

I would love for you to fork and send me pull request for this project. - please Contribute

License

This software is licensed under the MIT license

---

Changelog

  • new MAJOR version for incompatible API changes,
  • new MINOR version for added functionality in a backwards compatible manner
  • new PATCH version for backwards compatible bug fixes

v2.0.9

2023-07-14:
  • add codeql badge
  • move 3rd_party_stubs outside the src directory to ./.3rd_party_stubs
  • add pypy 3.10 tests
  • add python 3.12-dev tests

v2.0.8

2023-07-13:
  • require minimum python 3.8
  • remove python 3.7 tests

v2.0.7

2023-07-12:
  • also works now with symlinks
  • also works now with scripts and symlinks which do not have a py extension
  • clean ./tests/test_cli.py

v2.0.6

2023-07-12:
  • introduce PEP517 packaging standard
  • introduce pyproject.toml build-system
  • remove mypy.ini
  • remove pytest.ini
  • remove setup.cfg
  • remove setup.py
  • remove .bettercodehub.yml
  • remove .travis.yml
  • update black config

v2.0.5

2022-06-02: correct mypy type error

v2.0.4.2

2022-06-01: update to github actions checkout@v3 and setup-python@v3

v2.0.4.1

2022-06-01: update github actions test matrix

v2.0.4

2022-03-29: remedy mypy Untyped decorator makes function "cli_info" untyped

v2.0.3

2022-03-25: fix github actions windows test

v2.0.1

2021-11-22: Patch Release
  • fix tests

v2.0.0

2021-11-22: Major Release
  • fix "setup.py test"
  • delete some (old) functions

v1.2.0

2021-11-22: Minor Release
  • implement github actions
  • deduplicate code, added lib_detect_testenv as dependency
  • deleted functions which reside now in lib_detect_testenv

v1.1.8

2020-10-09: service release
  • update travis build matrix for linux 3.9-dev
  • update travis build matrix (paths) for windows 3.9 / 3.10

v1.1.7

2020-08-08: service release
  • fix documentation
  • fix travis
  • deprecate pycodestyle
  • implement flake8

v1.1.6

2020-08-01: fix pypi deploy

v1.1.5

2020-07-31: initial release