Agenda du libre
===============

The Agenda du libre is a calendar for events (which can be submitted
by anybody but that are moderated before being published).

It is a web application that is available under the GNU AGPL version 3
or later and its source code is available here:
https://git.framasoft.org/agenda-libre/agenda-libre-ruby and you can
use it at least at https://www.agendadulibre.org

The adl-submit program is a client application that can talk with an
instance of the Agenda du libre, in order to be able to submit an
event, either through command like arguments, or by sending an XML
file that contains the required data.

Source code and usage
=====================

To install adl-submit under Debian 12 (bookworm), you need to install
the `python3-pycurl` package.

Once this is done, you can download adl-submit with the following
command:

` ~ $ git clone https://framagit.org/agenda-libre/adl-submit.git`

We then need to go inside the adl-submit directory:

`~ $ cd adl-submit`

Once downloaded, you can simply run adl-submit in a terminal with the
following command (this will print the help):

`~ $ python3 adl-submit --help`

Alternatively, we can also download it from an Agenda du libre
instance, for instance from
https://www.agendadulibre.org/adl-submit.py.

And here's the command to run it:

`~ $ python3 adl-submit.py --help`

Pip
===

Alternatively, adl-submit can also be installed in a local directory
with pip. To do that you can run the following commands:

```
~ $ python3 -m venv adl-submit
~ $ adl-submit/bin/pip install \
    git+https://framagit.org/agenda-libre/adl-submit.git
```

Once done, adl-submit can then be run locally:

```
~ $ adl-submit/bin/adl-submit --help
Soumettre un évènement dans l'Agenda du Libre

Options:
    --file        event.xml   Fichier XML décrivant l'évènement.
[...]
```

License
=======

adl-submit is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation.

adl-submit is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, see <https://www.gnu.org/licenses/>.

Contributions
=============

Since adl-submit is not yet packaged in distributions like Debian,
when contributing to adl-submit, you need to make sure that adl-submit
keeps working if people only download the adl-submit.py file.

Discussions
===========

There is an IRC channel (#agendadulibre) inside the Libera Chat
network.
