Git Product home page Git Product logo

pysparkpipeline's Introduction

PySparkPipeline

Модуль для работы со спарком в концепции пайплайна

Подробное описание работы с модулем и его бенефиты описаны в тетрадке article.ipynb

Копия здесь.

Краткая инструкция

1. Установка пакета

Remote

$ python3 -m pip install git+ssh://[email protected]:n-surkov/PySparkPipeline.git

Local

$ git clone https://github.com/n-surkov/PySparkPipeline.git
$ python3 -m pip install -e ./PySparkPipeline

2. Определение классов под свой проект

Для своего конкретного проекта лучше доопределить базовые классы. Пример:

  • example_project/modules/config_base.py
  • example_project/modules/module_base.py

В библиотечном файле конфига отсутствует функция настройки логгера. Но в файле example_project/modules/config_base.py она определена таким образом, что пишет логи в путь data/logs.

Если забирать example_project/modules/config_base.py, то обязательно нужно создать директорию data/logs.

Так же в файле example_project/modules/config_base.py определяются пути к конфигам. Если они будут лежать не в корне проекта, то пути нужно будет так же заменить.

3. Использование

Иерархию модулей лучше формировать согласно example_project. Тогда легко будет собирать документацию.

По пути example_project/modules/some_module лежит пример использования базовых классов.

4. Документация

Если иерархия проекта будет согласована с example_project, то можно добавить в него файл example_project/utils/description_builder.py. Этот скрипт будет собирать документацию в автоматическом режиме.

При этом в корень проекта нужно положить README.md с обязательным содержанием

<details>
  <summary>Содержание проекта</summary>
  
</details>

В эту часть будет выкидываться оглавление.

5. Тестирование

python3 -m unittest tests/test_module_base.py

pysparkpipeline's People

Contributors

n-surkov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.