Metadata-Version: 2.1
Name: bernard
Version: 0.6.0
Summary: Bot Engine Responding Naturally At Requests Detection
License: AGPL-3.0-or-later
Author: Rémy Sanchez
Author-email: remy.sanchez@hyperthese.net
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: aiohttp (>=3.9.3,<4.0.0)
Requires-Dist: aionotify (>=0.2.0,<0.3.0)
Requires-Dist: babel (>=2.14.0,<3.0.0)
Requires-Dist: facepy (>=1.0.12,<2.0.0)
Requires-Dist: google-api-python-client (>=2.119.0,<3.0.0)
Requires-Dist: httpx (>=0.27.0,<0.28.0)
Requires-Dist: oauth2client (>=4.1.3,<5.0.0)
Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: pytz (>=2022.6,<2023.0)
Requires-Dist: redis (>=5.0.1,<6.0.0)
Requires-Dist: sentry-sdk (>=1.40.6,<2.0.0)
Requires-Dist: ujson (>=5.9.0,<6.0.0)
Requires-Dist: unidecode (>=1.3.8,<2.0.0)
Requires-Dist: uvloop (>=0.19.0,<0.20.0)
Description-Content-Type: text/markdown

BERNARD
=======

[![Build Status](https://travis-ci.org/BernardFW/bernard.svg?branch=develop)](https://travis-ci.org/BernardFW/bernard)

Building *instant services* (or chatbots) is a brand new craft. BERNARD
is here to bring it up to speed for the professional world.

- Take advantage of each platform's specificities (Facebook, Telegram,
  ...)
- Connect your existing business API
- Translate and decline your texts
- Extensible to any platform, without merging to upstream

# Get started!

This documentation will bring you methodology, concepts and patterns to
build bots as well as hands-on experience with the code of a bot.

- **[Get Started](./doc/get-started/readme.md)** course and tutorial
- **[Table of contents](./doc/readme.md)** of all topics in
  documentation

# Licensing

There is a dual licencing scheme here:

- By default, AGPL v3+
- If your project is not compatible with the AGPL, please contact
  *<span>remy.sanchez</span>@with-madrid.com*.

# Contribution

Contribution is of course welcome, although there is a few rules to respect
for the well-being of the project.

## Governance

Please do not hesitate to communicate through GitHub issues before committing
to a large contribution: the team of the project has plans and priorities, so
if you end up going against those it will be hard to merge your code.

## Coding Rules

Coding rules are very, very important. There is not too many yet:

- PEP 8
- Imports are normalized by the `make imports` command
- No undocumented code gets merged
- Code bringing test coverage down or breaking tests doesn't get merged

## Testing

Use `py.test`. Node for later: document this part a bit better.

