https://github.com/kyleterry/tenyks-service

https://github.com/kyleterry/tenyks-service

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kyleterry/tenyks-service
• Owner: kyleterry
• Created: 2014-07-21T03:24:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-02-15T17:58:29.000Z (over 1 year ago)
• Last Synced: 2024-10-05T07:12:20.118Z (about 1 month ago)
• Language: Python
• Size: 48.8 KB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Tenyks Service

This is a python abstraction for creating a

[Tenyks](https://github.com/kyleterry/tenyks) service. This is supposed to

bootstrap all the necessary coroutines and connections needed to communicate

with the IRC bot.

There will be two branches that follow Tenyks. Version 1.x will follow the version

1.x of Tenyks, which currently uses Redis for Pub/Sub. Version 2.x will follow

version 2.x of Tenyks, which is intended to use ZeroMQ as the Pub/Sub

mechanism.

The Primary Tenyks README has more information on how to create a service.

## Install

Pypi: `pip install tenyksservice`  

Git: `git clone https://github.com/kyleterry/tenyks-service; cd tenyks-service;

./setup.py install`

### For Contributing

Git: `git clone https://github.com/kyleterry/tenyks-service; cd tenyks-service;

./setup.py develop`

## Generating settings

`tenyks-service-mkconfig  > _settings.py`

This will also generate a UUID for your service. [Please don't lose

this](http://d315f714-26fh-4346-96a8-11a864cdfcb5.com/) or you will have to

keep purging all the old services registered with Tenyks.

Then, I would set `SERVICE_DESCRIPTION` to something.

## Usage

See [examples](./examples/hello-service).

See the [Tenyks

README](https://github.com/kyleterry/tenyks#lets-make-a-service) section on

making a service.

See [tenyks-contrib](https://github.com/kyleterry/tenyks-contrib). A repo full

of services.