bitranox / lib_path_tree

Python Library to handle Directory Trees

lib_programname

Finding the name of the program from which a Python module is running can be trickier than it would seem at first

supports python 3.8 and possibly other dialects.

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

---

• Installation and Upgrade
• Basic Usage
• Requirements
• Acknowledgements
• Contribute
• Report Issues
• Pull Request
• Code of Conduct
• License
• Changelog

---

Installation and Upgrade

From source code:

# normal install
python setup.py install
# test without installing
python setup.py test

via pip latest Release:

# latest Release from pypi
pip install lib_programname

# test without installing
pip install lib_programname --install-option test

via pip latest Development Version:

# upgrade all dependencies regardless of version number (PREFERRED)
pip install --upgrade git+https://github.com/bitranox/lib_programname.git --upgrade-strategy eager
# normal install
pip install --upgrade git+https://github.com/bitranox/lib_programname.git
# test without installing
pip install git+https://github.com/bitranox/lib_programname.git --install-option test

via requirements.txt:

# Insert following line in Your requirements.txt:
# for the latest Release:
lib_programname
# for the latest Development Version :
git+https://github.com/bitranox/lib_programname.git

# to install and upgrade all modules mentioned in requirements.txt:
pip install --upgrade -r /<path>/requirements.txt

via python:

# for the latest Release
python -m pip install upgrade lib_programname

# for the latest Development Version
python -m pip install upgrade git+https://github.com/bitranox/lib_programname.git

Basic Usage

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

Requirements

following modules will be automatically installed :

## Project Requirements

Acknowledgements

• special thanks to "uncle bob" Robert C. Martin, especially for his books on "clean code" and "clean architecture"
• thanks to Dough Hellman for his article about that issue

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

0.1.0

2020-05-15: Initial public release