Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

lib_list

Version v1.1.9 as of 2023-07-30 see Changelog

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

some convenience functions for lists


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 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 release from PyPi via pip, including test dependencies:

python -m pip install --upgrade lib_list[test]
  • 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, including test dependencies from source code:

# cd ~
$ git clone https://github.com/bitranox/lib_list.git
$ cd lib_list
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_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.9

2023-07-30:
  • flake 8 E721 do not compare types, for instance checks use isinstance()

v1.1.8

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

v1.1.7

2023-07-13:
  • require minimum python 3.8

  • remove python 3.7 tests

  • 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

  • clean ./tests/test_cli.py

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

Release files for lib-list 1.1.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lib-list 1.1.9
File Size Uploaded
lib_list-1.1.9.tar.gz 29.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lib-list 1.1.9
File Interpreter ABI Platform
lib_list-1.1.9-py3-none-any.whl Python 3 none any Details

Total release size: 39.1 kB

Release files / lib_list-1.1.9.tar.gz

Download URL lib_list-1.1.9.tar.gz
Size 29.2 kB
Tags Source
SHA-256 checksum
How to use checksums
4a64308a4e9dd14b1e83d53f77a53934f31ef04e77e49083a0b67e6ef6affe91
BLAKE2b-256 checksum
How to use checksums
52d3c2afffa00dc9d3911c053d20051d6d4c95f659523b9045948193a6f1f9dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.17

Release files / lib_list-1.1.9-py3-none-any.whl

Download URL lib_list-1.1.9-py3-none-any.whl
Size 9.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
84d5114ac8c0d0a1f43bbe670df0732ee0906c84fe45be9fc5fb4bd01a6f3642
BLAKE2b-256 checksum
How to use checksums
113459572a1d908e20fbf7ec52f3a8664a76bf58e30530dbf987c803d9aaa374
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.17
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page