Metadata-Version: 2.5
Name: abilian-sbe
Version: 2.0.0rc1
Summary: Social Business platform (entreprise collaboration and information management)
Project-URL: Repository, https://github.com/abilian/abilian-sbe
Author-email: Abilian SAS <sales@abilian.com>
License-Expression: LGPL-2.0-or-later
License-File: LICENCE.txt
Requires-Python: >=3.12
Requires-Dist: alembic>=1.20.1
Requires-Dist: apscheduler<4.0.0,>=3.10.4
Requires-Dist: attrs>=24.2.0
Requires-Dist: babel
Requires-Dist: bcrypt==4.3.0
Requires-Dist: bleach[css]<7.0.0,>=6.2.0
Requires-Dist: blinker>=1.6.2
Requires-Dist: chardet
Requires-Dist: click>=8.1.3
Requires-Dist: defusedxml<0.8.0,>=0.7.1
Requires-Dist: dramatiq-abort<2.0.0,>=1.1.0
Requires-Dist: dramatiq>=1.15.0
Requires-Dist: filelock>=3.15
Requires-Dist: flask-babel<2.0.0,>=1.0.0
Requires-Dist: flask-dramatiq>=0.6.0
Requires-Dist: flask-login>=0.6.3
Requires-Dist: flask-mail>=0.9.1
Requires-Dist: flask-migrate>=4.0.5
Requires-Dist: flask-sqlalchemy<3.2,>=3.1
Requires-Dist: flask-super>=0.2.8
Requires-Dist: flask-talisman>=1.1.0
Requires-Dist: flask-vite>=0.6.1
Requires-Dist: flask-wtf>=1.2.0
Requires-Dist: flask>=3.1.0
Requires-Dist: gunicorn
Requires-Dist: html2text>=2024
Requires-Dist: hyperlink>=21.0.0
Requires-Dist: itsdangerous>=2.1.2
Requires-Dist: jinja2>=3.1.3
Requires-Dist: langid>=1.1.6
Requires-Dist: loguru<0.8.0,>=0.7.2
Requires-Dist: markdown<4,>=3
Requires-Dist: markupsafe>=2.1.4
Requires-Dist: maxminddb
Requires-Dist: openpyxl
Requires-Dist: pillow
Requires-Dist: pymysql<2.0.0,>=1.1.0
Requires-Dist: pytest>=8.3.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: python-dotenv>=1.2.4
Requires-Dist: python-magic
Requires-Dist: pytz
Requires-Dist: redis>=4.6.0
Requires-Dist: sentry-sdk[flask]
Requires-Dist: sqlalchemy<2.1,>=2.0
Requires-Dist: svcs>=24.1.0
Requires-Dist: toolz
Requires-Dist: tqdm
Requires-Dist: validate-email
Requires-Dist: werkzeug>=3.1.0
Requires-Dist: whoosh-reloaded<3.0.0,>=2.7.5
Requires-Dist: wtforms-alchemy>=0.18.0
Requires-Dist: wtforms-sqlalchemy>=0.4.1
Requires-Dist: wtforms>=3.1.2
Requires-Dist: xlwt
Provides-Extra: postgres
Requires-Dist: psycopg2-binary>=2.9.13; extra == 'postgres'
Description-Content-Type: text/markdown

# Abilian SBE

[![builds.sr.ht status](https://builds.sr.ht/~sfermigier/abilian-sbe/commits/main/ubuntu-lts.yml.svg)](https://builds.sr.ht/~sfermigier/abilian-sbe/commits/main/ubuntu-lts.yml?)

**Abilian SBE** is a free and open source collaboration platform. It gives every team, project or working group of an organisation a **community**: a shared space with its discussions, its documents, its wiki and its calendar. Members see what is new in one feed, find anything with one search, and invite the people they work with.

It has run in production since 2013, as the extranet of clusters of companies, professional networks and associations.

![My feed: what is new in your communities, the communities themselves and the events to come.](docs/src/assets/shots/en/home.png)

## What it does

- **Communities**, each with its members and managers, its tools, and its own rules: closed, open on request or open to all.
- **Discussions**, with attachments, unread messages marked, and e-mail to all members when needed.
- **Documents**, in folders, with previews, versions, comments, locks and per-folder permissions; search reads their text.
- **A wiki** in Markdown, with a live preview, links between pages and their history.
- **A calendar** per community, with each event's files and discussion, and `.ics` files for any calendar application.
- **My feed**, a daily e-mail summary, a directory of people and a search that suggests as you type.
- **An administration** for accounts, communities, settings and the log of changes.

The interface is in English and French, accessible, and works on phones.

## Documentation

The documentation is in [`docs/`](docs/), in English and French: a user guide, an administration guide, installation and configuration, and a developer guide. Build it with `make serve` in `docs/`; see [the developer guide](docs/src/develop/index.md#this-documentation).

## Trying it

You need [uv](https://docs.astral.sh/uv/), Node and npm, and Redis.

```bash
git clone https://github.com/abilian/abilian-sbe-monorepo.git
cd abilian-sbe-monorepo
make install front translations
cp example_config/dot_env .env      # then edit it
uv run flask initdb
uv run flask createuser --role admin --name Admin admin@example.org a-password
make run
```

## Running it in production

- **On [Hop3](https://hop3.cloud/)**: a small project pins the version of SBE from PyPI, and its `hop3.toml` runs it with PostgreSQL and Redis and keeps the files on a volume. See [docs/src/install/hop3.md](docs/src/install/hop3.md).
- **On a server**, Debian or Ubuntu, with PostgreSQL or MariaDB, behind nginx: see [docs/src/install/server.md](docs/src/install/server.md).

The settings are environment variables: see [docs/src/install/configuration.md](docs/src/install/configuration.md).

## Developing

```bash
make test       # the pytest suite
make test-e2e   # the browser tests, with an accessibility sweep
make lint       # the linters and checks
```

The [developer guide](docs/src/develop/index.md) describes the code, the tests and how to contribute. Design decisions are recorded as [Architecture Decision Records](notes/adrs/), and the changes in the [changelog](CHANGELOG.md).

## Licence

Abilian SBE is free software, under the [GNU Lesser General Public License, version 3](LICENSES/LGPL-3.0-only.txt), developed by [Abilian](https://abilian.com/). The project follows the [REUSE](https://reuse.software/) specification: `REUSE.toml` declares the copyright and licence of every file.
