threads_client 0.1.7

dart-threads-client #

Made by Textile Chat on Slack GitHub license Dart CI Pub Threads version Build status

Textile's Dart client for interacting with remote Threads

Join us on our public Slack channel for news, discussions, and status updates. Check out our blog for the latest posts and announcements.

Table of Contents #

Getting Started #

In the pubspec.yaml of your project, add the following dependency:

See latest version in badge at top of README.

  threads_client: "^0.x.x"

Run Threads Daemon #

You need to run a threads daemon available to the client.

git clone
cd go-threads
go run threadsd/main.go -debug

Usage #

You can see complete usage examples in the provided test suite:

Development #

Install #

Run the daemon, as above. Next, install and run the Dart threads_client:

git clone
cd dart-threads-client
pub get

Run tests #

dart test/threads_client_test.dart

Run example #

dart examples/helloworld.dart

Usage #

Start Client & Create a Store

import 'package:threads_client/threads_client.dart' as threads;

void main(List<String> args) async {
  final client = threads.Client();
  final store = await client.newStore();
  print('New store $store');

Run Threads using hosted Textile API #

import 'package:textile/textile.dart' as textile;
import 'package:threads_client/threads_client.dart' as threads;

const APP_TOKEN = '<app token>';
const DEVICE_ID = '<uuid>';

void main(List<String> args) async {
  final config = textile.ThreadsConfig(APP_TOKEN, DEVICE_ID);
  final client = threads.Client(config: config);
  final store = await client.newStore();
  print('New store $store');

Further examples #

You can find a good overview of Client methods in the test suite.

Threads Client Tests

Add custom metadata to requests #

For example, add a custom auth token to the header of each request.

    final config = ThreadsConfig(
      host: '',
      port: 6006,
      callOptionsMetaData: {
        'authorization': 'Bearer 3f2950d0-5522-4425-829f-75894e233442'
    // Create a new threads client
    client = Client(config);

Contributing #

This project is a work in progress. As such, there's a few things you can do right now to help out:

  • Ask questions! We'll try to help. Be sure to drop a note (on the above issue) if there is anything you'd like to work on and we'll update the issue to let others know. Also get in touch on Slack.
  • Open issues, file issues, submit pull requests!
  • Perform code reviews. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
  • Take a look at the code. Contributions here that would be most helpful are top-level comments about how it should look based on your understanding. Again, the more eyes the better.
  • Add tests. There can never be enough tests.

Before you get started, be sure to read our contributors guide and our contributor covenant code of conduct.

Changelog #

Changelog is published to Releases.

License #



A single example is made available:

/helloworld.dart: A demonstration of using the Dart thread client to generate and start a new datastore. 

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  threads_client: ^0.1.7

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:threads_client/threads_client.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Feb 14, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.5

Health issues and suggestions

Document public APIs. (-1 points)

107 out of 107 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/src/client.dart.

Run dartfmt to format lib/src/client.dart.

Format lib/src/config.dart.

Run dartfmt to format lib/src/config.dart.

Format lib/src/defaults.dart.

Run dartfmt to format lib/src/defaults.dart.

Format lib/src/models.dart.

Run dartfmt to format lib/src/models.dart.

Format lib/threads_client.dart.

Run dartfmt to format lib/threads_client.dart.

Maintenance issues and suggestions

Provide a file named (-20 points)

Changelog entries help developers follow the progress of your package. See the example generated by stagehand.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.0 <3.0.0
async ^2.2.0 2.4.0
grpc ^2.1.3 2.1.3
protobuf ^1.0.1 1.0.1
threads_client_grpc ^0.1.7 0.1.9
uuid ^2.0.4 2.0.4
Transitive dependencies
charcode 1.1.3
collection 1.14.12
convert 2.1.1
crypto 2.1.4
fixnum 0.10.11
googleapis_auth 0.2.11+1
http 0.12.0+4
http2 1.0.0
http_parser 3.1.3
meta 1.1.8
path 1.6.4
source_span 1.6.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
pedantic ^1.0.0 1.9.0
test ^1.6.4