Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
dolfinus committed Sep 6, 2023
2 parents 3b17ce5 + 9cc37ae commit 39c497b
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 58 deletions.
40 changes: 2 additions & 38 deletions .github/workflows/nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -341,44 +341,8 @@ jobs:
- tests-webdav

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python ${{ env.DEFAULT_PYTHON }}
uses: actions/setup-python@v4
with:
python-version: ${{ env.DEFAULT_PYTHON }}

- name: Cache pip
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-python-${{ env.DEFAULT_PYTHON }}-coverage

- name: Upgrade pip
run: python -m pip install --upgrade pip setuptools wheel

- name: Install dependencies
run: pip install -I coverage pytest

- name: Download all coverage reports
uses: actions/download-artifact@v3
with:
path: reports

- name: Move coverage data to the root folder
run: find reports -type f -exec mv '{}' reports \;

- name: Generate coverate reports
run: ./combine_coverage.sh

- name: Check coverage
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
directory: ./reports
flags: nightly
fail_ci_if_error: true

# Do not send coverage report. Nightly tests are used only to find bugs with new versions of DB and filesystems.

- name: All done
run: echo 1
7 changes: 7 additions & 0 deletions docs/changelog/0.9.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
0.9.3 (2023-09-06)
==================

Bug Fixes
---------

- Fix documentation build
2 changes: 2 additions & 0 deletions docs/changelog/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

DRAFT
NEXT_RELEASE
0.9.3
0.9.2
0.9.1
0.9.0
0.8.1
Expand Down
32 changes: 16 additions & 16 deletions docs/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,34 +176,34 @@ To extract data you can use classes:
+--------------------------------------+-------------------------------------------+---------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`FileDFReader <file-df-reader>` | Read data from a file or set of files | Any :ref:`FileDFConnection <file-df-connections>` | No input, or List[File path on FileSystem] | `Spark DataFrame <https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame>`_ |
+--------------------------------------+-------------------------------------------+---------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`FileDownloader <db-reader>` | Download files from remote FS to local FS | Any :ref:`FileConnection <file-connections>` | No input, or List[File path on remote FileSystem] | :ref:`DownloadResult <download-result>` |
| :ref:`FileDownloader <db-reader>` | Download files from remote FS to local FS | Any :ref:`FileConnection <file-connections>` | No input, or List[File path on remote FileSystem] | :ref:`DownloadResult <file-downloader-result>` |
+--------------------------------------+-------------------------------------------+---------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+

Load data
---------

To load data you can use classes:

+-------------------------------------+----------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
| | Use case | Connection | ``run()`` gets | ``run()`` returns |
+=====================================+==============================================+===================================================+======================================================================================================================================+=====================================+
| :ref:`DBWriter <db-writer>` | Writing data from a DataFrame to a database | Any :ref:`DBConnection <db-connections>` | `Spark DataFrame <https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame>`_ | None |
+-------------------------------------+----------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`FileDFWriter <db-writer>` | Writing data from a DataFrame to a folder | Any :ref:`FileDFConnection <file-df-connections>` | `Spark DataFrame <https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame>`_ | None |
+-------------------------------------+----------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`FileUploader <file-uploader>` | Uploading files from a local FS to remote FS | Any :ref:`FileConnection <file-connections>` | List[File path on local FileSystem] | :ref:`UploadResult <upload-result>` |
+-------------------------------------+----------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+
+-------------------------------------+----------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
| | Use case | Connection | ``run()`` gets | ``run()`` returns |
+=====================================+==============================================+===================================================+======================================================================================================================================+============================================+
| :ref:`DBWriter <db-writer>` | Writing data from a DataFrame to a database | Any :ref:`DBConnection <db-connections>` | `Spark DataFrame <https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame>`_ | None |
+-------------------------------------+----------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :ref:`FileDFWriter <db-writer>` | Writing data from a DataFrame to a folder | Any :ref:`FileDFConnection <file-df-connections>` | `Spark DataFrame <https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame>`_ | None |
+-------------------------------------+----------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+
| :ref:`FileUploader <file-uploader>` | Uploading files from a local FS to remote FS | Any :ref:`FileConnection <file-connections>` | List[File path on local FileSystem] | :ref:`UploadResult <file-uploader-result>` |
+-------------------------------------+----------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------+

Manipulate data
---------------

To manipulate data you can use classes:

+-------------------------------+---------------------------------------------+----------------------------------------------+--------------------------------------+---------------------------------+
| | Use case | Connection | ``run()`` gets | ``run()`` returns |
+===============================+=============================================+==============================================+======================================+=================================+
| :ref:`FileMover <file-mover>` | Move files between directories in remote FS | Any :ref:`FileConnection <file-connections>` | List[File path on remote FileSystem] | :ref:`MoveResult <move-result>` |
+-------------------------------+---------------------------------------------+----------------------------------------------+--------------------------------------+---------------------------------+
+-------------------------------+---------------------------------------------+----------------------------------------------+--------------------------------------+---------------------------------------+
| | Use case | Connection | ``run()`` gets | ``run()`` returns |
+===============================+=============================================+==============================================+======================================+=======================================+
| :ref:`FileMover <file-mover>` | Move files between directories in remote FS | Any :ref:`FileConnection <file-connections>` | List[File path on remote FileSystem] | :ref:`MoveResult <file-mover-result>` |
+-------------------------------+---------------------------------------------+----------------------------------------------+--------------------------------------+---------------------------------------+

Options
-------
Expand Down Expand Up @@ -294,7 +294,7 @@ Extract and load classes have a ``options`` parameter, which has a special meani
options=FileDFWriter.Options(if_exists="replace_entire_directory"),
)
More information about ``options`` could be found on :ref:`DB connection <db-connection>`. and
More information about ``options`` could be found on :ref:`DB connection <db-connections>`. and
:ref:`file-downloader` / :ref:`file-uploader` / :ref:`file-mover` / :ref:`file-df-reader` / :ref:`file-df-writer` documentation

Read Strategies
Expand Down
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@
# a list of builtin themes.

html_theme = "furo"
html_style = None

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
2 changes: 1 addition & 1 deletion docs/file/file_filters/file_filter.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _file-filter:

File Filter (legacy)
===================
====================

.. currentmodule:: onetl.core.file_filter.file_filter

Expand Down
2 changes: 1 addition & 1 deletion onetl/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.9.2
0.9.3
3 changes: 2 additions & 1 deletion requirements/docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ furo
importlib-resources<6
numpydoc
pygments-csv-lexer
sphinx
# https://github.com/sphinx-doc/sphinx/issues/11662
sphinx<7.2.5
sphinx-copybutton
sphinx-design
sphinx-tabs
Expand Down

0 comments on commit 39c497b

Please sign in to comment.