-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * updated readme and upgraded deps * updated deps * added sass * added nodes and edges * relocated files * improved and updated * updated README.md * added README.md * added fundings * updated pyprojects * added ruff and formatted
- Loading branch information
1 parent
3a3bad6
commit ead10d5
Showing
29 changed files
with
618 additions
and
179 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# These are supported funding model platforms | ||
github: [muhammad-fiaz] | ||
ko_fi: muhammadfiaz |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or | ||
advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
https://github.com/muhammad-fiaz/pywebflow/discussions. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series | ||
of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or | ||
permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within | ||
the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.0, available at | ||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
||
Community Impact Guidelines were inspired by [Mozilla's code of conduct | ||
enforcement ladder](https://github.com/mozilla/diversity). | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
https://www.contributor-covenant.org/faq. Translations are available at | ||
https://www.contributor-covenant.org/translations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Contributing to PyWebflow | ||
|
||
Thank you for considering contributing to **PyWebflow**! 🚀 | ||
We appreciate your help in improving this project. | ||
|
||
## How to Contribute | ||
|
||
There are multiple ways you can contribute: | ||
|
||
### 🛠️ **Reporting Issues** | ||
- If you find a bug or have a feature request, please open an issue in the [GitHub Issues](https://github.com/muhammad-fiaz/pywebflow/issues). | ||
- When reporting an issue, provide as much detail as possible, including: | ||
- Steps to reproduce the problem. | ||
- Expected behavior vs. actual behavior. | ||
- Screenshots or logs if applicable. | ||
|
||
### 📌 **Submitting a Pull Request** | ||
1. **Fork the repository** | ||
Click the "Fork" button on the [PyWebflow GitHub repository](https://github.com/muhammad-fiaz/pywebflow) to create your own copy. | ||
|
||
2. **Clone your fork** | ||
```sh | ||
git clone https://github.com/your-username/pywebflow.git | ||
cd pywebflow | ||
``` | ||
|
||
3. **Create a new branch** | ||
```sh | ||
git checkout -b feature-name | ||
``` | ||
|
||
4. **Make your changes** | ||
- Follow best coding practices. | ||
- Ensure the code is clean and well-documented. | ||
|
||
5. **Commit your changes** | ||
```sh | ||
git add . | ||
git commit -m "Add feature: [brief description]" | ||
``` | ||
|
||
6. **Push to your fork** | ||
```sh | ||
git push origin feature-name | ||
``` | ||
|
||
7. **Create a Pull Request** | ||
- Go to the [original PyWebflow repository](https://github.com/muhammad-fiaz/pywebflow). | ||
- Click "New Pull Request". | ||
- Select your branch and submit your PR. | ||
|
||
### ✅ **Code Guidelines** | ||
- Follow PEP8 for Python code formatting. | ||
- Write meaningful commit messages. | ||
- Ensure your code is **well-documented** and **self-explanatory**. | ||
|
||
### 🧪 **Testing Your Changes** | ||
Before submitting your PR, ensure all tests pass: | ||
```sh | ||
pytest | ||
``` | ||
|
||
### 💬 **Join the Discussion** | ||
Have questions? Feel free to discuss in: | ||
- **GitHub Discussions:** [Join here](https://github.com/muhammad-fiaz/pywebflow/discussions) | ||
- **Discord Community:** [Join here](https://discord.gg/Kpm7frtu) | ||
|
||
## 📜 License | ||
By contributing, you agree that your contributions will be licensed under the project's **Apache-2.0 License**. | ||
|
||
--- | ||
|
||
Thank you for helping **PyWebflow** grow! 🚀✨ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,73 @@ | ||
# pywebflow | ||
<p align="center"> | ||
<img src="https://github.com/user-attachments/assets/b4d68d31-145f-45e0-8bd8-64a4fcdf1056" alt="preview" /> | ||
</p> | ||
|
||
pywebflow is a Python-based web framework to create node-based workflows. It allows users to easily build and manage node-based projects using Python. | ||
<h1 align="center">PyWebflow</h1> | ||
|
||
> Note: This project is still in development and is not yet ready for production use. | ||
<p align="center"> | ||
<a href="https://github.com/muhammad-fiaz/pywebflow/stars"> | ||
<img src="https://img.shields.io/github/stars/muhammad-fiaz/pywebflow?style=social" alt="GitHub stars" /> | ||
</a> | ||
<a href="https://github.com/muhammad-fiaz/pywebflow/issues"> | ||
<img src="https://img.shields.io/github/issues/muhammad-fiaz/pywebflow" alt="GitHub issues" /> | ||
</a> | ||
<a href="https://github.com/muhammad-fiaz/pywebflow/network/members"> | ||
<img src="https://img.shields.io/github/forks/muhammad-fiaz/pywebflow?style=social" alt="GitHub forks" /> | ||
</a> | ||
<a href="https://github.com/muhammad-fiaz/pywebflow/blob/main/LICENSE"> | ||
<img src="https://img.shields.io/github/license/muhammad-fiaz/pywebflow" alt="License" /> | ||
</a> | ||
<a href="https://pypi.org/project/pywebflow/"> | ||
<img src="https://img.shields.io/pypi/v/pywebflow" alt="PyPI version" /> | ||
</a> | ||
<a href="https://pypi.org/project/pywebflow/"> | ||
<img src="https://img.shields.io/pypi/dm/pywebflow" alt="PyPI downloads" /> | ||
</a> | ||
</p> | ||
|
||
## Contributing | ||
## 🚀 About PyWebflow | ||
|
||
Contributions are welcome! Please feel free to submit a Pull Request or open an issue if you have any suggestions or improvements. | ||
**PyWebflow** is a Python-based web framework for creating **Flow-based workflows**. | ||
It allows users to easily build and manage node-based projects using Native Python. | ||
|
||
## License | ||
> ⚠️ **Note:** This project is still in development and is not yet ready for production use. | ||
--- | ||
|
||
## 📌 Features | ||
|
||
✅ Node-based workflow creation | ||
✅ Easy integration with Python applications | ||
✅ Open-source & actively maintained | ||
|
||
--- | ||
|
||
## 🛠️ Installation | ||
|
||
Install PyWebflow using **pip**: | ||
|
||
```sh | ||
pip install pywebflow | ||
``` | ||
|
||
--- | ||
|
||
## 🏗️ Contributing | ||
|
||
We **welcome contributions**! Please follow these steps: | ||
|
||
1. **Review** the [Code of Conduct](CODE_OF_CONDUCT.md). | ||
2. **Check** our [Contributing Guide](CONTRIBUTING.md). | ||
3. **Fork & Submit** a Pull Request. | ||
|
||
📌 **Discussions & Support** | ||
- **GitHub Discussions:** [Join here](https://github.com/muhammad-fiaz/pywebflow/discussions) | ||
- **Discord Community:** [Join here](https://discord.gg/Kpm7frtu) | ||
|
||
--- | ||
|
||
## 📜 License | ||
|
||
This project is licensed under the **Apache-2.0 License**. | ||
See the full license in the [LICENSE](LICENSE) file. | ||
|
||
This project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
# PyWebflow - Frontend | ||
|
||
This is the frontend package for **PyWebflow**, a Python-based web framework for creating flow-based workflows. It allows users to easily build and manage node-based projects using native Python. The frontend is built with [ReactFlow](https://reactflow.dev/) and React to deliver an intuitive visual editor. | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
- **Node.js** (v16 or later is recommended) | ||
- **npm** or **yarn** | ||
|
||
### Installation | ||
|
||
1. **Clone the repository:** | ||
|
||
```bash | ||
git clone https://github.com/muhammad-fiaz/pywebflow.git | ||
cd pywebflow/packages/frontend | ||
``` | ||
|
||
2. **Install dependencies:** | ||
|
||
Using npm: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
Or using bun: | ||
|
||
```bash | ||
bun install | ||
``` | ||
|
||
### Running in Development | ||
|
||
Start the development server with: | ||
|
||
Using npm: | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
Or using bun: | ||
|
||
```bash | ||
bun start | ||
``` | ||
|
||
The application will be available at [http://localhost:3000](http://localhost:3000). | ||
|
||
### Building for Production | ||
|
||
To build the production-ready files: | ||
|
||
Using npm: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
Or using bun: | ||
|
||
```bash | ||
bun run build | ||
``` | ||
|
||
The production build will be output to the `dist` folder. These static files can then be served by your PyWebflow backend or any static file server. | ||
|
||
## Usage | ||
|
||
Once the production build is ready, integrate the static files with your PyWebflow backend. For example, the backend can serve these files using FastAPI's `StaticFiles` middleware. | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! Before contributing, please review the following: | ||
|
||
- Check out our [CONTRIBUTING.md](../../CONTRIBUTING.md) for detailed guidelines. | ||
- Please review our [CODE_OF_CONDUCT.md](../../CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment. | ||
|
||
## License | ||
|
||
This project is licensed under the Apache-2.0 License. See the [LICENSE](../../LICENSE) file for more details. | ||
|
||
## Acknowledgements | ||
|
||
- **ReactFlow:** For the powerful node-based UI components. | ||
- **PyWebflow Team:** For continuously improving the project and supporting the community. |
Oops, something went wrong.