Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move repo references #76

Merged
merged 2 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -550,12 +550,12 @@ You can watch all episodes here:

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jonatas/timescaledb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jonatas/timescaledb/blob/master/CODE_OF_CONDUCT.md).
Bug reports and pull requests are welcome on GitHub at https://github.com/timescale/timescaledb-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/timescale/timescaledb-ruby/blob/master/CODE_OF_CONDUCT.md).

## 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 Timescale project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jonatas/timescaledb/blob/master/CODE_OF_CONDUCT.md).
Everyone interacting in the Timescale project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/timescale/timescaledb-ruby/blob/master/CODE_OF_CONDUCT.md).
2 changes: 1 addition & 1 deletion docs/chat_gpt_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -463,4 +463,4 @@ If you want to try it, this example is available on
[examples/chatgpt/openai-cli.rb][open-api-cli] and you can follow the
instructions in the folder how to use it.

[open-api-cli]: https://github.com/jonatas/timescaledb/blob/main/examples/chatgpt/openai-cli.rb
[open-api-cli]: https://github.com/timescale/timescaledb-ruby/blob/main/examples/chatgpt/openai-cli.rb
24 changes: 12 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ gem "timescaledb"

## Features

* The model can use the [acts_as_hypertable](https://github.com/jonatas/timescaledb/tree/master/lib/timescaledb/acts_as_hypertable.rb) macro. Check more on [models](models) documentation.
* The ActiveRecord [migrations](migrations) can use the [create_table](https://github.com/jonatas/timescaledb/tree/master/lib/timescaledb/migration_helpers.rb) supporting the `hypertable` keyword. It's also enabling you to add retention and continuous aggregates policies
* The model can use the [acts_as_hypertable](https://github.com/timescale/timescaledb-ruby/tree/master/lib/timescaledb/acts_as_hypertable.rb) macro. Check more on [models](models) documentation.
* The ActiveRecord [migrations](migrations) can use the [create_table](https://github.com/timescale/timescaledb-ruby/tree/master/lib/timescaledb/migration_helpers.rb) supporting the `hypertable` keyword. It's also enabling you to add retention and continuous aggregates policies
* A standalone `create_hypertable` macro is also allowed in the migrations.
* Testing also becomes easier as the [schema dumper](https://github.com/jonatas/timescaledb/tree/master/lib/timescaledb/schema_dumper.rb) will automatically introduce the hypertables to all environments.
* It also contains a [scenic extension](https://github.com/jonatas/timescaledb/tree/master/lib/timescaledb/scenic/extension.rb) to work with [scenic views](https://github.com/scenic-views/scenic) as it's a wide adoption in the community.
* Testing also becomes easier as the [schema dumper](https://github.com/timescale/timescaledb-ruby/tree/master/lib/timescaledb/schema_dumper.rb) will automatically introduce the hypertables to all environments.
* It also contains a [scenic extension](https://github.com/timescale/timescaledb-ruby/tree/master/lib/timescaledb/scenic/extension.rb) to work with [scenic views](https://github.com/scenic-views/scenic) as it's a wide adoption in the community.
* The gem is also packed with a [command line utility](command_line) that makes it easier to navigate in your database with Pry and all your hypertables available in a Ruby style.

## Examples

The [all_in_one](https://github.com/jonatas/timescaledb/tree/master/examples/all_in_one/all_in_one.rb) example shows:
The [all_in_one](https://github.com/timescale/timescaledb-ruby/tree/master/examples/all_in_one/all_in_one.rb) example shows:

1. Create a hypertable with compression settings
2. Insert data
Expand All @@ -38,17 +38,17 @@ The [all_in_one](https://github.com/jonatas/timescaledb/tree/master/examples/all
6. Check chunk status
7. Decompress a chunk

The [ranking](https://github.com/jonatas/timescaledb/tree/master/examples/ranking) example shows how to configure a Rails app and navigate all the features available.
The [ranking](https://github.com/timescale/timescaledb-ruby/tree/master/examples/ranking) example shows how to configure a Rails app and navigate all the features available.


## Toolkit examples

There are also examples in the [toolkit-demo](https://github.com/jonatas/timescaledb/tree/master/examples/toolkit-demo) folder that can help you to
There are also examples in the [toolkit-demo](https://github.com/timescale/timescaledb-ruby/tree/master/examples/toolkit-demo) folder that can help you to
understand how to properly use the toolkit functions.

* [ohlc](https://github.com/jonatas/timescaledb/tree/master/examples/toolkit-demo/ohlc.rb) is a funtion that groups data by Open, High, Low, Close and make histogram availables to group the data, very useful for financial analysis.
* While building the [LTTB tutorial]( https://jonatas.github.io/timescaledb/toolkit_lttb_tutorial/) I created the [lttb](https://github.com/jonatas/timescaledb/tree/master/examples/toolkit-demo/lttb) is a simple charting using the Largest Triangle Three Buckets and there. A [zoomable](https://github.com/jonatas/timescaledb/tree/master/examples/toolkit-demo/lttb-zoom) version which allows to navigate in the data and zoom it keeping the same data resolution is also available.
* A small example showing how to process [volatility](https://github.com/jonatas/timescaledb/blob/master/examples/toolkit-demo/compare_volatility.rb) is also good to get familiar with the pipeline functions. A benchmark implementing the same in Ruby is also available to check how it compares to the SQL implementation.
* [ohlc](https://github.com/timescale/timescaledb-ruby/tree/master/examples/toolkit-demo/ohlc.rb) is a funtion that groups data by Open, High, Low, Close and make histogram availables to group the data, very useful for financial analysis.
* While building the [LTTB tutorial]( https://jonatas.github.io/timescaledb/toolkit_lttb_tutorial/) I created the [lttb](https://github.com/timescale/timescaledb-ruby/tree/master/examples/toolkit-demo/lttb) is a simple charting using the Largest Triangle Three Buckets and there. A [zoomable](https://github.com/timescale/timescaledb-ruby/tree/master/examples/toolkit-demo/lttb-zoom) version which allows to navigate in the data and zoom it keeping the same data resolution is also available.
* A small example showing how to process [volatility](https://github.com/timescale/timescaledb-ruby/blob/master/examples/toolkit-demo/compare_volatility.rb) is also good to get familiar with the pipeline functions. A benchmark implementing the same in Ruby is also available to check how it compares to the SQL implementation.


## Extra resources
Expand All @@ -61,12 +61,12 @@ live-coding sessions showed how [@jonatasdp](https://twitter.com/jonatasdp) buil

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jonatas/timescaledb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jonatas/timescaledb/blob/master/CODE_OF_CONDUCT.md).
Bug reports and pull requests are welcome on GitHub at https://github.com/timescale/timescaledb-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/timescale/timescaledb-ruby/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Timescale project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/jonatas/timescaledb/blob/master/CODE_OF_CONDUCT.md).
Everyone interacting in the Timescale project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/timescale/timescaledb-ruby/blob/master/CODE_OF_CONDUCT.md).
2 changes: 1 addition & 1 deletion docs/scenic_views.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ FROM plays
GROUP BY game_id, bucket;
```

Check out the source code of the [full example](https://github.com/jonatas/timescaledb/tree/master/examples/ranking).
Check out the source code of the [full example](https://github.com/timescale/timescaledb-ruby/tree/master/examples/ranking).
10 changes: 5 additions & 5 deletions docs/toolkit_lttb_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ Downsampling it in the front end would save bandwidth from your server and memor
You can still run this code from the official repository if you haven't followed the step-by-step tutorial. Check this out:

```bash
git clone https://github.com/jonatas/timescaledb.git
git clone https://github.com/timescale/timescaledb-ruby.git
cd timescaledb
bundle install
cd examples/toolkit-demo
Expand All @@ -536,12 +536,12 @@ If you have any comments, feel free to drop a message to me at the [Timescale Co

[1]: https://github.com/timescale/timescaledb-toolkit/blob/main/docs/lttb.md
[2]: https://github.com/Jubke/lttb
[3]: https://github.com/jonatas/timescaledb/blob/master/examples/toolkit-demo/lttb
[3]: https://github.com/timescale/timescaledb-ruby/blob/master/examples/toolkit-demo/lttb
[4]: https://docs.timescale.com/timescaledb/latest/tutorials/sample-datasets/#weather-datasets
[5]: https://www.timescale.com/community
[6]: https://github.com/jonatas/timescaledb/pulls
[7]: https://github.com/jonatas/timescaledb/issues
[8]: https://github.com/jonatas/timescaledb
[6]: https://github.com/timescale/timescaledb-ruby/pulls
[7]: https://github.com/timescale/timescaledb-ruby/issues
[8]: https://github.com/timescale/timescaledb-ruby
[9]: http://pry.github.io
[10]: https://github.com/Jubke/lttb
[11]: https://chartkick.com
Expand Down
4 changes: 2 additions & 2 deletions docs/toolkit_lttb_zoom.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,10 +342,10 @@ That's all for today folks!


[1]: /toolkit_lttb_tutorial
[2]: https://github.com/jonatas/timescaledb/blob/master/examples/toolkit-demo/lttb_zoom
[2]: https://github.com/timescale/timescaledb-ruby/blob/master/examples/toolkit-demo/lttb_zoom
[3]: https://docs.timescale.com/api/latest/hyperfunctions/downsample/lttb/
[4]: https://docs.timescale.com/timescaledb/latest/how-to-guides/hyperfunctions/function-pipelines/
[5]: https://github.com/jonatas/timescaledb
[5]: https://github.com/timescale/timescaledb-ruby
[6]: http://pry.github.io
[7]: http://sinatrarb.com
[8]: https://docs.timescale.com/timescaledb/latest/tutorials/sample-datasets/#weather-datasets
Expand Down
2 changes: 1 addition & 1 deletion docs/toolkit_ohlc.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,6 @@ If you have any questions or concerns, feel free to reach me ([@jonatasdp][7]) i
[2]: https://ideia.me/timescale-continuous-aggregates-with-ruby
[3]: https://github.com/timescale/timescaledb-toolkit/blob/cbbca7b2e69968e585c845924e7ed7aff1cea20a/extension/src/ohlc.rs#L20-L24
[4]: https://github.com/timescale/timescaledb/pull/4668
[5]: https://github.com/jonatas/timescaledb/tree/master/examples/toolkit-demo
[5]: https://github.com/timescale/timescaledb-ruby/tree/master/examples/toolkit-demo
[6]: https://timescale.com/community
[7]: https://twitter.com/jonatasdp
2 changes: 1 addition & 1 deletion docs/videos.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ You can watch all episodes here:


If you create any content related to how to use the Timescale Gem, please open a
[Pull Request](https://github.com/jonatas/timescaledb/pulls).
[Pull Request](https://github.com/timescale/timescaledb-ruby/pulls).
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site_name: The Timescaledb gem
repo_url: https://github.com/jonatas/timescaledb
repo_url: https://github.com/timescale/timescaledb-ruby
edit_uri: edit/master/docs/
extra:
analytics:
Expand Down
8 changes: 4 additions & 4 deletions timescaledb.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ Gem::Specification.new do |spec|
spec.name = "timescaledb"
spec.version = Timescaledb::VERSION
spec.authors = ["Jônatas Davi Paganini"]
spec.email = ["jonatasdp@gmail.com"]
spec.email = ["jonatas@timescale.com"]

spec.summary = %q{TimescaleDB helpers for Ruby ecosystem.}
spec.description = %q{Functions from timescaledb available in the ActiveRecord models.}
spec.homepage = "https://github.com/jonatas/timescaledb"
spec.homepage = "https://github.com/timescale/timescaledb-ruby"
spec.license = "MIT"
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

spec.metadata["allowed_push_host"] = "https://rubygems.org"

spec.metadata["homepage_uri"] = spec.homepage
#spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
spec.metadata["homepage_uri"] = "https://timescale.github.io/timescaledb-ruby/"
spec.metadata["source_code_uri"] = spec.homepage
#spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."

# Specify which files should be added to the gem when it is released.
Expand Down
Loading