From be07c1dff40deae885d2d9c023efab0f35736db1 Mon Sep 17 00:00:00 2001 From: chewingbever Date: Wed, 26 Aug 2020 15:17:37 +0200 Subject: [PATCH 1/4] Fixed publish recipe --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 8eec702..2f30a78 100644 --- a/Makefile +++ b/Makefile @@ -65,7 +65,7 @@ package: README.md LICENSE setup.py test clean-setup @ "$(VENV)/bin/python" setup.py sdist bdist_wheel publish: package - @ [ git symbolic-ref HEAD --short = master ] && { \ + @ [ "$$(git symbolic-ref HEAD --short)" = master ] && { \ echo 'Publishing to PyPi...'; \ $(VENV)/bin/python -m twine upload dist/* ; \ } || { \ From 7c919c2abbac1b2989d992def75c741496a00a50 Mon Sep 17 00:00:00 2001 From: chewingbever Date: Wed, 26 Aug 2020 15:20:00 +0200 Subject: [PATCH 2/4] Changed name (frank is taken) --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 2295792..9238b29 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open('requirements.txt', 'r') as reqs_file: reqs = [line.strip() for line in reqs_file.readlines()] setuptools.setup( - name='frank', + name='frank-discord', version='0.1.0', author='Jef Roosens', author_email='', From 62dd87dcaa7e81a9637b41a51b047027d04572d2 Mon Sep 17 00:00:00 2001 From: chewingbever Date: Wed, 26 Aug 2020 18:13:54 +0200 Subject: [PATCH 3/4] Added to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 142d880..e7fb410 100644 --- a/README.md +++ b/README.md @@ -75,3 +75,17 @@ These three decorators are the bread and butter of Frank. Let's break them down: - `frank.default` defines the command that should be run if the module is called without explicitely giving a command. For example, if you call `fr examp` without specifying a command, it will run the default command. This is useful for making a command that's used very often easier to execute. + +In the end, all you need to do is the following in your main script: + +```python +from frank import Frank +# Or whatever your package containing your modules is called +from modules import ExampleMod + +if __name__ == '__main__': + client = Frank([ExampleMod]) + client.run(YOUR_DISCORD_TOKEN) +``` + +You can obtain this token from the Discord developer page. From d1080d0fcb84523faa083e89ac447fa8947f9759 Mon Sep 17 00:00:00 2001 From: chewingbever Date: Sat, 29 Aug 2020 10:01:01 +0200 Subject: [PATCH 4/4] Added bug & features request issue templates --- .gitlab/issue_templates/Bug.md | 29 ++++++++++++++++++++++ .gitlab/issue_templates/Feature Request.md | 21 ++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 .gitlab/issue_templates/Bug.md create mode 100644 .gitlab/issue_templates/Feature Request.md diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md new file mode 100644 index 0000000..a53f0d2 --- /dev/null +++ b/.gitlab/issue_templates/Bug.md @@ -0,0 +1,29 @@ + + +### Summary + + + +### Steps to reproduce + + + +### What is the current behavior? + + + +### What is the expected behavior? + + + +### Relevant error messages + + + +### Possible fixes + + + + +/label ~bug diff --git a/.gitlab/issue_templates/Feature Request.md b/.gitlab/issue_templates/Feature Request.md new file mode 100644 index 0000000..809e5bf --- /dev/null +++ b/.gitlab/issue_templates/Feature Request.md @@ -0,0 +1,21 @@ + + +### The idea + + + +### Intended users + + + +### Proposal + + + +### Further details + + + + +/label ~feature