{"id":18820869,"url":"https://github.com/hashrocket/slurper","last_synced_at":"2025-04-05T07:07:52.252Z","repository":{"id":763936,"uuid":"438548","full_name":"hashrocket/slurper","owner":"hashrocket","description":"Gem for slurping plain text stories into Pivotal Tracker","archived":false,"fork":false,"pushed_at":"2023-03-17T00:31:38.000Z","size":650,"stargazers_count":124,"open_issues_count":3,"forks_count":32,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-29T06:09:07.759Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://github.com/hashrocket/slurper","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hashrocket.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2009-12-15T22:54:51.000Z","updated_at":"2024-10-09T02:52:58.000Z","dependencies_parsed_at":"2023-07-09T14:16:39.895Z","dependency_job_id":null,"html_url":"https://github.com/hashrocket/slurper","commit_stats":{"total_commits":130,"total_committers":18,"mean_commits":7.222222222222222,"dds":0.6384615384615384,"last_synced_commit":"4e31454411387ca638c4667b13614969a3bdc18e"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hashrocket%2Fslurper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hashrocket%2Fslurper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hashrocket%2Fslurper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hashrocket%2Fslurper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hashrocket","download_url":"https://codeload.github.com/hashrocket/slurper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299833,"owners_count":20916190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-08T00:31:12.322Z","updated_at":"2025-04-05T07:07:52.232Z","avatar_url":"https://github.com/hashrocket.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# slurper\n\nSlurper allows you to quickly compose your stories in a text file and import\nthem into Pivotal Tracker.\n\nWorks great with [slurper.vim](http://github.com/adamlowe/vim-slurper)!\n\n## Install\n\n```\n$ gem install slurper\n```\n\n## Config\n\nSlurper requires a `slurper_config.yml `file in your working directory. This file\ncontains your Tracker API and story requestor information.\n\n### Example\n\n```yml\n# slurper_config.yml\n\nproject_id: 1234\ntoken: 123abc123abc123abc\nrequested_by: Jane Stakeholder\n```\n\nThe `project_id` tells tracker which project to add your stories to. It can be\nfound on the project settings or the URL for the project.\n\nThe `token` can be found on your personal profile page in Pivotal Tracker.\n\nThe `requested_by` field should be the name of your project stakeholder exactly\nas it appears in tracker.\n\n## Usage\n\nCreate a `stories.slurper` file and compose your stories in the Slurper story\nformat. In your working directory use the slurp command to import your stories\nfrom the `stories.slurper` file into Pivotal Tracker. Slurper looks for a\n`stories.slurper` file in your current directory by default; however, you can\nprovide an alternate story source file if necessary.\n\nDefault\n\n```\n$ slurp ~/stories.slurper\n```\n\nAlso valid\n\n```\n$ slurp ~/special_stories.slurper\n```\n\nOr even\n\n```\n$ slurp ~/mystories.txt\n```\n\n### Example Stories\n\n```\n/* stories.slurper */\n\n==\nstory_type:\n  chore\nname:\n  Set Up Staging Environment\ndescription:\n  Set up and configure staging environment for approval of stories\n\nlabels:\n  staging\n==\nstory_type:\n  feature\nname:\n  Campaign Manager Does Something\ndescription:\n  In order to get some value\n  As a campaign manager\n  I want to do something\n\n  - can do something\n\nlabels:\n  campaign managers\n==\nstory_type:\n  release\nname:\n  Big Release\ndescription:\n  This release marks a lot of awesome functionality\n\nlabels:\n  campaign managers\n==\nstory_type:\n  bug\nname:\n  I did something and nothing happened\ndescription:\n  When I do something, another thing is supposed to happen but I see an error screen instead.\n\nlabels:\n  campaign managers\n```\n\nNote: the story source file is whitespace-sensitive. Be sure the value for each\nkey phrase is indented with two spaces beneath each key phrase. Also, start\neach story with a double-equals on its own line.\n\nYour best bet is to leverage\n[slurper.vim](http://github.com/adamlowe/vim-slurper) and benefit from its\nauto-indenting goodness.\n\n### Example Stories (Advanced)\n\nThere are some advanced techniques for formatting your stories beyond the\nsimple type, name, description and label fields. See below for some examples.\n\n```\n/* advanced.slurper */\n\n==\nstory_type:\n  feature\nname:\n  Make the cart accept coupons on checkout\ndescription:\n  When I get to the checkout phase, I want the ability to add an optional coupon code. Use TESTCOUPON to test with.\nlabels:\n  cart,coupon system,checkout\nestimate:\n  3\nrequested_by:\n  Joe Developer\n```\n\nNote: Any field that is supported by the Pivotal Tracker API should work within\nreason (i.e. file uploads won't work). To get an idea of the fields available\nsee Pivotal Tracker's [Example CSV\ndata](https://www.pivotaltracker.com/help/articles/csv_import_export/#example-csv-data)\ndocumentation.\n\n## Development\n\n1. [Fork](https://help.github.com/articles/fork-a-repo/) it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\nPlease add tests at the same time as new features, and verify they all pass with:\n\n```\n$ rake\n```\n\nCredit - Wes Gibbs (https://github.com/wesgibbs) thought of and wrote Slurper as a\nRuby script. It was later packaged and released as a gem by his fellow\nRocketeers after using it and finding it extremely handy.\n\n---\n\n### About\n\n[![Hashrocket logo](https://hashrocket.com/hashrocket_logo.svg)](https://hashrocket.com)\n\nSlurper is supported by the team at [Hashrocket, a\nmultidisciplinary design and development consultancy](https://hashrocket.com). If you'd like to [work with\nus](https://hashrocket.com/contact-us/hire-us) or [join our\nteam](https://hashrocket.com/contact-us/jobs), don't hesitate to get in touch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhashrocket%2Fslurper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhashrocket%2Fslurper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhashrocket%2Fslurper/lists"}