{"id":20502593,"url":"https://github.com/sypht-team/sypht-ruby-client","last_synced_at":"2026-05-28T21:31:23.585Z","repository":{"id":78997610,"uuid":"210125739","full_name":"sypht-team/sypht-ruby-client","owner":"sypht-team","description":"A Ruby client for the Sypht API","archived":false,"fork":false,"pushed_at":"2019-10-03T07:01:30.000Z","size":55,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-12T20:48:15.251Z","etag":null,"topics":["api-client","data-extraction","document-capture","extract","extract-data-from-pdf","extract-fields","information-retrieval","invoice","invoice-parser","pdf-parser","receipt-capture","receipt-reader","receipt-scanner","receipt-scanning","ruby","ruby-gem","ruby-library","sypht","sypht-api","sypht-ruby-client"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sypht-team.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-22T10:01:53.000Z","updated_at":"2023-10-29T10:37:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"a82164ea-5a7a-4037-9357-b4b14bf16adf","html_url":"https://github.com/sypht-team/sypht-ruby-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sypht-team/sypht-ruby-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-ruby-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-ruby-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-ruby-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-ruby-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sypht-team","download_url":"https://codeload.github.com/sypht-team/sypht-ruby-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sypht-team%2Fsypht-ruby-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33627934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-28T02:00:06.440Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","data-extraction","document-capture","extract","extract-data-from-pdf","extract-fields","information-retrieval","invoice","invoice-parser","pdf-parser","receipt-capture","receipt-reader","receipt-scanner","receipt-scanning","ruby","ruby-gem","ruby-library","sypht","sypht-api","sypht-ruby-client"],"created_at":"2024-11-15T19:24:09.010Z","updated_at":"2026-05-28T21:31:23.569Z","avatar_url":"https://github.com/sypht-team.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.com/sypht-team/sypht-ruby-client.svg?branch=master)](https://travis-ci.com/sypht-team/sypht-ruby-client.svg?branch=master)\n\n# Sypht Ruby Client\nThis repository is a Ruby reference client implementation for working with the Sypht API at https://api.sypht.com.\n\n## About Sypht\n[Sypht](https://sypht.com) is a SaaS [API]((https://docs.sypht.com/)) which extracts key fields from documents. For \nexample, you can upload an image or pdf of a bill or invoice and extract the amount due, due date, invoice number \nand biller information. \n\n## Getting started\nTo get started you'll need API credentials, i.e. a `\u003cclient_id\u003e` and `\u003cclient_secret\u003e`, which can be obtained by registering\nfor an [account](https://www.sypht.com/signup/developer)\n\n## Installation\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'sypht'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install sypht\n        \n## Usage\n```ruby\nrequire 'sypht'\n\n# API_KEY is stored as env variable in the format client_id:client_secret\nclient_id, client_secret = ENV['SYPHT_API_KEY'].split(\":\")\n\n# Create new Sypht Client\n@client = Sypht::Client.new(client_id, client_secret)\n\n# Submit a file for upload, along with a list of fieldsets\nfid = @client.upload(\"samples/sample_invoice.pdf\", ['sypht.invoice'])\n\n# get results of the file based on fid\nresults = @client.fetch_results fid\n```\n\nor run it in the command line:\n\n```\n$ sypht extract --fieldset sypht.document --fieldset sypht.invoice path/to/your/document.pdf\n```\n\n## Development\nYou need to install Ruby (2.5+), which can be installed using [RVM](https://rvm.io/rvm/install)\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo build and test the gem locally, run `rake install`, which will package the gem to \"pkg/sypht-\u003cversion\u003e.gem\", and install it in the current ruby. \nYou can then run `irb` and use the gem as mentioned in the usage section.\n\nTo 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](https://rubygems.org).\n\n## Contributing\nBug reports and pull requests are welcome on GitHub at https://github.com/sypht-team/sypht-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## License\nThe software in this repository is available as open source under the terms of the [Apache License](https://github.com/sypht-team/sypht-ruby-client/blob/master/LICENSE).\n\n## Code of Conduct\nEveryone interacting in the Sypht Ruby Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sypht-team/sypht-ruby-client/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsypht-team%2Fsypht-ruby-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsypht-team%2Fsypht-ruby-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsypht-team%2Fsypht-ruby-client/lists"}