56 lines
1.6 KiB
Markdown
56 lines
1.6 KiB
Markdown
# CSV
|
|
|
|
This library provides a complete interface to CSV files and data. It offers tools to enable you to read and write to and from Strings or IO objects, as needed.
|
|
|
|
## Installation
|
|
|
|
Add this line to your application's Gemfile:
|
|
|
|
```ruby
|
|
gem 'csv'
|
|
```
|
|
|
|
And then execute:
|
|
|
|
$ bundle
|
|
|
|
Or install it yourself as:
|
|
|
|
$ gem install csv
|
|
|
|
## Usage
|
|
|
|
```ruby
|
|
require "csv"
|
|
|
|
CSV.foreach("path/to/file.csv") do |row|
|
|
# use row here...
|
|
end
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- [API](https://ruby.github.io/csv/): all classes, methods, and constants.
|
|
- [Recipes](https://ruby.github.io/csv/doc/csv/recipes/recipes_rdoc.html): specific code for specific tasks.
|
|
|
|
## Development
|
|
|
|
After checking out the repo, run `ruby run-test.rb` to check if your changes can pass the test.
|
|
|
|
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](https://rubygems.org).
|
|
|
|
## Contributing
|
|
|
|
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/csv.
|
|
|
|
### NOTE: About RuboCop
|
|
|
|
We don't use RuboCop because we can manage our coding style by ourselves. We want to accept small fluctuations in our coding style because we use Ruby.
|
|
Please do not submit issues and PRs that aim to introduce RuboCop in this repository.
|
|
|
|
## License
|
|
|
|
The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).
|
|
|
|
See LICENSE.txt for details.
|