Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Archdown

Command-line utility to download books from archive.org using archivist-client

Project Archdown
gem name archdown
license MIT
moldiness Maintainer Status
version Gem Version
dependencies Dependency Status
code quality Code Climate
inline documenation Inline docs
continuous integration Build Status
test coverage Coverage Status
homepage https://github.com/wordtreefoundation/archdown
documentation http://rdoc.info/github/wordtreefoundation/archdown/frames
authors Duane Johnson Endorse Duane
Peter Boling Endorse Peter

Installation

Add this line to your application's Gemfile:

gem 'archdown'

And then execute:

$ bundle

Or install it yourself as:

$ gem install archdown

Usage

Download from the command-line:

$ gem install archdown
$ archdown -y 1700-1830

# ...
# downloads a lot of books into ./library
# ...

More advanced usage: use as a Ruby library. Here's an example of a query that downloads a book by archive.org identifier:

d = Archdown::Download.new('library',
  :filters => ["identifier:firstbooknapole00gruagoog"])

d.go!{ |metadata, librarian| puts m.inspect }

Or a set of books within a range of years:

d = Archdown::Download.new('library',
  :start_year => 1800, :end_year => 1850)

d.go!{ |metadata, librarian| puts m.inspect }

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/archdown/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Make sure to add tests!
  6. Create a new Pull Request

Contributors

See the Network View

References

About

Command-line utility to download books from archive.org using archivist-client

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.