Skip to content

Commit

Permalink
Readme done
Browse files Browse the repository at this point in the history
  • Loading branch information
howroyd committed Aug 26, 2023
2 parents 510edd0 + 06b0169 commit 8ac4577
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,4 @@ jobs:
- name: Test with pytest
run: |
dir
python -m pip install -e ./pynput_local
python run_tests.py
# TODO add tests here
39 changes: 39 additions & 0 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Upload Python Package

on:
release:
types: [published]

permissions:
contents: read

jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
- name: Build package
run: python -m build
- name: Publish package
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
15 changes: 15 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Python: Module",
"type": "python",
"request": "launch",
"module": "twitchirc_drgreengiant.twitchirc",
"justMyCode": true
}
]
}
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# TwitchIRC

[![CodeQL](https://github.com/howroyd/twitchirc/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/codeql-analysis.yml)\
[![Python application](https://github.com/howroyd/twitchirc/actions/workflows/python-app.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/python-app.yml)\
[![Upload Python Package](https://github.com/howroyd/twitchirc/actions/workflows/python-publish.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/python-publish.yml)

This module connects to the Twitch IRC as a basic listener client. It handles the ping pong and initial connection but otherwise does not send anything to Twitch therefore does not appear in the viewer list nor can it post to chat. As such, no oauth is required, it just works out of the box.

It can join multiple channels at the same time and will report which channel a message was received in.
Expand Down
15 changes: 15 additions & 0 deletions local.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"folders": [
{
"path": "."
}
],
//"settings": {
// "editor.fontSize": 13,
// "window.zoomLevel": 1.75
//},
"launch": {
"version": "0.2.0",
"configurations": []
}
}

0 comments on commit 8ac4577

Please sign in to comment.