https://github.com/theangrybyrd/fsharp.control.redis.streams
Interop library between Redis Streams and popular dotnet streaming libraries
https://github.com/theangrybyrd/fsharp.control.redis.streams
dotnet dotnet-core fsharp redis redis-streams
Last synced: 23 days ago
JSON representation
Interop library between Redis Streams and popular dotnet streaming libraries
- Host: GitHub
- URL: https://github.com/theangrybyrd/fsharp.control.redis.streams
- Owner: TheAngryByrd
- License: mit
- Created: 2019-07-02T21:15:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-27T15:24:05.000Z (almost 4 years ago)
- Last Synced: 2025-03-24T07:26:21.441Z (about 1 month ago)
- Topics: dotnet, dotnet-core, fsharp, redis, redis-streams
- Language: F#
- Homepage:
- Size: 230 KB
- Stars: 13
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# FSharp.Control.Redis.Streams
FSharp.Control.Redis.Streams is a library dedicated to bridging [Redis Streams](https://redis.io/topics/streams-intro) with .NET Streaming technologies.
Currently Supported:
- [Hopac Streams](https://hopac.github.io/Hopac/Hopac.html#def:module%20Hopac.Stream)
- [Akka.net Streams](https://getakka.net/articles/streams/introduction.html)
- [Reactive Extensions](http://reactivex.io/)
---
## Builds
MacOS/Linux | Windows
--- | ---
[](https://travis-ci.org/TheAngryByrd/FSharp.Control.Redis.Streams) | No Redis 5.0 Support On Windows
[](https://travis-ci.org/TheAngryByrd/FSharp.Control.Redis.Streams/builds) | No Redis 5.0 Support On Windows
## Nuget
Package Name |Stable | Prerelease
--- | --- | ---
FSharp.Control.Redis.Streams |[](https://www.nuget.org/packages/FSharp.Control.Redis.Streams/) | [](https://www.nuget.org/packages/FSharp.Control.Redis.Streams/)
FSharp.Control.Redis.Streams.Akka | [](https://www.nuget.org/packages/FSharp.Control.Redis.Streams.Akka/) | [](https://www.nuget.org/packages/FSharp.Control.Redis.Streams.Akka/)
FSharp.Control.Redis.Streams.Hopac | [](https://www.nuget.org/packages/FSharp.Control.Redis.Streams.Hopac/) | [](https://www.nuget.org/packages/FSharp.Control.Redis.Streams.Hopac/)
FSharp.Control.Redis.Streams.Reactive | [](https://www.nuget.org/packages/FSharp.Control.Redis.Streams.Reactive/) | [](https://www.nuget.org/packages/FSharp.Control.Redis.Streams.Reactive/)
### Developing
- [VSCode Dev Container](https://code.visualstudio.com/docs/remote/containers)
---
### Building
Make sure the following **requirements** are installed in your system:
* [dotnet SDK](https://www.microsoft.com/net/download/core) 2.0 or higher
* [Mono](http://www.mono-project.com/) if you're on Linux or macOS.
* [docker-compose](https://docs.docker.com/compose/)
Stand up redis via docker:
```sh
docker-compose up
```
Build:
```
> build.cmd // on windows
$ ./build.sh // on unix
```
#### Environment Variables
* `CONFIGURATION` will set the [configuration](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-build?tabs=netcore2x#options) of the dotnet commands. If not set it will default to Release.
* `CONFIGURATION=Debug ./build.sh` will result in things like `dotnet build -c Debug`
* `GITHUB_TOKEN` will be used to upload release notes and nuget packages to github.
* Be sure to set this before releasing
- `DISABLE_COVERAGE` Will disable running code coverage metrics. AltCover can have [severe performance degradation](https://github.com/SteveGilham/altcover/issues/57) so it worth disabling when looking to do a quicker feedback loop.
- `DISABLE_COVERAGE=1 ./build.sh`
### Watch Tests
The `WatchTests` target will use [dotnet-watch](https://github.com/aspnet/Docs/blob/master/aspnetcore/tutorials/dotnet-watch.md) to watch for changes in your lib or tests and re-run your tests on all `TargetFrameworks`
```
./build.sh WatchTests
```
### Releasing
* [Start a git repo with a remote](https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/)
```
git add .
git commit -m "Scaffold"
git remote add origin origin https://github.com/user/MyCoolNewLib.git
git push -u origin master
```
* [Add your nuget API key to paket](https://fsprojects.github.io/Paket/paket-config.html#Adding-a-NuGet-API-key)
```
paket config add-token "https://www.nuget.org" 4003d786-cc37-4004-bfdf-c4f3e8ef9b3a
```
* [Create a GitHub OAuth Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
* You can then set the `GITHUB_TOKEN` to upload release notes and artifacts to github
* Otherwise it will fallback to username/password
* Then update the `RELEASE_NOTES.md` with a new version, date, and release notes [ReleaseNotesHelper](https://fsharp.github.io/FAKE/apidocs/fake-releasenoteshelper.html)
```
#### 0.2.0 - 2017-04-20
* FEATURE: Does cool stuff!
* BUGFIX: Fixes that silly oversight
```
* You can then use the `Release` target. This will:
* make a commit bumping the version: `Bump version to 0.2.0` and add the release notes to the commit
* publish the package to nuget
* push a git tag
```
./build.sh Release
```
### Code formatting
To format code run the following target
```
./build.sh FormatCode
```
This uses [Fantomas](https://github.com/fsprojects/fantomas) to do code formatting. Please report code formatting bugs to that repository.