Metadata-Version: 2.1
Name: slackoff
Version: 0.0.9
Summary: Automatically sign out of Slack workspaces on macOS.
Home-page: https://pypi.org/project/slackoff
License: MIT
Author: Jace Browning
Author-email: jacebrowning@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Communications :: Chat
Requires-Dist: applescript (>=2021.2.9,<2022.0.0)
Requires-Dist: click
Requires-Dist: datafiles (>=1.3b1,<2.0)
Requires-Dist: minilog
Requires-Dist: pync (>=2.0.3,<3.0.0)
Project-URL: Documentation, https://slackoff.readthedocs.io
Project-URL: Repository, https://github.com/jacebrowning/slackoff
Description-Content-Type: text/markdown

# Overview

Slackoff is a quick way to sign out of a company Slack workspace at the end of the day to improve one's work-life balance. It can also be used to sign out of "fun" Slack workspaces to avoid distractions during normal working hours.

[![Build Status](https://img.shields.io/github/workflow/status/jacebrowning/slackoff/main)](https://github.com/jacebrowning/slackoff/actions)
[![Coverage Status](https://img.shields.io/codecov/c/gh/jacebrowning/slackoff)](https://codecov.io/gh/jacebrowning/slackoff)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/jacebrowning/slackoff.svg)](https://scrutinizer-ci.com/g/jacebrowning/slackoff)
[![PyPI License](https://img.shields.io/pypi/l/slackoff.svg)](https://pypi.org/project/slackoff)
[![PyPI Version](https://img.shields.io/pypi/v/slackoff.svg)](https://pypi.org/project/slackoff)
[![PyPI Downloads](https://img.shields.io/pypi/dm/slackoff.svg?color=orange)](https://pypistats.org/packages/slackoff)

## Setup

### Requirements

* macOS (for AppleScript)
* Slack for Mac
* Python 3.10+

### Installation

Install this tool globally with [pipx](https://pipxproject.github.io/pipx/) (or pip):

```sh
$ pipx install slackoff
```
or add it to your [Poetry](https://python-poetry.org/docs/) project:

```sh
$ poetry add slackoff
```

## Usage

After installation, automatically sign out of a Slack workspace:

```sh
$ slackoff My Company Workspace
```

or sign back in:

```sh
$ slackoff
```

Slackoff will remember the last workspace used and attempt to toggle appropriately.

### Additional Options

To explicitly attempt to sign in or out, include the corresponding flag:

```sh
$ slackoff --signin
$ slackoff --signout
```

View the help for more options:

```sh
$ slackoff --help
```

