99b28c1d95
* refactor: start building an Android package Part of https://github.com/ooni/probe/issues/1335. This seems also a good moment to move some packages out of the engine, e.g., oonimkall. This package, for example, is a consumer of the engine, so it makes sense it's not _inside_ it. * fix: committed some stuff I didn't need to commit * fix: oonimkall needs to be public to build The side effect is that we will probably need to bump the major version number every time we change one of these APIs. (We can also of course choose to violate the basic guidelines of Go software, but I believe this is bad form.) I have no problem in bumping the major quite frequently and in any case this monorepo solution is convinving me more than continuing to keep a split between engine and cli. The need to embed assets to make the probe more reliable trumps the negative effects of having to ~frequently bump major because we expose a public API. * fix: let's not forget about libooniffi Honestly, I don't know what to do with this library. I added it to provide a drop in replacement for MK but I have no idea whether it's used and useful. I would not feel comfortable exposing it, unlike oonimkall, since we're not using it. It may be that the right thing to do here is just to delete the package and reduce the amount of code we're maintaining? * woops, we're still missing the publish android script * fix(publish-android.bash): add proper API key * ouch fix another place where the name changed
21 lines
927 B
Markdown
21 lines
927 B
Markdown
# Package github.com/ooni/probe-cli/pkg/oonimkall
|
|
|
|
Package oonimkall implements APIs used by OONI mobile apps. We
|
|
expose these APIs to mobile apps using gomobile.
|
|
|
|
We expose two APIs: the task API, which is derived from the
|
|
API originally exposed by Measurement Kit, and the session API,
|
|
which is a Go API that mobile apps can use via `gomobile`.
|
|
|
|
This package is named oonimkall because it contains a partial
|
|
reimplementation of the mkall API implemented by Measurement Kit
|
|
in, e.g., [mkall-ios](https://github.com/measurement-kit/mkall-ios).
|
|
|
|
The basic tenet of the task API is that you define an experiment
|
|
task you wanna run using a JSON, then you start a task for it, and
|
|
you receive events as serialized JSONs. In addition to this
|
|
functionality, we also include extra APIs used by OONI mobile.
|
|
|
|
The basic tenet of the session API is that you create an instance
|
|
of `Session` and use it to perform the operations you need.
|