mashov_api 0.2.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 68

Mashov Api #

...What is this thing? #

The Mashov (students) API - for flutter.

Where do I get started? #

First of all, get yourself a nice Api Controller to your code:

var controller = MashovApi.getController();

Next, get the list of schools:

var schoolsResult = await controller.getSchools();
if(schoolsResult.isSucess) {
  var schools = schoolsResult.value;
}

Now, you can pick your school and log in with it:

await controller.login(mySchool, myId, mySecretPassword, year)

Once you log in successfully... You can do whatever you want!

controller.getGrades();
controller.getBehaveEvents();
....

...Are there any docs? #

Well, the code is pretty well documented. If you have any issues, post a new issue.

0.0.1 #

Initial commit

0.0.2 #

Fixed unhandled exception on login

0.0.3 #

Added Bagrut grades and Hatamot APIs.

0.0.4 #

Added Api enum and Data Processor to Api Controller.

0.0.5 #

Put all models file in one file, and by doing this exported another two models that were not exported in version 0.0.4

0.0.6 #

Added statusCode to Login, and some nice getters such as isUnauthorized.

Use this package as a library

1. Depend on it

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


dependencies:
  mashov_api: ^0.2.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

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

3. Import it

Now in your Dart code, you can use:


import 'package:mashov_api/mashov_api.dart';
  
Version Uploaded Documentation Archive
0.2.0 Apr 20, 2019 Go to the documentation of mashov_api 0.2.0 Download mashov_api 0.2.0 archive
0.1.0 Apr 18, 2019 Go to the documentation of mashov_api 0.1.0 Download mashov_api 0.1.0 archive
0.0.13 Apr 3, 2019 Go to the documentation of mashov_api 0.0.13 Download mashov_api 0.0.13 archive
0.0.12 Mar 31, 2019 Go to the documentation of mashov_api 0.0.12 Download mashov_api 0.0.12 archive
0.0.11 Mar 30, 2019 Go to the documentation of mashov_api 0.0.11 Download mashov_api 0.0.11 archive
0.0.10 Mar 30, 2019 Go to the documentation of mashov_api 0.0.10 Download mashov_api 0.0.10 archive
0.0.9 Mar 21, 2019 Go to the documentation of mashov_api 0.0.9 Download mashov_api 0.0.9 archive
0.0.8 Feb 6, 2019 Go to the documentation of mashov_api 0.0.8 Download mashov_api 0.0.8 archive
0.0.7 Feb 4, 2019 Go to the documentation of mashov_api 0.0.7 Download mashov_api 0.0.7 archive
0.0.6 Feb 3, 2019 Go to the documentation of mashov_api 0.0.6 Download mashov_api 0.0.6 archive

All 15 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
44
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
68
Learn more about scoring.

We analyzed this package on Apr 24, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.2.0
  • pana: 0.12.14
  • Flutter: 1.4.7

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Fix lib/src/utils.dart. (-0.50 points)

Analysis of lib/src/utils.dart reported 1 hint:

line 9 col 14: Name non-constant identifiers using lowerCamelCase.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and mashov_api.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

The description is too long. (-10 points)

Search engines display only the first part of the description. Try to keep the value of the description field in your package's pubspec.yaml file between 60 and 180 characters.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
http ^0.12.0+2 0.12.0+2
Transitive dependencies
async 2.2.0
charcode 1.1.2
collection 1.14.11
http_parser 3.1.3
meta 1.1.6 1.1.7
path 1.6.2
pedantic 1.5.0
sky_engine 0.0.99
source_span 1.5.5
string_scanner 1.0.4
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8