Initial commit with pymetrius

.github/workflows/lint_and_docs.yaml

@@ -0,0 +1,52 @@
+name: PEP8, Types and Docs Check
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel previous run
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      # use poetry and cache installed packages, see https://github.com/marketplace/actions/python-poetry-action
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+      - uses: actions/cache@v3
+        name: Define a cache for the virtual environment based on the dependencies lock file
+        with:
+          path: ./.venv
+          key: venv-${{ hashFiles('poetry.lock') }}
+      - name: Install the project dependencies
+        run: |
+          poetry install --with dev
+      - name: Lint
+        run: poetry run poe lint
+      - name: Types
+        run: poetry run poe type-check
+      - name: Docs
+        run: poetry run poe doc-build
+      - name: Prepare Pages
+        if: github.ref == 'refs/heads/main'
+        run: |
+          mv docs/_build/* public/
+      - name: Deploy Pages
+        uses: JamesIves/[email protected]
+        if: github.ref == 'refs/heads/main'
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: public
+          TARGET_FOLDER: .
+          CLEAN: true
+          SINGLE_COMMIT: true

.github/workflows/publish.yaml

@@ -0,0 +1,27 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          if [ -z "${PYPI_TOKEN}" ]; then echo "Set the PYPI_TOKEN variable in your repository secrets"; exit 1; fi  
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry config repositories.pypi https://pypi.org/legacy
+          poetry publish --build --repository pypi

.github/workflows/pytest.yml

@@ -0,0 +1,45 @@
+name: Ubuntu
+
+on: [push, pull_request]
+
+jobs:
+  cpu:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+    strategy:
+      matrix:
+        python-version: [3.11]
+    steps:
+      - name: Cancel previous run
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      # use poetry and cache installed packages, see https://github.com/marketplace/actions/python-poetry-action
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+      - uses: actions/cache@v3
+        name: Define a cache for the virtual environment based on the dependencies lock file
+        with:
+          path: ./.venv
+          key: venv-${{ hashFiles('poetry.lock') }}
+      - name: Install the project dependencies
+        run: poetry install --with dev
+      - name: Test with pytest
+        run: poetry run poe test
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV }}
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

.github/workflows/windows_mac_test.yml

@@ -0,0 +1,40 @@
+name: Windows/MacOS
+
+on: [push, pull_request]
+
+jobs:
+  cpu-extra:
+    runs-on: ${{ matrix.os }}
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest]
+        python-version: [3.11]
+    steps:
+      - name: Cancel previous run
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      # use poetry and cache installed packages, see https://github.com/marketplace/actions/python-poetry-action
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+      - uses: actions/cache@v3
+        name: Define a cache for the virtual environment based on the dependencies lock file
+        with:
+          path: ./.venv
+          key: venv-${{ hashFiles('poetry.lock') }}
+      - name: Install the project dependencies
+        # ugly as hell, but well...
+        # see https://github.com/python-poetry/poetry/issues/7611
+        run: poetry install --with dev || poetry install --with dev || poetry install --with dev
+      - name: Test with pytest
+        run: poetry run poe test-subset

.gitignore

@@ -0,0 +1,138 @@
+#
+.idea
+config_local.json
+temp
+
+# 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/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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/
+
+# reports
+pylint.html
+.pylint.d

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+default_install_hook_types: [commit-msg, pre-commit]
+default_stages: [commit, manual]
+fail_fast: false
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+  - repo: local
+    hooks:
+      - id: ruff
+        name: ruff
+        entry: poetry run ruff
+        require_serial: true
+        language: system
+        types: [python]
+      - id: ruff-nb
+        name: ruff-nb
+        entry: poetry run nbqa ruff .
+        require_serial: true
+        language: system
+        pass_filenames: false
+        types: [python]
+      - id: black
+        name: black
+        entry: poetry run black
+        require_serial: true
+        language: system
+        types: [python]
+      - id: poetry-check
+        name: poetry check
+        entry: poetry check
+        language: system
+        files: pyproject.toml
+        pass_filenames: false
+      - id: poetry-lock-check
+        name: poetry lock check
+        entry: poetry check
+        args: [--lock]
+        language: system
+        pass_filenames: false
+      - id: mypy
+        name: mypy
+        entry: poetry run mypy src
+        # filenames should not be passed as they would collide with the config in pyproject.toml
+        pass_filenames: false
+        files: '^src(/[^/]*)*/[^/]*\.py$'
+        language: system
+      - id: mypy-nb
+        name: mypy-nb
+        entry: poetry run nbqa mypy
+        language: system

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.0 - Initial Release
+
+### Features:
+
+### Development:
+
+- Initial setup by python-library-template
+

README.md

@@ -0,0 +1,8 @@
+# armscan_env
+
+Welcome to the armscan_env library!
+
+
+## Contributing
+Please open new issues for bugs, feature requests and extensions. See more details about the structure and
+workflow in the [contributing page](CONTRIBUTING.md).

config.json

@@ -0,0 +1,10 @@
+{
+  "data_raw": "./data/raw",
+  "data_cleaned": "./data/cleaned",
+  "data_processed": "./data/processed",
+  "data_ground_truth": "./data/ground_truth",
+  "visualizations": "./data/visualizations",
+  "artifacts": "./data/artifacts",
+  "temp": "./temp",
+  "data": "./data"
+}