Skip to main content

get reliably the name of the executed script

Project description

lib_programname

Version v2.0.1 as of 2021-11-24 see Changelog

build_badge license jupyter pypi black

codecov better_code Maintainability Maintainability Code Coverage snyk

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 recent linux with python 3.6, 3.7, 3.8, 3.9, 3.10.0, pypy-3.8 - 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 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 from source code:
# cd ~
$ git clone https://github.com/bitranox/lib_programname.git
$ cd lib_programname
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
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.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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lib-programname, version 2.0.1
Filename, size File type Python version Upload date Hashes
Filename, size lib_programname-2.0.1.tar.gz (10.9 kB) File type Source Python version None Upload date Hashes View
Filename, size lib_programname-2.0.1-py3.10.egg (12.1 kB) File type Egg Python version 2.0.1 Upload date Hashes View
Filename, size lib_programname-2.0.1-py3.9.egg (12.1 kB) File type Egg Python version 2.0.1 Upload date Hashes View
Filename, size lib_programname-2.0.1-py3.8.egg (12.1 kB) File type Egg Python version 2.0.1 Upload date Hashes View
Filename, size lib_programname-2.0.1-py3.7.egg (12.0 kB) File type Egg Python version 2.0.1 Upload date Hashes View
Filename, size lib_programname-2.0.1-py3.6.egg (12.0 kB) File type Egg Python version 2.0.1 Upload date Hashes View
Filename, size lib_programname-2.0.1-py3-none-any.whl (8.7 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page