Merge pull request #135 from Bycelium/release/beta-1.0.0

Release/beta 1.0.0
Bycelium · Jan 8, 2022 · 4b592c6 · 4b592c6
2 parents 8fe44f6 + 1153990
commit 4b592c6
Show file tree

Hide file tree

Showing 74 changed files with 808 additions and 631 deletions.
diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml
@@ -0,0 +1,31 @@
+name: PyPi
+
+on:
+  push:
+    tags: 
+      - 'v*'
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*
diff --git a/.github/workflows/python-coverage.yml b/.github/workflows/python-coverage.yml
@@ -1,6 +1,3 @@
-# Pyflow an open-source tool for modular visual programing in python
-# Copyright (C) 2021 Mathïs FEDERICO <https://www.gnu.org/licenses/>
-
 name: Python coverage
 
 on: ["push"]

diff --git a/.github/workflows/python-pylint.yml b/.github/workflows/python-pylint.yml
@@ -1,6 +1,3 @@
-# Pyflow an open-source tool for modular visual programing in python
-# Copyright (C) 2021 Mathïs FEDERICO <https://www.gnu.org/licenses/>
-
 name: Pylint
 
 on: ["push"]

diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml
@@ -1,6 +1,3 @@
-# Pyflow an open-source tool for modular visual programing in python
-# Copyright (C) 2021 Mathïs FEDERICO <https://www.gnu.org/licenses/>
-
 name: Pytest
 
 on: ["push"]

diff --git a/.pylintrc b/.pylintrc
@@ -3,18 +3,19 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code.
-extension-pkg-whitelist=
+extension-pkg-whitelist=PyQt5,
 
 # Specify a score threshold to be exceeded before program exits with error.
 fail-under=10.0
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
-ignore=CVS
+ignore=CVS,
+      tests
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
-ignore-patterns=test_*
+ignore-patterns=
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().
@@ -60,7 +61,8 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
-disable=inconsistent-return-statements,
+disable=bad-continuation,
+        inconsistent-return-statements,
         unidiomatic-typecheck,
         attribute-defined-outside-init,
         pointless-statement,

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -13,8 +13,8 @@ Feel free to fork the repository, implement your changes and create a merge requ
 
 First, make sure you have `python` installed. You will need to install all the `requirements` and the `requirements-dev` using the following commands:
 
-* `pip install -r requirements.txt`
-* `pip install -r requirements-dev.txt`
+-   `pip install -r requirements.txt`
+-   `pip install -r requirements-dev.txt`
 
 You can run the program with `python main.py`
 
@@ -34,29 +34,29 @@ black .
 pytest --cov=pyflow --cov-report=html tests/unit
 ```
 
-We want to keep the *Pylint* score above *9.0*.
+We want to keep the _Pylint_ score above _9.0_.
 
 The comments and docstrings should preferably follow [these](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) guidelines.
 
 ## Git Commit Messages
 
-Commits should start with a Capital letter and should be written in present tense (e.g. ``:tada: Add cool new feature`` instead of ``:tada: Added cool new feature``).
+Commits should start with a Capital letter and should be written in present tense (e.g. `:tada: Add cool new feature` instead of `:tada: Added cool new feature`).
 You should also start your commit message with one or two applicable emoji. This does not only look great but also makes you rethink what to add to a commit. Make many but small commits!
 
- | Emoji                                                     | Description                                        |
- | --------------------------------------------------------- | -------------------------------------------------- |
- | :tada: `:tada:`                                           | When you add a cool new feature                    |
- | :beetle: `:beetle:`                                       | When you fixed a bug                               |
- | :fire: `:fire:`                                           | When you removed something                         |
- | :truck: `:truck:`                                         | When you moved/renamed something                   |
- | :wrench: `:wrench:`                                       | When you improved/refactored a small piece of code |
- | :hammer: `:hammer:`                                       | When you improved/refactored a large piece of code |
- | :sparkles: `:sparkles:`                                   | When you improved code quality (pylint, PEP, ...)  |
- | :art: `:art:`                                             | When you improved/added design assets              |
- | :rocket: `:rocket:`                                       | When you improved performance.                     |
- | :memo: `:memo:`                                           | When you wrote documentation.                      |
- | :umbrella: `:umbrella:`                                   | When you improved coverage                         |
- | :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` | When you merge a branch                            |
+| Emoji                                                     | Description                                        |
+| --------------------------------------------------------- | -------------------------------------------------- |
+| :tada: `:tada:`                                           | When you add a cool new feature                    |
+| :beetle: `:beetle:`                                       | When you fixed a bug                               |
+| :fire: `:fire:`                                           | When you removed something                         |
+| :truck: `:truck:`                                         | When you moved/renamed something                   |
+| :wrench: `:wrench:`                                       | When you improved/refactored a small piece of code |
+| :hammer: `:hammer:`                                       | When you improved/refactored a large piece of code |
+| :sparkles: `:sparkles:`                                   | When you improved code quality (pylint, PEP, ...)  |
+| :art: `:art:`                                             | When you improved/added design assets              |
+| :rocket: `:rocket:`                                       | When you improved performance.                     |
+| :memo: `:memo:`                                           | When you wrote documentation.                      |
+| :umbrella: `:umbrella:`                                   | When you improved coverage                         |
+| :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` | When you merge a branch                            |
 
 This section was inspired by [This repository](https://github.com/schneegans/dynamic-badges-action).
 
@@ -70,6 +70,6 @@ create a new block type.
 Version numbers will be assigned according to the [Semantic Versioning](https://semver.org/) scheme.
 This means, given a version number MAJOR.MINOR.PATCH, we will increment the:
 
-1. MAJOR version when we make incompatible API changes,
-2. MINOR version when we add functionality in a backwards compatible manner, and
-3. PATCH version when we make backwards compatible bug fixes.
+1.  MAJOR version when we make incompatible API changes,
+2.  MINOR version when we add functionality in a backwards compatible manner, and
+3.  PATCH version when we make backwards compatible bug fixes.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,6 @@
+include pyflow/themes/*
+include pyflow/blocks/blockfiles/*
+include pyflow/qss/*
+include PYPI_README.md
+include VERSION
+include requirements.txt
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 # PyFlow
 
-[![Pytest badge](https://github.com/MathisFederico/opencodeblocks/actions/workflows/python-tests.yml/badge.svg?branch=master)](https://github.com/MathisFederico/opencodeblocks/actions/workflows/python-tests.yml)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ddd03302fd7c4849b452959753bc0939)](https://www.codacy.com/gh/MathisFederico/opencodeblocks/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=MathisFederico/opencodeblocks&amp;utm_campaign=Badge_Grade)
-[![Pylint badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_pylint_badge.json)](https://github.com/MathisFederico/opencodeblocks/actions/workflows/python-pylint.yml)
-[![Total coverage Codacy Badge](https://app.codacy.com/project/badge/Coverage/ddd03302fd7c4849b452959753bc0939)](https://www.codacy.com/gh/MathisFederico/opencodeblocks/dashboard?utm_source=github.com&utm_medium=referral&utm_content=MathisFederico/opencodeblocks&utm_campaign=Badge_Coverage)
-[![Unit coverage badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_unit_coverage_badge.json)](https://github.com/MathisFederico/opencodeblocks/actions/workflows/python-coverage.yml)
-[![Integration coverage badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_integration_coverage_badge.json)](https://github.com/MathisFederico/opencodeblocks/actions/workflows/python-coverage.yml)
+[![Pytest badge](https://github.com/Bycelium/PyFlow/actions/workflows/python-tests.yml/badge.svg?branch=master)](https://github.com/Bycelium/PyFlow/actions/workflows/python-tests.yml)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9874915d70e440418447f371c4bd5061)](https://www.codacy.com/gh/Bycelium/PyFlow/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Bycelium/PyFlow&utm_campaign=Badge_Grade)
+[![Pylint badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_pylint_badge.json)](https://github.com/Bycelium/PyFlow/actions/workflows/python-pylint.yml)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/9874915d70e440418447f371c4bd5061)](https://www.codacy.com/gh/Bycelium/PyFlow/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Bycelium/PyFlow&utm_campaign=Badge_Coverage)
+[![Unit coverage badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_unit_coverage_badge.json)](https://github.com/Bycelium/PyFlow/actions/workflows/python-coverage.yml)
+[![Integration coverage badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_integration_coverage_badge.json)](https://github.com/Bycelium/PyFlow/actions/workflows/python-coverage.yml)
 [![Licence - GPLv3](https://img.shields.io/github/license/MathisFederico/Crafting?style=plastic)](https://www.gnu.org/licenses/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
 
@@ -21,47 +21,43 @@ Join our [Discord](https://discord.gg/xZq8Tp4srd) to beta-test features, share y
 
 ## Features
 
-- Create blocks of code in which you can edit and run Python code
+-   Create blocks of code in which you can edit and run Python code
 
 <p align="center">
-  <img src="media/block_example.gif" width="400"/>
+  <img src="media/block_example.gif" alt="" width="400"/>
 </p>
 
-- Move and resize blocks on an infinite 2D plane
+-   Move and resize blocks on an infinite 2D plane
 
 <p align="center">
-  <img src="media/resize_example.gif" width="400"/>
+  <img src="media/resize_example.gif" alt="" width="400"/>
 </p>
 
-- Link blocks to highlight dependencies, Pyflow will then automatically run your blocks in the correct order
+-   Link blocks to highlight dependencies, Pyflow will then automatically run your blocks in the correct order
 
 <p align="center">
-  <img src="media/flow_example.gif" width="400"/>
+  <img src="media/flow_example.gif" alt="" width="400"/>
 </p>
 
-- Convert your Jupyter notebooks to Pyflow graphs and vice versa
+-   Convert your Jupyter notebooks to Pyflow graphs and vice versa
 
 <p align="center">
-  <img src="media/notebook_example.gif" width="400"/>
+  <img src="media/notebook_example.gif" alt="" width="400"/>
 </p>
 
 ## Installation
 
 Make sure you have Python 3 installed. You can download it from [here](https://www.python.org/downloads/)
 
-Clone the current repo:
+### Install PyFlow
 
-```bash
-git clone https://github.com/MathisFederico/Pyflow/
-```
-
-Install the dependencies
+Using pip:
 
 ```bash
-pip install -r requirements.txt
+pip install byc-pyflow
 ```
 
-Run !
+### Run PyFlow
 
 ```bash
 python -m pyflow

diff --git a/VERSION b/VERSION
@@ -0,0 +1 @@
+1.0.0-beta
diff --git a/coverage_score.py b/coverage_score.py
@@ -1,7 +1,7 @@
 # Pyflow an open-source tool for modular visual programing in python
-# Copyright (C) 2021 Mathïs FEDERICO <https://www.gnu.org/licenses/>
+# Copyright (C) 2021-2022 Bycelium <https://www.gnu.org/licenses/>
 
-""" Module to get coverage score. """
+""" Module to get coverage score."""
 
 import sys
 from xml.dom import minidom