spdx_licenses 0.0.1

spdx-licenses-dart #

Build Status Pub

A Dart library for working with the SPDX License List.

Provides a set of convenience classes and APIs for accessing and validating licensing information provided by the SPDX (Software Package Data Exchange) license list.

Usage #

A simple usage example:

import 'package:spdx_licenses/spdx_licenses.dart';

main() async {
  SPDXLicenseDetails details = await SPDXLicenseDetails.readLicenseDetails("Apache-2.0");
       
  ...
}

Features and bugs #

Please file feature requests and bugs at the issue tracker.

License #

Licensed under the terms of the Apache 2.0 license.

0.0.1 #

  • Initial version.

example/spdx_licenses_example.dart

import 'package:spdx_licenses/spdx_licenses.dart';

main() async {
  SPDXLicenseDetails details;

  details = await SPDXLicenseDetails.readLicenseDetails("Apache-2.0");

  print(details.licenseText);
}

Use this package as a library

1. Depend on it

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


dependencies:
  spdx_licenses: ^0.0.1

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:spdx_licenses/spdx_licenses.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
10
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
83
Overall:
Weighted score of the above. [more]
52
Learn more about scoring.

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

  • Dart: 2.4.0
  • pana: 0.12.19

Platforms

Detected platforms: Flutter, other

Primary library: package:spdx_licenses/spdx_licenses.dart with components: isolate.

Health issues and suggestions

Document public APIs. (-0.23 points)

37 out of 38 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.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

The package description is too short. (-7 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
resource ^2.1.5 2.1.6
Transitive dependencies
typed_data 1.1.6
Dev dependencies
test ^1.0.0

Admin