Skip to content

MovingLake/pyphene

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Pyphene

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

Pyphene is an open-source Python library that allows for the execution of Direct Acyclic Graph (DAG) workloads in-memory and multithreaded. The name "pyphene" is a combination of the words "Python" and "Graphene", reflecting the library's focus on providing an easy-to-use and efficient solution for working with DAGs in Python.

(back to top)

Getting Started

You can install Pyphene with pip:

pip install pyphene

Prerequisites

The only prerequisite is to be running Python 3.6 or higher.

Installation

You can install Pyphene with pip:

pip install pyphene

(back to top)

Usage

Pyphene is really simple to use. You can instantiate the graph either from a JSON (not super supported) or declaratively with code:

import time
from pyphene import graph

# Create a new DAG
pyph = graph.Graph()

def do_work(dep_input, states, event):
    print("Starting to work")
    time.sleep(2)
    print("Done!")

# Add tasks to the DAG
pyph.add_node("node_name1", [], do_work)
pyph.add_node("node_name2", ["node_name1"], do_work)

# Execute the DAG
pyph.run()

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme
  • Multi-language Support
    • Chinese
    • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

Multi-threaded Graph Runner

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages