pymlt 0.0.0__tar.gz → 0.0.9.dev0__tar.gz

pymlt-0.0.9.dev0/.dockerignore

@@ -0,0 +1,2 @@
+# todo: ignore among other things src folder, install should com from pypi
+

pymlt-0.0.9.dev0/.github/CODEOWNERS

@@ -0,0 +1,6 @@
+# specify who owns the code in this repo
+# owner will automatically be included in PR
+
+*  @benvliet
+*.py  @benvliet
+/docs/  @benvliet

pymlt-0.0.9.dev0/.github/pull_request_template.md

@@ -0,0 +1,35 @@
+### Description
+
+Tl;dr if the context of the change is long.  
+A few sentences on the high level context for the change. Link to relevant design docs or discussion.  
+Change is ideally < 500 lines if possible. < 150 is ideal.  
+
+### Checklist
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I have made corresponding changes to the documentation.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have tested these changes locally
+- [ ] I have linked any relevant issues or tickets
+
+## Related Issues
+
+Closes #123  
+Relates to #456  
+
+## Changes
+
+- Added ...
+- Refactored ...
+- Fixed ...
+
+## How to Test
+
+1. Run `...`
+2. Visit `...`
+3. Expect to see `...`
+
+## Notes
+
+- This depends on...
+- Known limitations...

pymlt-0.0.9.dev0/.github/workflows/cd.yml

@@ -0,0 +1,35 @@
+name: CD
+
+on:
+  push:
+    tags:
+      - v*.*.*
+
+jobs:
+  cd:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Build package
+        run: uv build -q
+
+      - name: Publish package
+        run: uv publish -t ${{ secrets.PYPI_TOKEN }}
+
+      - name: Publish image
+        run: |
+          VERSION=$(git describe --tags --always)
+          echo 'build version: $VERSION'
+          docker build -t .
+          docker tag ghcr.io/benvliet/pymlt:$VERSION ghcr.io/benvliet/pymlt:latest
+          docker push ghcr.io/benvliet/pymlt:$VERSION ghcr.io/benvliet/pymlt:latest

pymlt-0.0.9.dev0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+# permissions:
+#   contents: read
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Ruff format check
+        run: echo uvx ruff format --check .  # todo: fix ruff errors
+
+      - name: Ruff lint check
+        run: echo uvx ruff check .  # todo: fix ruff errors
+
+      - name: Sync project env
+        run: uv sync --all-extras
+
+      - name: Run tests
+        run: uv run pytest --cov=src/

pymlt-0.0.9.dev0/.gitignore

@@ -0,0 +1,160 @@
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/

pymlt-0.0.9.dev0/Dockerfile

@@ -0,0 +1,32 @@
+FROM python:3.12-slim
+
+# install git
+RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/*
+
+# update pip
+RUN python -m pip install --upgrade pip
+
+# install uv
+RUN pip install uv
+
+COPY .git .git
+COPY pyproject.toml pyproject.toml
+COPY src/ src/
+COPY scripts/ scripts/
+
+## copy the scripts from the local directory to the container
+## note: pymlt package is installed via uv from pypi
+#COPY ./ /app/
+#
+## set the working directory in the container
+#WORKDIR /app
+#
+## set the environment variable
+#ENV PYTHONPATH="/app"
+
+# install package
+RUN uv sync  # --all-groups
+
+# Default command
+ENTRYPOINT ["python", "-u"]
+CMD ["scripts/train.py"]

pymlt-0.0.9.dev0/Makefile

@@ -0,0 +1,79 @@
+help:
+	@echo available commands: clean, env, format, lint, run, test, wip
+
+remove_env:
+	rm -rf env/
+
+create_env:
+	python3 -m venv env
+	env/bin/pip install --upgrade pip
+	env/bin/pip install -r requirements.txt
+	env/bin/pip install -e .
+	rm -rf *.egg-info
+	@echo done!
+
+upgrade_env:
+	env/bin/pip install -r requirements.txt --upgrade
+
+env: remove_env create_env
+
+create_reqs:
+	pipreqs
+
+run:
+	python3 scripts/clf_train.py
+	pyclean . -q
+
+# todo: add docker commands
+
+mlflow:
+	open http://127.0.0.1:5000/#/
+
+mlflow-clean:
+	rm -rf mlruns
+
+lab_add_env:
+	python -m pip install ipykernel
+	python -m ipykernel install --name=env
+
+lab_list_env:
+	jupyter kernelspec list
+
+lab_uninstall_env:
+	jupyter kernelspec uninstall env
+
+lab:
+	jupyter lab
+
+clean:
+	pyclean . -q
+
+clean-project: clean
+	rm -rf build/
+	rm -rf logs/
+	rm -rf mlruns/
+	rm -rf out/
+
+clean-mlflow:
+	rm -rf mlruns
+
+format:
+	black scripts/ -q
+	black src/ -q
+	black tests/ -q
+	isort scripts/ -q
+	isort src/ -q
+	isort tests/ -q
+
+lint:
+	flake8 scripts/*.py
+	flake8 src/*.py
+
+test:
+	pytest . -v -x --cov=src --cov-fail-under=0
+	rm -rf .pytest_cache
+
+wip: format test
+	git add .
+	git commit -m wip
+	git push

pymlt-0.0.9.dev0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: pymlt
+Version: 0.0.9.dev0
+Summary: Python Machine Learning Toolkit
+Author-email: Ben van Vliet <benvliet@icloud.com>
+License: MIT License
+        
+        Copyright (c) 2023 Ben van Vliet
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: repository, https://github.com/benvliet/pymlt
+Project-URL: issues, https://github.com/benvliet/pymlt/issues
+Project-URL: homepage, https://pypi.org/project/pymlt/
+Keywords: pymlt,machine learning,data science,toolkit,python
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ruff
+Requires-Dist: pandas>=1.1.5
+Requires-Dist: seaborn>=0.12.2
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: tox; extra == "test"
+Dynamic: license-file
+
+# pymlt
+python machine learning template
+
+## links
+https://pypi.org/project/pymlt  
+https://hub.docker.com/r/benvliet/pymlt  # todo: move to ghcr.io  
+https://pepy.tech/projects/pymlt  # todo: add badges  
+https://codecov.io/gh/benvliet/pymlt  # todo: add to pipeline  
+
+## project structure
+
+```
+.
+├── .github/        # Github Actions pipelines
+├── data/           # Data Files for example runs
+├── docs/           # Documentation and templates
+├── src/            # source code
+│   ├── pymlt/      # pymlt package modules
+├── .../            # ...
+├── .../            # ...
+├── .../            # ...
+├── .../            # ...
+```

pymlt-0.0.9.dev0/README.md

@@ -0,0 +1,23 @@
+# pymlt
+python machine learning template
+
+## links
+https://pypi.org/project/pymlt  
+https://hub.docker.com/r/benvliet/pymlt  # todo: move to ghcr.io  
+https://pepy.tech/projects/pymlt  # todo: add badges  
+https://codecov.io/gh/benvliet/pymlt  # todo: add to pipeline  
+
+## project structure
+
+```
+.
+├── .github/        # Github Actions pipelines
+├── data/           # Data Files for example runs
+├── docs/           # Documentation and templates
+├── src/            # source code
+│   ├── pymlt/      # pymlt package modules
+├── .../            # ...
+├── .../            # ...
+├── .../            # ...
+├── .../            # ...
+```