Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vincenzopalazzo/octokit.dart
:dart: Dart toolkit for the GitHub GraphQL API :dart:
https://github.com/vincenzopalazzo/octokit.dart
dart-library dart-package dartlang flutter github github-api graphql
Last synced: 27 days ago
JSON representation
:dart: Dart toolkit for the GitHub GraphQL API :dart:
- Host: GitHub
- URL: https://github.com/vincenzopalazzo/octokit.dart
- Owner: vincenzopalazzo
- License: bsd-3-clause
- Created: 2022-01-17T16:41:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-12T13:24:49.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T07:02:06.347Z (about 1 month ago)
- Topics: dart-library, dart-package, dartlang, flutter, github, github-api, graphql
- Language: Dart
- Homepage: https://github.com/vincenzopalazzo/octokit.dart
- Size: 305 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Table of Content
- Introduction
- Getting started
- Usage
- License
## Introduction
[Github API v4](https://docs.github.com/en/graphql) dart wrapper to interact with Github in your application with dart and flutter.
The library is flexible and provide all what the user need, all the feature that are supported and will be supported are listed below:
- [X] Raw GraphQL query and mutation
- [X] Autogenerate the query from a .graphql file and work with dart object in your app
## Getting started
### Dart
```bash
dart pub add octokit
```
### Flutter
```bash
flutter pub add octokit
```
or add this line to your pubspec.yaml
```yaml
dependencies:
octokit: ^0.0.1
```
For the Usage see the next section!
## Usage
## Raw Query
```dart
import 'dart:io';
import 'package:octokit/octokit.dart';
void main() async {
var sysEnv = Platform.environment;
var token = sysEnv["GITHUB_TOKEN"]!;
GithubClient client = GithubClient(token: token);
var query = r'''
query {
viewer {
__typename
login
}
}
''';
var response =
await client.rawQuery(queryDefinition: query, queryName: "viewer");
print(response);
}
```
## Additional information
This package is a designed to be auto managed be the end user, in fact this package give the API to work with
code generation from graphql schema, so you can implement your custom query on your client and handle all with the
API provided by octokit.dart
## License
```
Copyright 2022 Vincenzo Palazzo . All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
