Skip to content

Adri-Hdez/Pipeln

Repository files navigation

logo

A Python open source package to create a custom pipeline


💾 Installation & Upgrade

  • Installation: pip install pipeln
  • Upgrade: pip install pipeln --upgrade

📦 What is this?

Pipeln is a Python package aimed at creating a pipeline or a sequence of custom methods execution. The goal is to enable the creation of different procedural sequences that can be encapsulated within a method, allowing for the selection of order, return values, etc. Although some functionalities are still pending implementation, for a better overview, please refer to the objectives calendar.

📃​ Last version 0.2.11-alpha out now! 📃​

💬 Contribution & Questions

Contribution & Questions Type Platforms
🐞​​ Bug Reports GitHub Issues
📦​ Feature Requests & Ideas GitHub Discussions
🛠️​ Usage Questions & Discusions GitHub Discussions

​🔧​ Install & Use Pipeln

To start using Pipeln use the next command:

pip install pipeln

To use the library properly, we follow these steps:

  • Import the library.
  • Initialize an object of the Pipeln class, providing the names and parameters of our methods, and setting the execution order.
  • Create the execution structure.
  • Execute the pipeline.
from Pipeln.pipeline import Pipeline
from features.auxiliar_test_methods import add, sub, cap

obj = Pipeline(methods=[add, sub, cap], params=[{'a': 2, 'b': 4}, ('1', 2), ('spain',)], orders=[3, 1, 2], debug=True)
obj.create()
obj.run()

Expected output:

DEBUG: *****************************
DEBUG:      > Starting pipeline
DEBUG:
DEBUG: EXEC: Method add executed successfully.
ERROR: ERROR: There is an error in sub method. Inappropiate argument type.
DEBUG: EXEC: Method cap executed successfully.
DEBUG:
DEBUG:   Pipeline finished in 10.9
DEBUG: *****************************

💳 License

Pipeln is licensed under MIT License.

🗃️ Shields

PyPI downloads versions license

About

Pipeln is a Python package to create a custom pipeline

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages