Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wasnotrice/weakly
https://github.com/wasnotrice/weakly
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/wasnotrice/weakly
- Owner: wasnotrice
- License: mit
- Created: 2016-06-03T04:11:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-06-03T04:11:31.000Z (over 8 years ago)
- Last Synced: 2024-09-19T08:39:09.031Z (about 2 months ago)
- Language: Ruby
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- 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
README
# Weakly
Collates time tracker entries by week limited to a given month. This allows for
sensible monthly invoicing, with weekly activity summaries.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'weakly'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install weakly
## Usage
```ruby
source = Weakly::Source::Harvest(apikey: 'MY_API_KEY')
destination = Weakly::Destination::GoogleSheets(apikey: 'MY_OTHER_API_KEY')
Weakly::Agent(source: source, destination: destination).run
```
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/weakly. 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](http://opensource.org/licenses/MIT).