Initial Commit

Author: Bibo-Joshi

.gitignore

@@ -0,0 +1,165 @@
+# 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/
+docs/_uild/
+
+# 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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/
+
+upload_files/

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.1
+    hooks:
+      # Run the formatter.
+      - id: ruff-format
+      # Run the linter.
+      - id: ruff
+        args:
+          - --fix
+          - --unsafe-fixes
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.372
+    hooks:
+      - id: pyright
+        name: pyright
+        files: ^(?!(tests)).*\.py$
+        additional_dependencies:
+          - aioftp~=0.22
+          - aiorem~=0.0.2
+          - pydantic-settings~=2.3
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.16.0
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py312-plus

README.rst

@@ -0,0 +1,35 @@
+``akadressen-upload``
+=====================
+
+Small helper script to upload new AkaDressen files to internal section of the `AkaBlas <https://akablas.de>`_ Homepage.
+It requires Python 3.12+.
+
+Setting in up
+-------------
+
+Create a file ``.env`` with the following contents:
+
+.. code-block::
+
+    FTP_host=<host address of the ftp server>
+    FTP_USERNAME=<username>
+    FTP_PASSWORD=<password>
+    SOURCE_PATH=<path to the folder containing the files to upload>
+    TARGET_PATH=<path to the folder on the ftp server where the files should be uploaded>
+
+Usage
+-----
+
+Run the script with the following command:
+
+.. code-block:: shell
+
+    python main.py
+
+How It Works
+------------
+
+The script does the following:
+
+1. Rename all files starting with ``latest_``. The new prefix is the modification date of the file.
+2. Upload all files to the ftp server. The files will be prefixed with ``latest_``.

main.py

@@ -0,0 +1,17 @@
+import asyncio
+import logging
+
+from uploader import AkaDressenUploader
+
+logging.basicConfig(
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
+)
+
+
+async def do_upload():
+    async with AkaDressenUploader() as uploader:
+        await uploader.do_akadressen_upload()
+
+
+if __name__ == "__main__":
+    asyncio.run(do_upload())

pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "akadressen-upload"
+verison = "0.0.1"
+description = 'Simple helper to upload new AkaDressen to the Hompage'
+readme = "README.rst"
+requires-python = ">=3.12"
+license = "MIT"
+authors = [
+    { name = "Hinrich Mahler", email = "[email protected]" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.12",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "aioftp~=0.22",
+    "aiorem~=0.0.2",
+    "pydantic-settings~=2.3",
+]
+
+# RUFF:
+[tool.ruff]
+line-length = 99
+show-fixes = true
+
+[tool.ruff.lint]
+preview = true
+explicit-preview-rules = true
+select = ["E", "F", "I", "PL", "UP", "RUF", "PTH", "C4", "B", "PIE", "SIM", "RET", "RSE",
+    "G", "ISC", "PT", "ASYNC", "TCH", "SLOT", "PERF", "PYI", "FLY", "AIR", "RUF022",
+    "RUF023", "Q", "INP", "W", "YTT", "DTZ", "ARG"]
+ignore = ["ISC001"]
+
+[tool.ruff.lint.isort]
+split-on-trailing-comma = false
+
+[tool.ruff.format]
+docstring-code-format = true
+skip-magic-trailing-comma = true
+
+# MYPY:
+[tool.mypy]
+warn_unused_ignores = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+disallow_untyped_decorators = true
+show_error_codes = true
+python_version = "3.12"

uploader/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ["AkaDressenUploader", "Settings"]
+
+from ._settings import Settings
+from ._uploader import AkaDressenUploader

uploader/_settings.py

@@ -0,0 +1,22 @@
+from pathlib import Path
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    """Settings to use. They can also be specified in a `.env` file."""
+
+    model_config = SettingsConfigDict(env_file=".env")
+
+    ftp_host: str
+    """The host address of the FTP server."""
+    ftp_port: int = 21
+    """The port of the FTP server. Default is 21."""
+    ftp_username: str
+    """The username for the FTP server."""
+    ftp_password: str
+    """The password for the FTP server."""
+    source_path: Path
+    """The path to the source files that will be uploaded."""
+    target_path: Path
+    """The path on the FTP server where the files will be uploaded."""