alpha

.github/workflows/ci_cd.yml

@@ -0,0 +1,148 @@
+name: Push commit
+on:
+  release:
+    types: [ created ]
+  push:
+    branches:
+      - '*'
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  ruff:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Run ruff
+        run: |
+          pip install ruff==0.5.1
+          ruff check -q
+
+  build:
+    runs-on: ubuntu-22.04
+    needs: [ ruff ]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: 1.8.4
+      - name: Build
+        run: |
+          if [[ '${{ github.event_name }}' = 'release' ]]; then
+             sed -i -e "s/0.dev.0/$GITHUB_REF_NAME/g" pyproject.toml
+          fi
+          poetry build
+          mkdir ripley_build
+          mv ./dist ./ripley_build
+      - name: Upload ripley package
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: ripley_build
+          retention-days: 90
+      - name: Upload pyproject.toml
+        uses: actions/upload-artifact@v4
+        with:
+          name: pyproject.toml
+          path: pyproject.toml
+          retention-days: 90
+      - name: Upload README.md
+        uses: actions/upload-artifact@v4
+        with:
+          name: README.md
+          path: README.md
+          retention-days: 90
+
+  tests:
+    runs-on: ubuntu-22.04
+    permissions: write-all
+    needs: [ build ]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: 1.8.4
+      - name: Download ripley package
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+      - uses: hoverkraft-tech/[email protected]
+        with:
+          services: |
+            clickhouse
+            s3
+          up-flags: "-d"
+      - name: Install test dependencies, ripley and run tests
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          rm -r ripley
+          poetry config virtualenvs.create false
+          poetry lock --no-update
+          poetry install --only=dev
+          pip install --no-index -f ./dist ripley
+          pip install pytest-cov
+          pytest --doctest-modules --junitxml=test-results-${{ matrix.python-version }}.xml
+      - name: Upload pytest results
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-${{ matrix.python-version }}.xml
+          path: test-results-${{ matrix.python-version }}.xml
+          retention-days: 90
+        if: always()
+      - name: Download test report
+        uses: actions/download-artifact@v4
+        if: always()
+        with:
+          name: test-results-${{ matrix.python-version }}.xml
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action/macos@v2
+        if: always()
+        with:
+          files: |
+            test-results-${{ matrix.python-version }}.xml
+
+  publish_to_PyPi:
+    runs-on: ubuntu-22.04
+    needs: [ tests ]
+    if: github.event_name == 'release' && github.event.action == 'created'
+    steps:
+      - uses: actions/setup-python@v5
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: 1.8.4
+      - name: Download ripley package
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+      - name: Download pyproject.toml
+        uses: actions/download-artifact@v4
+        with:
+          name: pyproject.toml
+      - name: Download README.md
+        uses: actions/download-artifact@v4
+        with:
+          name: README.md
+      - name: Publish ripley package
+        run: |
+          poetry config pypi-token.pypi ${{ secrets.pypi_password }}
+          poetry publish

.gitignore

@@ -0,0 +1,164 @@
+# 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/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/
+
+test-results*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Danila Ganchar
+
+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.

README.md

@@ -0,0 +1,15 @@
+# Ripley
+
+**Ripley** provides a simple interface for routine db operations and data maintenance. The main idea:
+
+- no dependencies
+- no error handlers
+- no package errors
+- isolation from the database driver
+
+Implementations: [Clickhouse](https://clickhouse.com/)
+
+<hr/>
+
+
+[![Python versions](https://img.shields.io/badge/Package-Info-blue?logo=hackthebox)](https://d-ganchar.github.io/ripley.html)

docker-compose.yml

@@ -0,0 +1,27 @@
+version: '3.8'
+
+services:
+  clickhouse:
+    image: clickhouse/clickhouse-server:23.4.2.11-alpine
+    container_name: ripley_clickhouse
+    network_mode: host
+    logging:
+      driver: none
+    healthcheck:
+      test: wget --no-verbose --tries=1 --spider localhost:8123/ping || exit 1
+      interval: 2s
+      timeout: 2s
+      retries: 16
+
+  s3:
+    image: quay.io/minio/minio:RELEASE.2024-10-13T13-34-11Z
+    network_mode: host
+    logging:
+      driver: none
+    command:
+      - server
+      - --address=localhost:9001
+      - /data
+    environment:
+      - MINIO_ROOT_USER=ripley_key
+      - MINIO_ROOT_PASSWORD=ripley_secret