lib-programname 1.1.5

get reliably the name of the executed script

Version 1.1.5 as of 2020-07-31, see changelog

---

lib_programname

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

---

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

Python version required: 3.6.0 or newer

tested on linux “bionic” with python 3.6, 3.7, 3.8, 3.8-dev, pypy3

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

---

• Try it Online

• Usage

• Usage from Commandline

• Installation and Upgrade

• Requirements

• Acknowledgements

• Contribute

• Report Issues

• Pull Request

• Code of Conduct

• License

• Changelog

---

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
python -m pip --upgrade wheel

• to install the latest release from PyPi via pip (recommended):

# install latest release from PyPi
python -m pip install --upgrade lib_programname

# test latest release from PyPi without installing (can be skipped)
python -m pip install lib_programname --install-option test

• to install the latest development version from github via pip:

# normal install
python -m pip install --upgrade git+https://github.com/bitranox/lib_programname.git

# to test without installing (can be skipped)
python -m pip install git+https://github.com/bitranox/lib_programname.git --install-option test

# to install and upgrade all dependencies regardless of version number
python -m pip install --upgrade git+https://github.com/bitranox/lib_programname.git --upgrade-strategy eager

• 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 from source code:

# cd ~
$ git clone https://github.com/bitranox/lib_programname.git
$ cd lib_programname

# to test without installing (can be skipped)
python setup.py test

# normal install
python setup.py install

• 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 @ git+https://github.com/bitranox/cli_exit_tools.git

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

tasks:

• python 3.9 changes, __main__ should be now absolut path - check it

1.1.5 2020-07-31: initial release