https://github.com/jei-doubleton/city-ordinance-cli
CLI that scrapes MuniCode to provide text of local ordinances
https://github.com/jei-doubleton/city-ordinance-cli
Last synced: 5 months ago
JSON representation
CLI that scrapes MuniCode to provide text of local ordinances
- Host: GitHub
- URL: https://github.com/jei-doubleton/city-ordinance-cli
- Owner: jei-doubleton
- License: mit
- Created: 2019-02-21T02:34:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-27T03:08:39.000Z (about 6 years ago)
- Last Synced: 2024-08-13T07:15:43.090Z (8 months ago)
- Language: Ruby
- Size: 10.7 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - jei-doubleton/city-ordinance-cli - CLI that scrapes MuniCode to provide text of local ordinances (Ruby)
README
# City::Ordinance::Cli
This CLI application scrapes content from library.municode.com, allowing users to view the text of a chapter of a city ordinance.
1) Users select their state;
2) The app presents the user with available cities within that state;
3) Users select a city;
4) Users select to either view:
- an entire chapter of the ordinance, or
- an article of the ordinance.## Installation
Add this line to your application's Gemfile:
```ruby
gem 'city-ordinance-cli'
```And then execute:
$ bundle
Or install it yourself as:
$ gem install city-ordinance-cli
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/'jsingleton'/city-ordinance-cli. 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.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the City::Ordinance::Cli project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'jsingleton'/city-ordinance-cli/blob/master/CODE_OF_CONDUCT.md).