Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix release pipeline #5

Merged
merged 1 commit into from
May 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
name: CI / CD
name: CI/CD Release

on:
push:
branches:
- main
- release
tags:
- 'v[0-9]+.[0-9]+.[0-9]+'

jobs:
build-and-publish:
Expand Down Expand Up @@ -65,7 +64,6 @@ jobs:
skip_existing: true

- name: Publish distribution 📦 to PyPI
if: startsWith(github.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@master
with:
password: ${{ secrets.PYPI_API_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI / CD
name: CI/CD Test

on: [ push, pull_request ]

Expand Down
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# Smart Signals

![Build](https://github.com/grobbles/SmartSignals/actions/workflows/build.yml/badge.svg)
![Build](https://github.com/grobbles/SmartSignals/actions/workflows/test.yml/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![codecov](https://codecov.io/gh/grobbles/SmartSignals/branch/main/graph/badge.svg?token=GAHKYKS1SD)](https://codecov.io/gh/grobbles/SmartSignals)
[![codecov](https://codecov.io/gh/grobbles/SmartSignals/branch/main/graph/badge.svg?token=GAHKYKS1SD)](https://codecov.io/gh/grobbles/SmartSignals)

# Install

You can install this package with pip from PyPi.

````bash
pip install SmartSignals
````

# Usage

````python
from smart_signals import *

class Test:
@SmartSignalSlot(str)
def slot(self, message: str):
print(message)
pass

test = Test()
signal = SmartSignal(str)
signal.connect(test.slot)
signal.emit("message")
````