Metadata-Version: 2.4
Name: sopel-hackernews
Version: 0.2.0
Summary: Hacker News plugin for Sopel.
Author-email: dgw <dgw@technobabbl.es>
License-Expression: EFL-2.0
Project-URL: Homepage, https://github.com/sopel-irc/sopel-hackernews
Project-URL: Bug Tracker, https://github.com/sopel-irc/sopel-hackernews/issues
Keywords: sopel,plugin,hackernews,bot,irc
Platform: Linux x86, x86-64
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: <4,>=3.8
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: sopel<9,>=8
Requires-Dist: requests
Dynamic: license-file

# sopel-hackernews

Hacker News plugin for Sopel.

## Development status

The current version is more or less stable, but is still considered beta or
pre-1.0 due to missing planned features and lack of testing for edge cases. See
plans for 1.0 at https://github.com/sopel-irc/sopel-hackernews/issues/3

We welcome contributions from anyone who feels like implementing something from
the 1.0 "wishlist", as well as bug reports and feature suggestions.

## Installing

Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:

```shell
$ pip install sopel-hackernews
```

## Configuring

`sopel-hackernews` supports Sopel's config wizard:

```shell
$ sopel-plugins configure hackernews
```

Available settings are as follows:

- `relative_timestamps` — whether timestamps will be "humanized" like "2 days, 3
  hours ago" (the default) or shown as absolute values

## Usage

Links to Hacker News items are expanded automatically.

You can search for a link on HN using the `.rhn` command:

```
.rhn https://somecool.site/that/posted/an/article/
```

## Credits

Loosely based on [dasu's `hn.py` module][dasu-hn.py], which was licensed as
"literally do whatever you want, i'm not liable for anything lol". Thank you for
the springboard!

[dasu-hn.py]: https://github.com/dasu/syrup-sopel-modules/blob/8f644ba4b4cdda06200f18a36959796ae7979fb6/hn.py

## Changelog

### 0.2.0

Added:
* `sopel-plugins configure` wizard support (#17)
* Handle user links (#16)
* Basic formatting parser (#15, #18, #19)
* Differentiation of polls from regular stories (#14)

Housekeeping:
* Require Sopel 8 + Python 3.8 or higher (#11)
* Future-proof package license metadata (#12)
* Automate PyPI release publishing (#13)


### 0.1.0

Initial release. Considered beta, but largely functional.
