Skip to main content

No project description provided

Project description

Meerk

Mit License Python 2.7 PyPI version Build Status

Simple bot which notifies your chats that you are in a meeting

How to run

Firstly ensure you use python 2.7.

Clone project:

git clone https://github.com/nikialeksey/meerk.git

Install dependencies and

pip install -r requirements.txt

Configure and run:

python main.py

Or you can use it as library for your service or app, see example in main.py.

How to configure

In order to configure you need to make a copy of file local.cfg_template with name local.cfg and change content of it.

CalDav calendars

To add calendar supports CalDav format you need to uncomment caldav-calendar section and fill with your personal data. If you have a multiple calendars supports CalDav you may create a new section in local.cfg with the same fields and section name prefix caldav, but with other data, for example:

[caldav-another]
url: <another caldav url>
username: <another caldav username>
password: <another caldav password>

Important! Google Calendar does not support cal dav, and you have only one way to make it work - using *.ics files.

Ics calendars

To add calendar using ics file you need to uncomment ics-calendar section and fill with your public ics file link. Again, if you have a few ics calendars, you may create a few sections in local.cfg with section name prefix ics, for example:

[ics-another]
url: <another ics url>

[ics-yet-another]
url: <yet another ics url>

To find your calendar *.ics file link usually you need to open calendar settings, make it public, and find link to calendar *.ics file.

Slack

It supports only slack, but you can contribute for more chats. To configure slack, you guessed it, you need to uncomment slack-app section and fill, for example:

[slack-app]
token: xoxp-3165681461-*****6099680-*****3333042-*****007685996b538e88cbe92a6098b
busy_text: I am in a meeting
busy_emoji: :shushing_face:
available_text: Android development 09.00 - 17.00
available_emoji: :computer:

Slack has a legacy tokens which you need to generate in order to update your slack status and fill the token in section slack*. In feature, Meerk migrates to slack app.

How it works

Meerk periodically synchronizes specified in local.cfg calendars and periodically verifies if there is a meeting now, then update chat status to Busy, else Available.

Thanks

Thanks to @tobixen and his project caldav. I use it in the Meerk temporary. When #11 appears in release build I get rid of the immediate code of project caldav and will be use as dependency or write my own CalDav implementation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meerk-0.2.0.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meerk-0.2.0-py2-none-any.whl (40.4 kB view details)

Uploaded Python 2

File details

Details for the file meerk-0.2.0.tar.gz.

File metadata

  • Download URL: meerk-0.2.0.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.3.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/2.7.15

File hashes

Hashes for meerk-0.2.0.tar.gz
Algorithm Hash digest
SHA256 561a4477dd0ae3af6f8fb64a149e1ef6f89ce951db58062b36e5b5ba3c47f2ad
MD5 5daf23b334fa6f2a6e9eba215d552771
BLAKE2b-256 40dd4272f0943fcc03a67f9b3d19c9a06b7d7d0f1726bc8d0506e5ec22f242d4

See more details on using hashes here.

File details

Details for the file meerk-0.2.0-py2-none-any.whl.

File metadata

  • Download URL: meerk-0.2.0-py2-none-any.whl
  • Upload date:
  • Size: 40.4 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.3.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/2.7.15

File hashes

Hashes for meerk-0.2.0-py2-none-any.whl
Algorithm Hash digest
SHA256 fbf23eda7fff9e3a86be769153610c7d77b82cb91d90298e9638feeb1c89f073
MD5 4318dbc64bca8fe1a40e46c7ec4f7544
BLAKE2b-256 1132dd4842803d52e23e1df7016e5c63d2060f97d02931eb4902ebcad626760c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page