reddit_crawl 0.0.2

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 50

reddit_crawl

A command line tool that uses the Reddit API to track popularity of a keyword. The tool is currently focused on tracking developer technologies, such as programming languages, frameworks or IDEs.

Installation

  1. Make sure you have Dart installed and it's in your path.
  2. Run pub global activate reddit_crawl.

Example usage

To get data for "dart" for the past 3 months (default), run this:

$ reddit_crawl dart

This will fetch the data and it will create 2 sets of files in the current working directory:

  1. output-dart-2018-01-01 (.json and .tsv) with the results of this run
    • This is useful for 'point in time' view and for backup of previous runs.
  2. output-dart-all (.json and .tsv) with the results of this run merged with whatever was there previously
    • This is your 'tracking' output that you can update with latest Reddit buzz as time progresses.

The JSON files include all the data received from Reddit API. The TSV file is useful for copypasting into spreadsheets and includes only a subset of the data and some helper columns.

Advanced usage

Run the tool without parameters to get help.

$ reddit_crawl
Exactly one argument is requred: a name of a technology.

Additional options:
-v, --verbose    Verbose mode.
    --months     Number of months to crawl in reverse chronological order.
                 (defaults to "3")

    --mobile     Use additional subreddits that specialize in mobile development.
    --web        Use additional subreddits that specialize in web development.

To get all mentions of "vim" on major Reddit programming forums, including mobile- and web-focused ones, from the past 6 years (6 * 12 = 72 months), use:

$ reddit_crawl --months 72 --mobile --web vim 

Later, you can just run reddit_crawl --mobile --web vim to update your output-vim-all files with the latest submissions.

Changelog

0.0.1

  • Initial version

1. Depend on it

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


dependencies:
  reddit_crawl: "^0.0.2"

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 packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:reddit_crawl/config.dart';

import 'package:reddit_crawl/json2csv.dart';
        
Version Uploaded Documentation Archive
0.0.2 May 26, 2017 Go to the documentation of reddit_crawl 0.0.2 Download reddit_crawl 0.0.2 archive
0.0.1 May 26, 2017 Go to the documentation of reddit_crawl 0.0.1 Download reddit_crawl 0.0.1 archive

Analysis

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

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 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]
50
Learn more about scoring.

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

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.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use reddit_crawl.dart.

  • Use analysis_options.yaml.

    Rename old .analysis_options file to analysis_options.yaml.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.23.0 <2.0.0
args ^0.13.7 0.13.7 1.4.2
http ^0.11.3+13 0.11.3+16
logging ^0.11.3+1 0.11.3+1
path ^1.4.1 1.5.1
Transitive dependencies
async 2.0.6
charcode 1.1.1
collection 1.14.9
http_parser 3.1.1
source_span 1.4.0
string_scanner 1.0.2
typed_data 1.1.5
Dev dependencies
test >=0.12.0 <0.13.0