lib_list

Version v1.1.6 as of 2022-06-03 see Changelog

some convenience functions for lists

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, 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
• 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 the module and check the code - its easy and documented there, including doctest examples.
in case of any questions the usage section might be expanded at a later time

Usage from Commandline

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

  some convenience functions for lists

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_list

• to install the latest version from github via pip:

python -m pip install --upgrade git+https://github.com/bitranox/lib_list.git

• include it into Your requirements.txt:

# Insert following line in Your requirements.txt:
# for the latest Release on pypi:
lib_list

# for the latest development version :
lib_list @ git+https://github.com/bitranox/lib_list.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_list.git
$ cd lib_list
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_list.git
$ cd lib_list

# 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

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

v1.1.6

2022-03-25: implement github actions

v1.1.5

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.4

2020-08-08: service release

• fix documentation
• fix travis
• deprecate pycodestyle
• implement flake8

v1.1.3

2020-08-01: fix pypi deploy

v1.1.2

2020-07-31: fix travis build

0.1.1

2020-07-29: feature release

• use the new pizzacutter template
• use cli_exit_tools

0.1.0

2020-07-16: feature release

• fix cli test
• enable traceback option on cli errors
• manage project with PizzaCutter

0.0.1

2019-09-03: Initial public release