OTAnalytics 0.5.3__tar.gz

otanalytics-0.5.3/.flake8

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length=88
+docstring-convention=google
+extend-ignore=E203
+exclude=
+	venv
+	.venv

otanalytics-0.5.3/.github/dependabot.yml

@@ -0,0 +1,25 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+    reviewers:
+      - "briemla"
+    assignees:
+      - "briemla"
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+    reviewers:
+      - "briemla"
+    assignees:
+      - "briemla"

otanalytics-0.5.3/.github/workflows/benchmark.yml

@@ -0,0 +1,52 @@
+---
+name: Benchmark Test With Pytest
+on:
+  schedule:
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  deployments: write
+  packages: write
+
+jobs:
+  benchmark:
+    name: Run pytest-benchmark benchmark
+    runs-on: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Download test data
+        run: |
+          gh release download \
+          --pattern 'OTCamera19_FR20_2023-05-24_06-00-00_11-45-00.zip' \
+          --pattern 'OTCamera19_FR20_2023-05-24_00-00-00.zip' \
+          -R platomo/OpenTrafficCam-testdata -D tests/data
+        env:
+          GH_TOKEN: ${{ secrets.PLATOMO_OTC_TESTDATA_ACCESS }}
+      - name: Unzip test data
+        run: |
+          cd tests/data
+          unzip ./\*.zip
+          rm ./*.zip
+          cd ..
+      - name: Install requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+      - name: Run benchmark tests
+        run: pytest ./tests/benchmark_otanalytics.py --benchmark-json output.json
+      - name: Store benchmark result
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Python Benchmark with pytest-benchmark
+          tool: "pytest"
+          output-file-path: output.json
+          auto-push: true
+          alert-threshold: "200%"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-on-alert: true
+          fail-on-alert: true

otanalytics-0.5.3/.github/workflows/build-nightly.yml

@@ -0,0 +1,33 @@
+---
+name: Build Nightly Version
+
+on:
+  # Creates Nightly Release of main
+  # Needs: secrets.PLATOMO_BUILDER_ACCESS
+  push:
+    branches:
+      - main
+
+permissions: read-all
+
+jobs:
+  test:
+    uses: "./.github/workflows/test.yml"
+  regression-test:
+    uses: "./.github/workflows/regression-test.yml"
+    secrets: inherit
+  create_nightly:
+    permissions:
+      contents: write
+    needs:
+      - test
+      - regression-test
+    uses: "platomo/GitHub-workflows/.github/workflows/reusable-create-release-with-assets.yml@main"
+    secrets:
+      PLATOMO_BUILDER_ACCESS: ${{ secrets.PLATOMO_BUILDER_ACCESS }}
+    with:
+      package-version: nightly
+      package-path: OTAnalytics
+      draft-release: false
+      pre-release: true
+      delete-existing: true

otanalytics-0.5.3/.github/workflows/build-release.yml

@@ -0,0 +1,35 @@
+---
+name: Build Release Version
+
+on:
+  # Create release if tag is pushed to main.
+  # Needs: secrets.PLATOMO_BUILDER_ACCESS
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions: read-all
+
+jobs:
+  test:
+    if: endsWith(github.event.base_ref, 'main')
+    uses: "./.github/workflows/test.yml"
+  regression-test:
+    if: endsWith(github.event.base_ref, 'main')
+    uses: "./.github/workflows/regression-test.yml"
+    secrets: inherit
+  create_release:
+    permissions:
+      contents: write
+    needs:
+      - test
+      - regression-test
+    uses: "platomo/GitHub-workflows/.github/workflows/reusable-create-release-with-assets.yml@main"
+    secrets:
+      PLATOMO_BUILDER_ACCESS: ${{ secrets.PLATOMO_BUILDER_ACCESS }}
+    with:
+      package-version: ${{ github.ref_name }}
+      package-path: OTAnalytics
+      draft-release: false
+      pre-release: false
+      delete-existing: false

otanalytics-0.5.3/.github/workflows/linter.yml

@@ -0,0 +1,43 @@
+---
+name: super-linter
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+on: pull_request
+
+permissions:
+  contents: read
+  packages: read
+  # To report GitHub Actions status checks
+  statuses: write
+
+jobs:
+  lint:
+    name: Lint many languages with super-linter
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          # super-linter needs the full git history to get the
+          # list of files that changed across commits
+          fetch-depth: 0
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v7
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VALIDATE_GO_RELEASER: false
+          VALIDATE_PYTHON_PYLINT: false
+          VALIDATE_PYTHON_MYPY: false
+          VALIDATE_JSCPD: false
+          VALIDATE_PYTHON_BLACK: false
+          VALIDATE_PYTHON_PYINK: false
+
+          LINTER_RULES_PATH: /
+          PYTHON_FLAKE8_CONFIG_FILE: .flake8
+          PYTHON_ISORT_CONFIG_FILE: pyproject.toml
+          YAML_CONFIG_FILE: .yamllint.yaml

otanalytics-0.5.3/.github/workflows/regression-test.yml

@@ -0,0 +1,39 @@
+---
+name: Regression Test With Pytest
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_call:
+
+permissions: read-all
+
+jobs:
+  regression-test:
+    name: Run pytest regression test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Download test data
+        run: |
+          gh release download \
+          --pattern 'OTCamera19_FR20_2023-05-24_06-00-00_11-45-00.zip' \
+          --pattern 'OTCamera19_FR20_2023-05-24_00-00-00.zip' \
+          -R platomo/OpenTrafficCam-testdata -D tests/data
+        env:
+          GH_TOKEN: ${{ secrets.PLATOMO_OTC_TESTDATA_ACCESS }}
+      - name: Unzip test data
+        run: |
+          cd tests/data
+          unzip ./\*.zip
+          rm ./*.zip
+          cd ..
+      - name: Install requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+      - name: Run regression tests
+        run: pytest ./tests/regression_otanalytics.py

otanalytics-0.5.3/.github/workflows/release-pypi.yml

@@ -0,0 +1,60 @@
+---
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions: read-all
+
+env:
+  out_dir: "dist/"
+
+jobs:
+  test:
+    if: endsWith(github.event.base_ref, 'main')
+    uses: "./.github/workflows/test.yml"
+  regression-test:
+    if: endsWith(github.event.base_ref, 'main')
+    uses: "./.github/workflows/regression-test.yml"
+    secrets: inherit
+  publish-to-pypi:
+    runs-on: ubuntu-latest
+    needs:
+      - test
+      - regression-test
+    environment:
+      name: pypi
+      url: https://pypi.org/p/OTAnalytics
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Update Python Package Version
+        uses: platomo/update-version-py-action@v1.0.0
+        with:
+          version: ${{ github.ref_name }}
+          file-path: "OTAnalytics"
+      - name: Install pypa/build
+        shell: bash
+        run: |
+          python3 -m pip install build --user
+
+      - name: Build a binary wheel and a source tarball
+        shell: bash
+        run: python -m build --sdist --wheel --outdir ${{ env.out_dir }}
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: ${{ env.out_dir }}
+
+      - name: Publish distribution
+        uses: pypa/gh-action-pypi-publish@release/v1

otanalytics-0.5.3/.github/workflows/release-testpypi.yml

@@ -0,0 +1,60 @@
+---
+name: Publish to TestPyPI
+
+on:
+  push:
+    branches:
+      - main
+
+permissions: read-all
+
+env:
+  out_dir: "dist/"
+
+jobs:
+  test:
+    uses: "./.github/workflows/test.yml"
+  regression-test:
+    uses: "./.github/workflows/regression-test.yml"
+    secrets: inherit
+  publish-to-testpypi:
+    runs-on: ubuntu-latest
+    needs:
+      - test
+      - regression-test
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/OTAnalytics
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Update Python Package Version
+        uses: platomo/update-version-py-action@v1.0.1
+        with:
+          version: nightly
+          file-path: "OTAnalytics"
+      - name: Install pypa/build
+        shell: bash
+        run: |
+          python3 -m pip install build --user
+
+      - name: Build a binary wheel and a source tarball
+        shell: bash
+        run: python -m build --sdist --wheel --outdir ${{ env.out_dir }}
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: ${{ env.out_dir }}
+
+      - name: Publish distribution
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: ${{ vars.PYPI_REPO_URL }}

otanalytics-0.5.3/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+---
+name: Test
+
+on:
+  # Run tests each time a PR is opened or changed.
+  # Allow other Workflows (e.g., build workflows) to call this workflow.
+  pull_request:
+  workflow_call:
+
+permissions: read-all
+
+jobs:
+  test:
+    name: Execute tests across various operating systems and Python versions.
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        py: ["3.11"]
+      fail-fast: true
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Run Python Tests
+        uses: platomo/test-python-app-action@v1.0.5
+        timeout-minutes: 60
+        with:
+          py-version: ${{ matrix.py }}
+          package-path: OTAnalytics
+          test-path: tests

otanalytics-0.5.3/.gitignore

@@ -0,0 +1,177 @@
+# OTAnalytics
+data/
+!tests/data
+tests/data/OTCamera19_FR20_2023-05-24*
+tests/scripts/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDEA Ignores #
+*.iml
+*.ipr
+*.iws
+.idea/
+out/
+local.properties
+
+# OS generated files #
+.DS_Store
+.DS_Store?
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Visual Studio Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/scripts
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Vim
+.vim
+
+#profiling
+profiles/

otanalytics-0.5.3/.pre-commit-config.yaml

@@ -0,0 +1,87 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: check-json
+      - id: end-of-file-fixer
+        exclude_types:
+          - json
+      - id: trailing-whitespace
+      - id: no-commit-to-branch
+      - id: debug-statements
+      - id: requirements-txt-fixer
+      - id: check-executables-have-shebangs
+      - id: detect-private-key
+  - repo: local
+    hooks:
+      - id: update-type-stubs
+        name: Check for Type Stubs and Update Config
+        entry: ./update_precommit.py
+        language: system
+        files: ^requirements.*\.txt$
+        stages:
+          - pre-commit
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.1
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args:
+          - --profile
+          - black
+  - repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.12.1
+    hooks:
+      - id: mypy
+        entry: mypy OTAnalytics tests --config-file=pyproject.toml
+        additional_dependencies:
+          - av==13.0.0
+          - black==24.8.0
+          - customtkinter==5.2.2
+          - hatch-requirements-txt==0.4.1
+          - ijson==3.3.0
+          - interrogate==1.7.0
+          - isort==5.13.2
+          - matplotlib==3.9.0
+          - more-itertools==10.5.0
+          - mypy==1.12.1
+          - numpy==1.26.4
+          - pandas-stubs==2.2.3.241126
+          - pandas==2.2.3
+          - pre-commit==4.1.0
+          - pygeos==0.14
+          - pytest-benchmark==5.1.0
+          - pytest-cov==6.0.0
+          - pytest-lazy-fixtures==1.1.2
+          - pytest==8.3.4
+          - twine==6.1.0
+          - types-PyYAML
+          - types-flake8
+          - types-openpyxl
+          - types-pillow
+          - types-seaborn
+          - types-shapely
+          - types-tqdm
+          - types-ujson
+          - yamllint==1.35.1
+        always_run: true
+        pass_filenames: false
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args:
+          - -c=./.yamllint.yaml
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.10.0
+    hooks:
+      - id: shellcheck

otanalytics-0.5.3/.run/Scalene-CLI (benchmark).run.xml

@@ -0,0 +1,25 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Scalene-CLI (benchmark)" type="PythonConfigurationType" factoryName="Python">
+    <module name="OTAnalytics" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+    </envs>
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="SCRIPT_NAME" value="scalene" />
+    <option name="PARAMETERS" value="--- $PROJECT_DIR$/OTAnalytics/__main__.py --cli --config &quot;tests/data/OTCamera19_FR20_2023-05-24.otconfig&quot; --logfile_overwrite" />
+    <option name="SHOW_COMMAND_LINE" value="false" />
+    <option name="EMULATE_TERMINAL" value="false" />
+    <option name="MODULE_MODE" value="true" />
+    <option name="REDIRECT_INPUT" value="false" />
+    <option name="INPUT_FILE" value="" />
+    <method v="2" />
+  </configuration>
+</component>