Skip to content

adrianclay/ruby-ixbrl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ixbrl

Build Status

Limited library of ixbrl related functions.

  • Ixbrl::DocumentParser.get_items_under_instants pulls out xbrl elements from a document keyed by context instant.
{
  '2012-01-01' => {
    'http://www.xbrl.org/uk/gaap/core/2009-09-01:CurrentAssets' => 180.0,
    ...
  }
}
# Bring up Elasticsearch server
docker-compose up -d
# Start interactive ruby shell
./bin/console
# See http://www.rubydoc.info/gems/elasticsearch-transport/5.0.1/Elasticsearch/Transport/Client#initialize-instance_method
import = Ixbrl::ImportAccountsToElasticSearch.new(Elasticsearch::Client.new)
# Download zips from http://download.companieshouse.gov.uk/en_accountsdata.html
import.import_companies_house_archive("spec/ch_09175128.zip")

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also 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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/adrianclay/ixbrl.

License

The gem is available as open source under the terms of the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published