========================================
APRSD extension add irc server via APRS!
========================================
WB4BOR
------
|pypi| |versions| |commit| |slack|
What is it?
===========
This is a pypi package for the `APRSD <https://github.com/craigerl/aprsd>`_ project that adds an IRC server
to `APRSD <https://github.com/craigerl/aprsd>`_
The IRC server has support for multiple channels and users. This allows for
group based chats with APRS. Users can create/join a channel and send messages to that channel.
Everyone else in the channel gets those messages and can reply.
Running APRS IRC Server as 'IRC'
================================
There is an existing running instance of the IRC server under the APRS network callsign of 'IRC'.
To connect to this server and join the default channel, send an APRS message to 'IRC' with the following
text in the message body:
::
/join #lounge
This will join you to the default channel of #lounge. You can then chat with others in that channel by
sending messages to the channel.
Using the IRC server
====================
First you must join an existing channel. Every instance with this extension has a default
channel of #lounge. You can join that channel by sending an APRS message to 'IRC' with the following
text in the message body:
Joining a channel
-----------------
::
/join #lounge
After you join the channel, you can send messages to the channel by sending an APRS message to 'IRC' with the following
text in the message body:
You can join multiple channels by simply sending another join command with the channel name.
Sending a message to a channel
------------------------------
::
#lounge Hello World!
Everyone that is in the channel #lounge will get your message sent to them.
If you are only in 1 channel, you don't have to preface your message with the channel name. If you are in multiple
channels, you must preface your message with the channel name.
For example, if you are only in the #lounge channel, you can simply send the following message to 'IRC':
::
Hello World!
Leaving a channel
-----------------
You can leave a channel by sending an APRS message to 'IRC' with the following
text in the message body:
::
/leave #lounge
This will remove you from the #lounge channel.
If you are only in 1 channel you can simply send the following message to 'IRC':
::
/leave
This will remove you from the channel you are currently in.
Getting a list of channels
--------------------------
You can get a list of channels by sending an APRS message to 'IRC' with the following
text in the message body:
::
/list
This will return a list of channels that are currently active on the server and how many users are in each channel.
Installing
==========
To install the extension, you have to have an install of `APRSD <https://github.com/craigerl/aprsd>`_ already.
That is typically installed into a virtualenv. You can then install this extension into the same virtualenv.
::
pip install aprsd-irc-extension
Then you can add the following to your aprsd config file:
::
[aprsd-irc-extension]
enabled = True
default_channel = #lounge
Running the IRC server
======================
Once you have installed the extension, you can start the server by running the following command:
::
aprsd irc server --loglevel debug
.. badges
.. |pypi| image:: https://img.shields.io/pypi/v/aprsd-irc-extension.svg
:target: https://pypi.python.org/pypi/aprsd-irc-extension
.. |versions| image:: https://img.shields.io/pypi/pyversions/aprsd-irc-extension.svg
:target: https://pypi.python.org/pypi/aprsd-irc-extension
.. |slack| image:: https://img.shields.io/badge/slack-@hemna/aprsd-blue.svg?logo=slack
:target: https://hemna.slack.com/app_redirect?channel=C01KQSCP5RP
.. |commit| image:: https://img.shields.io/github/last-commit/hemna/aprsd-irc-extension
Raw data
{
"_id": null,
"home_page": "http://aprsd.readthedocs.org",
"name": "aprsd-irc-extension",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Walter A. Boring IV",
"author_email": "waboring@hemna.com",
"download_url": "https://files.pythonhosted.org/packages/c2/a2/ac1e5dc3748a6b91f07361ab0ea3fa4f4a2d7940fea6cc4fa93ae5bc3a74/aprsd-irc-extension-0.0.5.tar.gz",
"platform": null,
"description": "========================================\nAPRSD extension add irc server via APRS!\n========================================\n\nWB4BOR\n------\n\n|pypi| |versions| |commit| |slack|\n\n\nWhat is it?\n===========\nThis is a pypi package for the `APRSD <https://github.com/craigerl/aprsd>`_ project that adds an IRC server\nto `APRSD <https://github.com/craigerl/aprsd>`_\n\nThe IRC server has support for multiple channels and users. This allows for\ngroup based chats with APRS. Users can create/join a channel and send messages to that channel.\nEveryone else in the channel gets those messages and can reply.\n\n\nRunning APRS IRC Server as 'IRC'\n================================\nThere is an existing running instance of the IRC server under the APRS network callsign of 'IRC'.\nTo connect to this server and join the default channel, send an APRS message to 'IRC' with the following\ntext in the message body:\n\n::\n\n /join #lounge\n\nThis will join you to the default channel of #lounge. You can then chat with others in that channel by\nsending messages to the channel.\n\nUsing the IRC server\n====================\n\nFirst you must join an existing channel. Every instance with this extension has a default\nchannel of #lounge. You can join that channel by sending an APRS message to 'IRC' with the following\ntext in the message body:\n\n\nJoining a channel\n-----------------\n::\n\n /join #lounge\n\nAfter you join the channel, you can send messages to the channel by sending an APRS message to 'IRC' with the following\ntext in the message body:\n\nYou can join multiple channels by simply sending another join command with the channel name.\n\n\nSending a message to a channel\n------------------------------\n::\n\n #lounge Hello World!\n\nEveryone that is in the channel #lounge will get your message sent to them.\n\nIf you are only in 1 channel, you don't have to preface your message with the channel name. If you are in multiple\nchannels, you must preface your message with the channel name.\n\nFor example, if you are only in the #lounge channel, you can simply send the following message to 'IRC':\n\n::\n\n Hello World!\n\n\nLeaving a channel\n-----------------\n\nYou can leave a channel by sending an APRS message to 'IRC' with the following\ntext in the message body:\n\n::\n\n /leave #lounge\n\nThis will remove you from the #lounge channel.\n\nIf you are only in 1 channel you can simply send the following message to 'IRC':\n\n::\n\n /leave\n\nThis will remove you from the channel you are currently in.\n\n\nGetting a list of channels\n--------------------------\n\nYou can get a list of channels by sending an APRS message to 'IRC' with the following\ntext in the message body:\n\n::\n\n /list\n\nThis will return a list of channels that are currently active on the server and how many users are in each channel.\n\n\nInstalling\n==========\n\nTo install the extension, you have to have an install of `APRSD <https://github.com/craigerl/aprsd>`_ already.\nThat is typically installed into a virtualenv. You can then install this extension into the same virtualenv.\n\n::\n\n pip install aprsd-irc-extension\n\nThen you can add the following to your aprsd config file:\n\n::\n\n [aprsd-irc-extension]\n enabled = True\n default_channel = #lounge\n\n\nRunning the IRC server\n======================\nOnce you have installed the extension, you can start the server by running the following command:\n\n::\n\n aprsd irc server --loglevel debug\n\n\n\n\n.. badges\n\n.. |pypi| image:: https://img.shields.io/pypi/v/aprsd-irc-extension.svg\n :target: https://pypi.python.org/pypi/aprsd-irc-extension\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/aprsd-irc-extension.svg\n :target: https://pypi.python.org/pypi/aprsd-irc-extension\n\n.. |slack| image:: https://img.shields.io/badge/slack-@hemna/aprsd-blue.svg?logo=slack\n :target: https://hemna.slack.com/app_redirect?channel=C01KQSCP5RP\n\n.. |commit| image:: https://img.shields.io/github/last-commit/hemna/aprsd-irc-extension\n\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "An Extension to Ham radio APRSD Daemon to act like an irc server for APRS",
"version": "0.0.5",
"project_urls": {
"Homepage": "http://aprsd.readthedocs.org",
"Source": "https://github.com/hemna/aprsd-irc",
"Tracker": "https://github.com/hemna/aprsd-irc/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "511deff3ca46b427a9877adbf417bdda8c9e8045732cfbb9cd5197dcc80da7ff",
"md5": "1aa8c7f26ac118d1758d8be245be263a",
"sha256": "67a4e72dc14014b5cdde75e0ee12f6608e5918e33488d3b81494d1925eb0c4c1"
},
"downloads": -1,
"filename": "aprsd_irc_extension-0.0.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1aa8c7f26ac118d1758d8be245be263a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 21606,
"upload_time": "2024-04-09T11:28:47",
"upload_time_iso_8601": "2024-04-09T11:28:47.108119Z",
"url": "https://files.pythonhosted.org/packages/51/1d/eff3ca46b427a9877adbf417bdda8c9e8045732cfbb9cd5197dcc80da7ff/aprsd_irc_extension-0.0.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c2a2ac1e5dc3748a6b91f07361ab0ea3fa4f4a2d7940fea6cc4fa93ae5bc3a74",
"md5": "ac2c7832f24b18792adb6e1911534286",
"sha256": "a1f62a5b611e2775944b47a912ba29302bbed253ddfd8780f5c57d8320067038"
},
"downloads": -1,
"filename": "aprsd-irc-extension-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "ac2c7832f24b18792adb6e1911534286",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27462,
"upload_time": "2024-04-09T11:28:48",
"upload_time_iso_8601": "2024-04-09T11:28:48.264647Z",
"url": "https://files.pythonhosted.org/packages/c2/a2/ac1e5dc3748a6b91f07361ab0ea3fa4f4a2d7940fea6cc4fa93ae5bc3a74/aprsd-irc-extension-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 11:28:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hemna",
"github_project": "aprsd-irc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "aprsd-irc-extension"
}
JSON
