diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-jcore.spec | 380 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 382 insertions, 0 deletions
@@ -0,0 +1 @@ +/jcore-0.2.0.552.tar.gz diff --git a/python-jcore.spec b/python-jcore.spec new file mode 100644 index 0000000..3fb461c --- /dev/null +++ b/python-jcore.spec @@ -0,0 +1,380 @@ +%global _empty_manifest_terminate_build 0 +Name: python-jcore +Version: 0.2.0.552 +Release: 1 +Summary: A python package for creating Twitch Bots +License: GPL +URL: https://github.com/cubbei/jcore +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/9d/65/9a00f424b71411cd4f75b743ec09894d7310415ad2dcecd2b0c1a7e9313e/jcore-0.2.0.552.tar.gz +BuildArch: noarch + +Requires: python3-asyncio +Requires: python3-pyyaml + +%description +# J-Core + +[](https://python.org) [](https://badge.fury.io/py/jcore) + +This framework is a simple wrapper for creating [Twitch](https://twitch.tv) bots using Python. +The [Jarvis chatbot for twitch and discord](https://jarvis.bot) has been built using the J-Core framework for it's Twitch components. + +A full set of documentation is still being developed, however, a getting started guide is outlined below. + +## Getting started + +### Prerequisites +To get started creating a bot using the J-Core framwork is pretty simple, but it does require that you have [Python](https://python.org) installed on your computer. +Some operating systems come with python pre-installed (e.g. MacOS and most Linux systems), but if you're on Windows, you will need to [download Python](https://python.org/download) first to create a bot. +Once you have installed Python, you can use `pip` to install the J-Core framework and start creating your first bot. + +### Installation +To install the J-Core framework using pip: +```pip install jcore``` + +To install using this repository: +1. clone the directory using `git clone` +2. navigate into the directory and use `pip install` + + +### Creating a Simple Bot +To create a simple bot, start by creating a new python file called `simple_bot.py` and copy the code below into the file. +```python +import asyncio +import jcore +from jcore.message import CommandMessage + +class SimpleBot(jcore.Client): + + async def on_command(self, message: CommandMessage): + if message.KEYWORD == "hi": + await message.send(f"hello {message.display_name}") + + +if __name__ == "__main__": + client = SimpleBot() + loop = asyncio.get_event_loop() + loop.run_until_complete(client.run()) + loop.close() +``` + +Next, create a file called `config.json` and copy the following snippet into the file. +```json +{ + "nick": "<nick>", + "token": "<token>", + "channels": [ + "<channel>", + "<channel>", + "<channel>" + ] +} +``` + +Replace: +- `<nick>` with the username of your bot account. +- `<token>` with the oauth token for your bot. Refer to the [Twitch Documentation - Getting Tokens](https://dev.twitch.tv/docs/authentication#getting-tokens) for more information about generating an oauth token. +- `<channel>` with the channels you want to connect to. + +Once all the values have been set, you can start your bot using: +```bash +python3 simple_bot.py +``` +or +```batch +py simple_bot.py +``` + +### Adding Logging +If you need to view the logging output of from the framework for your bot, you can configure logging by adding the logging import to the top of your file: +```python +import asyncio +import jcore +from jcore.message import CommandMessage +import logging +``` + +Then update the main section of your code to the following: +```python +if __name__ == "__main__": + + logging.basicConfig(level=logging.INFO, format='%(asctime)s [%(levelname)s] %(name)s: %(message)s') + + client = SimpleBot() + loop = asyncio.get_event_loop() + loop.run_until_complete(client.run()) + loop.close() +``` + +For more information on using the logging library, refer to the [python logging documentation](https://docs.python.org/3/library/logging.html). + +### Examples +These examples above and more can be found in the [examples](https://github.com/cubbei/jcore/tree/master/examples) folder. + +### Support +If you require any further support, please join the [discord](https://jarvis.bot/discord) and seek help from the commuity. + + + +%package -n python3-jcore +Summary: A python package for creating Twitch Bots +Provides: python-jcore +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-jcore +# J-Core + +[](https://python.org) [](https://badge.fury.io/py/jcore) + +This framework is a simple wrapper for creating [Twitch](https://twitch.tv) bots using Python. +The [Jarvis chatbot for twitch and discord](https://jarvis.bot) has been built using the J-Core framework for it's Twitch components. + +A full set of documentation is still being developed, however, a getting started guide is outlined below. + +## Getting started + +### Prerequisites +To get started creating a bot using the J-Core framwork is pretty simple, but it does require that you have [Python](https://python.org) installed on your computer. +Some operating systems come with python pre-installed (e.g. MacOS and most Linux systems), but if you're on Windows, you will need to [download Python](https://python.org/download) first to create a bot. +Once you have installed Python, you can use `pip` to install the J-Core framework and start creating your first bot. + +### Installation +To install the J-Core framework using pip: +```pip install jcore``` + +To install using this repository: +1. clone the directory using `git clone` +2. navigate into the directory and use `pip install` + + +### Creating a Simple Bot +To create a simple bot, start by creating a new python file called `simple_bot.py` and copy the code below into the file. +```python +import asyncio +import jcore +from jcore.message import CommandMessage + +class SimpleBot(jcore.Client): + + async def on_command(self, message: CommandMessage): + if message.KEYWORD == "hi": + await message.send(f"hello {message.display_name}") + + +if __name__ == "__main__": + client = SimpleBot() + loop = asyncio.get_event_loop() + loop.run_until_complete(client.run()) + loop.close() +``` + +Next, create a file called `config.json` and copy the following snippet into the file. +```json +{ + "nick": "<nick>", + "token": "<token>", + "channels": [ + "<channel>", + "<channel>", + "<channel>" + ] +} +``` + +Replace: +- `<nick>` with the username of your bot account. +- `<token>` with the oauth token for your bot. Refer to the [Twitch Documentation - Getting Tokens](https://dev.twitch.tv/docs/authentication#getting-tokens) for more information about generating an oauth token. +- `<channel>` with the channels you want to connect to. + +Once all the values have been set, you can start your bot using: +```bash +python3 simple_bot.py +``` +or +```batch +py simple_bot.py +``` + +### Adding Logging +If you need to view the logging output of from the framework for your bot, you can configure logging by adding the logging import to the top of your file: +```python +import asyncio +import jcore +from jcore.message import CommandMessage +import logging +``` + +Then update the main section of your code to the following: +```python +if __name__ == "__main__": + + logging.basicConfig(level=logging.INFO, format='%(asctime)s [%(levelname)s] %(name)s: %(message)s') + + client = SimpleBot() + loop = asyncio.get_event_loop() + loop.run_until_complete(client.run()) + loop.close() +``` + +For more information on using the logging library, refer to the [python logging documentation](https://docs.python.org/3/library/logging.html). + +### Examples +These examples above and more can be found in the [examples](https://github.com/cubbei/jcore/tree/master/examples) folder. + +### Support +If you require any further support, please join the [discord](https://jarvis.bot/discord) and seek help from the commuity. + + + +%package help +Summary: Development documents and examples for jcore +Provides: python3-jcore-doc +%description help +# J-Core + +[](https://python.org) [](https://badge.fury.io/py/jcore) + +This framework is a simple wrapper for creating [Twitch](https://twitch.tv) bots using Python. +The [Jarvis chatbot for twitch and discord](https://jarvis.bot) has been built using the J-Core framework for it's Twitch components. + +A full set of documentation is still being developed, however, a getting started guide is outlined below. + +## Getting started + +### Prerequisites +To get started creating a bot using the J-Core framwork is pretty simple, but it does require that you have [Python](https://python.org) installed on your computer. +Some operating systems come with python pre-installed (e.g. MacOS and most Linux systems), but if you're on Windows, you will need to [download Python](https://python.org/download) first to create a bot. +Once you have installed Python, you can use `pip` to install the J-Core framework and start creating your first bot. + +### Installation +To install the J-Core framework using pip: +```pip install jcore``` + +To install using this repository: +1. clone the directory using `git clone` +2. navigate into the directory and use `pip install` + + +### Creating a Simple Bot +To create a simple bot, start by creating a new python file called `simple_bot.py` and copy the code below into the file. +```python +import asyncio +import jcore +from jcore.message import CommandMessage + +class SimpleBot(jcore.Client): + + async def on_command(self, message: CommandMessage): + if message.KEYWORD == "hi": + await message.send(f"hello {message.display_name}") + + +if __name__ == "__main__": + client = SimpleBot() + loop = asyncio.get_event_loop() + loop.run_until_complete(client.run()) + loop.close() +``` + +Next, create a file called `config.json` and copy the following snippet into the file. +```json +{ + "nick": "<nick>", + "token": "<token>", + "channels": [ + "<channel>", + "<channel>", + "<channel>" + ] +} +``` + +Replace: +- `<nick>` with the username of your bot account. +- `<token>` with the oauth token for your bot. Refer to the [Twitch Documentation - Getting Tokens](https://dev.twitch.tv/docs/authentication#getting-tokens) for more information about generating an oauth token. +- `<channel>` with the channels you want to connect to. + +Once all the values have been set, you can start your bot using: +```bash +python3 simple_bot.py +``` +or +```batch +py simple_bot.py +``` + +### Adding Logging +If you need to view the logging output of from the framework for your bot, you can configure logging by adding the logging import to the top of your file: +```python +import asyncio +import jcore +from jcore.message import CommandMessage +import logging +``` + +Then update the main section of your code to the following: +```python +if __name__ == "__main__": + + logging.basicConfig(level=logging.INFO, format='%(asctime)s [%(levelname)s] %(name)s: %(message)s') + + client = SimpleBot() + loop = asyncio.get_event_loop() + loop.run_until_complete(client.run()) + loop.close() +``` + +For more information on using the logging library, refer to the [python logging documentation](https://docs.python.org/3/library/logging.html). + +### Examples +These examples above and more can be found in the [examples](https://github.com/cubbei/jcore/tree/master/examples) folder. + +### Support +If you require any further support, please join the [discord](https://jarvis.bot/discord) and seek help from the commuity. + + + +%prep +%autosetup -n jcore-0.2.0.552 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-jcore -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.0.552-1 +- Package Spec generated @@ -0,0 +1 @@ +2e844ddcdf82fd39e67f39ad56dff3cd jcore-0.2.0.552.tar.gz |