uncojohnco/eg--lsseq

eg--lsseq's Issues

implement - pip-tools

https://github.com/jazzband/pip-tools
https://www.caktusgroup.com/blog/2018/09/18/python-dependency-management-pip-tools/

implement - pytest

https://docs.pytest.org/en/latest/

BUG: `find_matching_frame_substrings` returns match when it should be None

 >>> find_matching_frame_substrings('fileXXX_0040.rgb', 'fileYYY_0041.rgb')  # non matching -return None
Expected nothing
Got:
    SubstrMatch(pos=SubstrPos(start=8, end=12), groups=('0040', '0041'))

Create documentation

https://packaging.python.org/tutorials/creating-documentation/

Implement behaviour to short-circuit the test session if a critical test fails

This behaviour seems to only available to work in the module context...

• https://pytest-ordering.readthedocs.io/en/develop/
• https://pypi.org/project/pytest-dependency/
• https://github.com/not-raspberry/pytest_reorder
• https://stackoverflow.com/questions/59379412/pytest-mark-a-test-as-a-must-pass-and-stop-testing-if-it-fails
• https://docs.pytest.org/en/latest/example/simple.html#incremental-testing-test-steps

implement - github-changelog-generator

https://github.com/github-changelog-generator/github-changelog-generator

BUG: TOX virtualenv is not recreated when deps change

• https://stackoverflow.com/questions/23032580/reinstall-virtualenv-with-tox-when-requirements-txt-or-setup-py-changes/23039826#23039826
• tox-dev/tox#149
• https://github.com/tox-dev/tox-pip-extensions

refactor: lss.util::compact_frame_range - implement groupby

https://docs.python.org/2.6/library/itertools.html#examples
https://stackoverflow.com/a/2154437

implement tox

https://tox.readthedocs.io/en/latest/

Add pytest doctest workflow action

Add - backwards python 2.7 compatibility

Implement frames formater

BUG: lss.lsseq.run() edgecase that is failing

python3 -m doctest -v ./src/lss/lsseq.py

Failed example:
    print(run('../../tests/files/broken_seq'))
Expected:
    5 file01_%04d.rgb 40-42 44-45
    5 file02_%d.rgb 0-4
    4 file%d.03.rgb 1-4
Got:
    6 file01_%04d.rgb 2 40-42 44-45
    4 file%d.03.rgb 1-4

https://github.com/uncojohnco/test-jc--dd-2019/blob/ae7916d62b4f70345a1854fe925519321688a7fc/src/lss/lsseq.py#L156-L159

Implement argparser

Add - Functional tests for vanilla pip install and with --editable

from pathlib import Path
import site
import runpy

# TODO: Have this behavior work  with both - vanilla "pip install" and with --editable

# Works with "pip install --editable ."
# root = Path(__file__).parent.parent
# filepath = str(root.joinpath('src/lss/lss_cli.py'))

# Works with "pip install ."
root = Path(site.getsitepackages()[0])  # TODO: This should be more robust...
filepath = str(root.joinpath('lss/lss_cli.py'))

Implement python-packaging

https://python-packaging.readthedocs.io/en/latest/

Would also allow a user to run a local pip install for lss cmd to available from command line

i.e

git clone https://github.com/uncojohnco/eg--lsseq jc-lsseq
python3 -m pip install ./jc-lsseq

lss ./jc-lsseq/tests/files/ex1

implement pre-commit

https://dev.to/m1yag1/how-to-setup-your-project-with-pre-commit-black-and-flake8-183k

implement github workflow to run on multiple platforms

https://github.com/ymyzk/tox-gh-actions
https://hynek.me/articles/python-github-actions/

tests-doctest-module.yml - WIP

name: Doctest

on:
  push:
    paths:
      - 'src/lss/**'

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      max-parallel: 4
      matrix:
        platform: [ubuntu-latest, macos-latest, windows-latest]
        python-version: [3.8]

    steps:
    - uses: actions/checkout@v1
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v1
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install tox tox-gh-actions
    - name: Run Doctests (temp - ignore )
      run: |
        pytest src/lss --doctest-modules --ignore=notebooks  --ignore=src/lss/lsseq.py
      env:
        PLATFORM: ${{ matrix.platform }}

Enhancement: Action to run unit tests

Deprecate: `Item` object

Item object was originally implemented to resolve the characters representing the frame in a str via doing a comparisons str_parts and str_digits.

This behaviour has been superseded and exists in lss.util::find_matching_frame_substrings

eg--lsseq/src/lss/dataclass/item.py

Lines 19 to 34 in 73dad3e

	class Item:
	"""
	A primitive class for defining an abstract representation of an item.
	The purpose to be used to find the substring representing
	a frame against another item.
	Examples:
	>>> item = Item('mario01_v003.rgb')
	>>> item.name
	'mario01_v003.rgb'
	>>> item.str_parts
	['mario', '_v', '.rgb']
	>>> item.str_digits
	['01', '003']
	"""

eg--lsseq/src/lss/util.py

Lines 11 to 31 in 73dad3e

	def find_matching_frame_substrings(
	str1: str, str2: str,
	strict=True) -> Optional[SubstrMatch]:
	"""
	Diff between str1 and str2 to to resolve the frame representation
	of each string.
	Examples:
	>>> find_matching_frame_substrings('file01_0040.rgb', 'file01_0041.rgb')
	SubstrMatch(pos=SubstrPos(start=7, end=11), groups=('0040', '0041'))
	>>> find_matching_frame_substrings('file1.03.rgb', 'file2.03.rgb')
	SubstrMatch(pos=SubstrPos(start=4, end=5), groups=('1', '2'))
	>>> bool(find_matching_frame_substrings('file02_0040.rgb', 'file01_0041.rgb'))
	False
	:param str1: The string object for comparison against.
	:param str2: The string to compare to the object string.
	:param strict: If True, the length of the digit padding
	must be the same when comparing