mailsort 0.0.1__tar.gz

mailsort-0.0.1/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

mailsort-0.0.1/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, Jan Janssen
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

mailsort-0.0.1/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.5
+Name: mailsort
+Version: 0.0.1
+Summary: Assign labels to emails on any IMAP mail server based on their similarity to other emails assigned to the same label.
+Project-URL: Homepage, https://github.com/jan-janssen/mailsort
+Author-email: Jan Janssen <jan.janssen@outlook.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Requires-Dist: numpy>=2.5.1
+Requires-Dist: pandas>=3.0.5
+Requires-Dist: scikit-learn>=1.9.0
+Requires-Dist: sqlalchemy>=2.0.52
+Requires-Dist: tqdm>=4.70.1
+Description-Content-Type: text/markdown
+
+# mailsort
+[![Python package](https://github.com/jan-janssen/mailsort/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/jan-janssen/mailsort/actions/workflows/unittest.yml)
+[![codecov](https://codecov.io/github/jan-janssen/mailsort/graph/badge.svg)](https://codecov.io/github/jan-janssen/mailsort)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Assign labels to emails on any IMAP mail server based on their similarity to other emails already
+assigned to the same label.
+
+`mailsort` connects to a mail account over plain IMAP, trains a machine learning model on the labels
+(IMAP folders) you have already assigned, and uses that model to suggest or apply labels to new
+messages. It has no dependency on Google APIs - for Gmail-specific features (OAuth, the Gmail label
+API, the sorting daemon and web UI) see [gmailsorter](https://github.com/jan-janssen/gmailsorter),
+which depends on `mailsort` for the shared IMAP and machine learning core.
+
+## Installation
+```
+pip install mailsort
+```
+
+## Command line interface
+```
+mailsort --host imap.example.com --username user@example.com -u
+mailsort --host imap.example.com --username user@example.com -l "some_label"
+```
+The IMAP password is read from the `IMAP_PASSWORD` environment variable (configurable with
+`--password-env`).
+
+## Python interface
+```python
+from mailsort import Imap
+
+imap = Imap(
+    host="imap.example.com",
+    port=993,
+    username="user@example.com",
+    password="...",
+    connection_str="sqlite:///email.db",
+)
+imap.update_database(quick=False)
+imap.fit_machine_learning_model_to_database()
+imap.filter_messages_from_server(label="some_label", recommendation_ratio=0.9)
+```

mailsort-0.0.1/README.md

@@ -0,0 +1,42 @@
+# mailsort
+[![Python package](https://github.com/jan-janssen/mailsort/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/jan-janssen/mailsort/actions/workflows/unittest.yml)
+[![codecov](https://codecov.io/github/jan-janssen/mailsort/graph/badge.svg)](https://codecov.io/github/jan-janssen/mailsort)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Assign labels to emails on any IMAP mail server based on their similarity to other emails already
+assigned to the same label.
+
+`mailsort` connects to a mail account over plain IMAP, trains a machine learning model on the labels
+(IMAP folders) you have already assigned, and uses that model to suggest or apply labels to new
+messages. It has no dependency on Google APIs - for Gmail-specific features (OAuth, the Gmail label
+API, the sorting daemon and web UI) see [gmailsorter](https://github.com/jan-janssen/gmailsorter),
+which depends on `mailsort` for the shared IMAP and machine learning core.
+
+## Installation
+```
+pip install mailsort
+```
+
+## Command line interface
+```
+mailsort --host imap.example.com --username user@example.com -u
+mailsort --host imap.example.com --username user@example.com -l "some_label"
+```
+The IMAP password is read from the `IMAP_PASSWORD` environment variable (configurable with
+`--password-env`).
+
+## Python interface
+```python
+from mailsort import Imap
+
+imap = Imap(
+    host="imap.example.com",
+    port=993,
+    username="user@example.com",
+    password="...",
+    connection_str="sqlite:///email.db",
+)
+imap.update_database(quick=False)
+imap.fit_machine_learning_model_to_database()
+imap.filter_messages_from_server(label="some_label", recommendation_ratio=0.9)
+```

mailsort-0.0.1/pyproject.toml

@@ -0,0 +1,94 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "mailsort"
+dynamic = ["version"]
+description = "Assign labels to emails on any IMAP mail server based on their similarity to other emails assigned to the same label."
+readme = "README.md"
+license = "BSD-3-Clause"
+authors = [
+    { name = "Jan Janssen", email = "jan.janssen@outlook.com" },
+]
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "numpy>=2.5.1",
+    "tqdm>=4.70.1",
+    "pandas>=3.0.5",
+    "scikit-learn>=1.9.0",
+    "sqlalchemy>=2.0.52",
+]
+
+[project.urls]
+Homepage = "https://github.com/jan-janssen/mailsort"
+
+[project.scripts]
+mailsort = "mailsort.__main__:command_line_parser"
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # flake8-comprehensions
+    "C4",
+    # eradicate
+    "ERA",
+    # pylint
+    "PL",
+]
+ignore = [
+    # ignore line-length violations
+    "E501",
+    # Too many arguments in function definition
+    "PLR0913",
+    # Too many not-keyword-only arguments,
+    "PLR0917",
+]
+
+[tool.hatch.build]
+include = [
+    "src/mailsort"
+]
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/mailsort/_version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/mailsort",
+    "LICENSE"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "src/mailsort"
+]
+
+[tool.hatch.version]
+source = "vcs"
+path = "src/mailsort/_version.py"
+
+[tool.coverage.run]
+source = ["mailsort"]
+command_line = "-m unittest discover tests"

mailsort-0.0.1/src/mailsort/__init__.py

@@ -0,0 +1,6 @@
+from mailsort.local import Imap
+
+from . import _version
+
+__version__: str = _version.__version__
+__all__ = ["Imap"]

mailsort-0.0.1/src/mailsort/__main__.py

@@ -0,0 +1,99 @@
+import argparse
+import os
+
+from mailsort import Imap
+
+
+def command_line_parser():
+    """
+    Main function primarily used for the command line interface of the IMAP backend
+    """
+    parser = argparse.ArgumentParser(prog="mailsort")
+    parser.add_argument(
+        "--host",
+        help="IMAP server hostname e.g. imap.example.com .",
+    )
+    parser.add_argument(
+        "--port",
+        type=int,
+        default=993,
+        help="IMAP server port - default: 993 .",
+    )
+    parser.add_argument(
+        "--username",
+        help="IMAP account username.",
+    )
+    parser.add_argument(
+        "--password-env",
+        default="IMAP_PASSWORD",
+        help=(
+            "Name of the environment variable holding the IMAP account password - "
+            "default: IMAP_PASSWORD ."
+        ),
+    )
+    parser.add_argument(
+        "--no-ssl",
+        action="store_true",
+        help="Connect without SSL (IMAP4 instead of IMAP4_SSL).",
+    )
+    parser.add_argument(
+        "-d",
+        "--database",
+        help="Connection string to connect to database e.g. sqlite:///email.db .",
+    )
+    parser.add_argument(
+        "-u",
+        "--update",
+        action="store_true",
+        help="Update local database and retrain machine learning model.",
+    )
+    parser.add_argument(
+        "-i",
+        "--identification",
+        help="User ID of the database user e.g. 1 .",
+    )
+    parser.add_argument(
+        "-l",
+        "--label",
+        help="Email label (IMAP folder) to be filtered with machine learning.",
+    )
+    args = parser.parse_args()
+    db_user_id = int(args.identification) if args.identification else 1
+    password = os.environ.get(args.password_env)
+    if not args.host or not args.username:
+        print("Please provide --host and --username.")
+    elif not password:
+        print(
+            f"Please set the {args.password_env} environment variable to your IMAP password."
+        )
+    else:
+        database = args.database or "sqlite:///email.db"
+        imap = Imap(
+            host=args.host,
+            port=args.port,
+            username=args.username,
+            password=password,
+            connection_str=database,
+            db_user_id=db_user_id,
+            use_ssl=not args.no_ssl,
+            email_download_format="metadata",
+        )
+        if args.update:
+            imap.update_database(quick=False)
+            imap.fit_machine_learning_model_to_database(
+                n_estimators=100,
+                max_features=400,
+                random_state=42,
+                bootstrap=True,
+                include_deleted=False,
+            )
+        elif args.label:
+            imap.filter_messages_from_server(
+                label=args.label, recommendation_ratio=0.9, label_prefix="labels_"
+            )
+        else:
+            parser.print_help()
+
+
+if __name__ == "__main__":
+    command_line_parser()

mailsort-0.0.1/src/mailsort/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)
+
+__commit_id__ = commit_id = None

mailsort-0.0.1/src/mailsort/base/__init__.py

@@ -0,0 +1,3 @@
+from mailsort.base.database import get_email_database
+
+__all__ = ["get_email_database"]