zipcode_jp 0.1.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 51

zipcode_jp #

Description #

zipcode_jp is a Japanese zip code library for Dart.

Created from templates made available by Stagehand under a The MIT License license.

Copyright 2019 Hiroki Kaneko

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage #

A simple usage example:

import 'package:zipcode_jp/zipcode_jp.dart';

main() {
  var zipJp = new ConvToAddressByJpZip();
  var result = zipJp.getAddressByZipCode("0200802"); // 7 digits
  print(result); // => "岩手県盛岡市つつじが丘"
}

Using Libraries and Data #

dependencies:
  csv: ^4.0.3
  archive: ^2.0.10

The postal code data saved by this project uses a database published by Japan Post.

Features and bugs #

Please file feature requests and bugs at the issue tracker.

License #

MIT

Author #

Hiroki Kaneko kaneko.hiroki@gmail.com

Homepage #

https://github.com/hiroki-kaneko/zipcode_jp

Version #

0.1

0.1.0 #

  • Initial version, created by Stagehand

example/zipcode_jp_example.dart

import 'package:zipcode_jp/zipcode_jp.dart';

main() {
  var awesome = Awesome();
  print('awesome: ${awesome.isAwesome}');
}

Use this package as a library

1. Depend on it

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


dependencies:
  zipcode_jp: ^0.1.0

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

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

  • Dart: 2.6.1
  • pana: 0.13.1+4

Health suggestions

Format lib/zipcode_jp.dart.

Run dartfmt to format lib/zipcode_jp.dart.

Maintenance suggestions

The package description is too short. (-8 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.4.0 <3.0.0
archive ^2.0.10 2.0.11
csv ^4.0.3 4.0.3
Transitive dependencies
args 1.5.2
charcode 1.1.2
collection 1.14.12
convert 2.1.1
crypto 2.1.4
path 1.6.4
typed_data 1.1.6
Dev dependencies
pedantic ^1.7.0
test ^1.6.0