dotenv 1.0.0

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 81

dotenv

Load environment variables at runtime from a .env file.

Pub Version Build Status Documentation

about

Deploying applications should be simple. This implies constraints:

The twelve-factor app stores config in environment variables (often shortened to env vars or env). Env vars are easy to change between deploys without changing any code... they are a language- and OS-agnostic standard.

An environment is the set of variables known to a process (say, PATH, PORT, ...). It is desirable to mimic the production environment during development (testing, staging, ...) by reading these values from a file.

This library parses that file and merges its values with the built-in Platform.environment map.

usage

See documentation and examples.

cli

Get the latest:

$ pub global activate dotenv

Run:

$ pub global run dotenv:new  # create a .env file and add it to .gitignore
$ pub global run dotenv      # load the file and print the environment to stdout

discussion

Use the issue tracker for bug reports and feature requests.

Pull requests gleefully considered.

prior art
license: MIT

changelog

This project follows pub-flavored semantic versioning. (more)

Release notes are available on github.

1.0.0

  • Dart 2 compatible. #16

0.1.3+3

  • [docs] tweak README

0.1.3+2

  • [fix] don't throw if load fails #11

0.1.3+1

  • [fix] allow braces with ${var} substitution #10

0.1.3

  • [new] add command-line interface #7, #8
  • [deps] add args@v0.13

0.1.2

  • [new] support variable substitution from Platform.environment #6
  • [deps] drop logging

0.1.1+2

  • [fix] don't strip # inside quotes #5

0.1.1+1

  • [fix] whitespace causes quotes not to be stripped

0.1.1

  • [deprecated] Parser internals will become private. #3
    • #unquote, #strip, #swallow, #parseOne, #surroundingQuote, #interpolate
  • [new] support variable substitution
  • [deps] migrate to test
  • [deps] bump logging

0.1.0

Initial release.

example/example.dart

import 'dart:io';

import 'package:dotenv/dotenv.dart' show load, clean, isEveryDefined, env;

void main() {
  load();

  p('read all vars? ${isEveryDefined(['foo', 'baz'])}');

  p('value of foo is ${env['foo']}');
  p('value of baz is ${env['baz']}');
  p('your home directory is: ${env['HOME']}');

  clean();

  p('cleaned!');
  p('env has key foo? ${env.containsKey('foo')}');
  p('env has key baz? ${env.containsKey('baz')}');
  p('your home directory is still: ${env['HOME']}');
}

p(String msg) => stdout.writeln(msg);

Use this package as a library

1. Depend on it

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


dependencies:
  dotenv: "^1.0.0"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or 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:dotenv/dotenv.dart';
  
Version Uploaded Documentation Archive
1.0.0 Jul 12, 2018 Go to the documentation of dotenv 1.0.0 Download dotenv 1.0.0 archive
0.1.3+3 Jul 19, 2015 Go to the documentation of dotenv 0.1.3+3 Download dotenv 0.1.3+3 archive
0.1.3+2 Jun 5, 2015 Go to the documentation of dotenv 0.1.3+2 Download dotenv 0.1.3+2 archive
0.1.3+1 May 15, 2015 Go to the documentation of dotenv 0.1.3+1 Download dotenv 0.1.3+1 archive
0.1.3 May 15, 2015 Go to the documentation of dotenv 0.1.3 Download dotenv 0.1.3 archive
0.1.2 May 12, 2015 Go to the documentation of dotenv 0.1.2 Download dotenv 0.1.2 archive
0.1.1+2 May 10, 2015 Go to the documentation of dotenv 0.1.1+2 Download dotenv 0.1.1+2 archive
0.1.1+1 May 10, 2015 Go to the documentation of dotenv 0.1.1+1 Download dotenv 0.1.1+1 archive
0.1.1 May 10, 2015 Go to the documentation of dotenv 0.1.1 Download dotenv 0.1.1 archive
0.1.0 Apr 7, 2015 Go to the documentation of dotenv 0.1.0 Download dotenv 0.1.0 archive

All 11 versions...

Analysis

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

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

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

Platforms

Detected platforms: Flutter, other

Primary library: package:dotenv/dotenv.dart with components: io.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0 <3.0.0
args ^1.0.0 1.4.3
dart2_constant ^1.0.0 1.0.1+dart2
meta ^1.0.2 1.1.5
Dev dependencies
collection any
test any