154 lines
5.0 KiB
Plaintext
154 lines
5.0 KiB
Plaintext
= mastodonpp
|
|
:toc: preamble
|
|
:project: mastodonpp
|
|
:uri-base: https://schlomp.space/tastytea/{project}
|
|
:uri-branch-main: {uri-base}/src/branch/main
|
|
:uri-mastodon-cpp: https://schlomp.space/tastytea/mastodon-cpp
|
|
:uri-reference: https://doc.schlomp.space/{project}/
|
|
:uri-gcc: https://gcc.gnu.org/
|
|
:uti-clang: https://clang.llvm.org/
|
|
:uri-cmake: https://cmake.org/
|
|
:uri-doxygen: http://www.doxygen.nl/
|
|
:uri-catch: https://github.com/catchorg/Catch2
|
|
:uri-dpkg: https://packages.qa.debian.org/dpkg
|
|
:uri-rpm-build: http://www.rpm.org
|
|
:uri-libcurl: https://curl.haxx.se/libcurl/
|
|
|
|
*{project}* is a C++ wrapper for the Mastodon API. It replaces
|
|
link:{uri-mastodon-cpp}[mastodon-cpp].
|
|
|
|
We aim to create a library that is comfortable, yet minimal. All API endpoints
|
|
from Mastodon and Pleroma are stored in ``enum class``es, to counteract typos and
|
|
make your life easier. The network-facing code is built on
|
|
link:{uri-libcurl}[libcurl], a mature and stable library that is available on
|
|
virtually every operating system. The library does not parse the responses
|
|
itself, but returns to you the raw data, because we know everyone has their
|
|
favorite JSON library and we don't want to impose our choice on you!
|
|
|
|
== Features
|
|
|
|
This is still a work in progress; here is a rough overview of the features:
|
|
|
|
* [ ] Requests
|
|
** [x] `GET` requests.
|
|
** [x] Streaming `GET` requests.
|
|
** [x] `POST` requests.
|
|
** [ ] `PATCH` requests.
|
|
** [ ] `PUT` requests.
|
|
** [ ] `DELETE` requests.
|
|
* [x] Report maximum allowed character per post.
|
|
* [ ] Comfortable access to pagination headers.
|
|
* [ ] Comfortable function to register a new “app” (get an access token).
|
|
|
|
== Usage
|
|
|
|
Have a look at the link:{uri-reference}[reference].
|
|
|
|
=== Example
|
|
|
|
[source,cpp]
|
|
--------------------------------------------------------------------------------
|
|
#include "mastodonpp.hpp"
|
|
#include <iostream>
|
|
|
|
int main()
|
|
{
|
|
mastodonpp::Instance instance{"example.com", {}};
|
|
mastodonpp::Connection connection{instance};
|
|
|
|
const mastodonpp::parametermap parameters
|
|
{
|
|
{"status", "How is the wheather?"},
|
|
{"poll[options]", vector<string_view>{"Nice", "not nice"}},
|
|
{"poll[expires_in]", "86400"}
|
|
};
|
|
auto answer{connection.post(mastodonpp::API::v1::statuses, parameters)};
|
|
|
|
if (answer)
|
|
{
|
|
std::cout << answer << std::endl;
|
|
}
|
|
}
|
|
--------------------------------------------------------------------------------
|
|
|
|
link:{uri-reference}/examples.html[More examples] are included in the reference.
|
|
|
|
== Install
|
|
|
|
=== Gentoo
|
|
|
|
[source,shell]
|
|
--------------------------------------------------------------------------------
|
|
eselect repository enable tastytea
|
|
echo 'dev-cpp/mastodonpp' >> /etc/portage/package.accept_keywords/mastodonpp
|
|
emaint sync -r tastytea
|
|
emerge -a dev-cpp/mastodonpp
|
|
--------------------------------------------------------------------------------
|
|
|
|
=== Debian and Ubuntu
|
|
|
|
We automatically generate packages for Debian buster (10) and Ubuntu bionic
|
|
(18.04), but only for x86_64 (amd64). Download the them at
|
|
link:{uri-base}/releases[schlomp.space].
|
|
|
|
[source,shell]
|
|
--------------------------------------------------------------------------------
|
|
apt install ./libmastodonpp*.deb
|
|
--------------------------------------------------------------------------------
|
|
|
|
=== CentOS
|
|
|
|
We automatically generate packages for CentOS 8, but only for x86_64
|
|
(amd64). Download the them at link:{uri-base}/releases[schlomp.space].
|
|
|
|
[source,shell]
|
|
--------------------------------------------------------------------------------
|
|
yum install ./libmastodonpp*.rpm
|
|
--------------------------------------------------------------------------------
|
|
|
|
=== From source
|
|
|
|
==== Dependencies
|
|
|
|
* Tested OS: Linux
|
|
* C++ compiler (tested: link:{uri-gcc}[GCC] 7/8/9, link:{uri-lang}[clang] 6/7)
|
|
* link:{uri-cmake}[CMake] (at least: 3.9)
|
|
* link:{uri-libcurl}[libcurl] (at least: 7.56)
|
|
* Optional
|
|
** Documentation: link:{uri-doxygen}[Doxygen] (tested: 1.8)
|
|
** Tests: link:{uri-catch}[Catch] (tested: 2.5 / 1.2)
|
|
** DEB package: link:{uri-dpkg}[dpkg] (tested: 1.18)
|
|
** RPM package: link:{uri-rpm-build}[rpm-build] (tested: 4.11)
|
|
|
|
==== Get sourcecode
|
|
|
|
===== Release
|
|
|
|
Download the current release at link:{uri-base}/releases[schlomp.space].
|
|
|
|
===== Development version
|
|
|
|
[source,shell]
|
|
--------------------------------------------------------------------------------
|
|
git clone https://schlomp.space/tastytea/mastodonpp.git
|
|
--------------------------------------------------------------------------------
|
|
|
|
==== Compile
|
|
|
|
[source,shell]
|
|
--------------------------------------------------------------------------------
|
|
mkdir -p build && cd build
|
|
cmake ..
|
|
cmake --build . -- -j$(nproc --ignore=1)
|
|
--------------------------------------------------------------------------------
|
|
|
|
.CMake options:
|
|
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build.
|
|
* `-DWITH_TESTS=YES` if you want to compile the tests.
|
|
* `-DWITH_EXAMPLES=YES` if you want to compile the examples.
|
|
* One of:
|
|
** `-DWITH_DEB=YES` if you want to be able to generate a deb-package.
|
|
** `-DWITH_RPM=YES` if you want to be able to generate an rpm-package.
|
|
|
|
include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]
|