Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reactiveui/pharmacist

Builds observables from events.
https://github.com/reactiveui/pharmacist

dotnet dotnetcore msbuild observable reactive-extensions reactive-programming reactivex rx

Last synced: about 1 month ago
JSON representation

Builds observables from events.

Awesome Lists containing this project

README 

        
![Build](https://github.com/reactiveui/Pharmacist/workflows/Build/badge.svg) [![Code Coverage](https://codecov.io/gh/reactiveui/pharmacist/branch/master/graph/badge.svg)](https://codecov.io/gh/reactiveui/pharmacist)









        




# Pharmacist



Builds observables from events.



## Source Generator



A source generator version is being worked on over here: https://github.com/reactivemarbles/ObservableEventsSourceGenerator



## NuGet Packages



Install the following packages to start using Pharmacist.



| Name                          | Platform          | NuGet                            |

| ----------------------------- | ----------------- | -------------------------------- |

| [Pharmacist.Core][Core]       | Core - Libary     | [![CoreBadge]][Core]             |

| [Pharmacist][GlobalTool]      | Global Tool       | [![GlobalToolBadge]][GlobalTool] |

| [Pharmacist.MSBuild][MsBuild] | MSBuild Task      | [![MsBuildBadge]][MsBuild]       |

| [Pharmacist.Common][Common]   | Common            | [![CommonBadge]][Common]         |



[Core]: https://www.nuget.org/packages/Pharmacist.Core/

[CoreBadge]: https://img.shields.io/nuget/v/Pharmacist.Core.svg



[GlobalTool]: https://www.nuget.org/packages/Pharmacist/

[GlobalToolBadge]: https://img.shields.io/nuget/v/Pharmacist.svg



[MsBuild]: https://www.nuget.org/packages/Pharmacist.MSBuild/

[MsBuildBadge]: https://img.shields.io/nuget/v/Pharmacist.MSBuild.svg



[Common]: https://www.nuget.org/packages/Pharmacist.Common/

[CommonBadge]: https://img.shields.io/nuget/v/Pharmacist.Common.svg



## What does it do?



Pharmacist will convert events within an assembly and create observable wrappers for them. 



It has been called pharmacist since it will generate Reactive Extensions (Rx) Observables for events, so it's a play on word about "Rx" which is short for prescriptions.



It can generate the observables for the following:

* System Platforms, such as Xamarin (iOS/Android/TVOS), UWP

* NuGet packages

* Assemblies.



There is a MSBuild Task version and a global tool version.



## How do I use?



### MsBuild



Pharmacist can automatically create Observable wrappers for projects for their explicitly included NuGet packages.



In your .csproj file you can add:



```xml



    

    



```



`Pharmacist.MsBuild` contains the MsBuild target file and appropriate tasks. `Pharmacist.Common` includes common source code that is required to invoke the generated observables.



This will generate wrappers only for other included `PackageReference`'s contained within the project file.



For example if you had a inclusion for `Xamarin.Forms` in the same project that includes Pharmacist it will generate Observable wrappers for the included codes. It will not include any child `PackageReference` from other projects included via a `ProjectReference`. You can override that functionality by including `true` in a `PropertyGroup` inside your project.



Also it will only generate the specified `ProjectReference` and none of it's dependent packages. For example for a ProjectReference inclusion of `ReactiveUI`, it will not generate dependencies such as `System.Reactive`. If you want to generate observable wrappers for the dependent NuGet packages you must explicitly include them. 



### Command Line



Pharmacist comes with a command line version which is useful for generating for a specified platform.



The following values are supported for platforms: `Android`, `iOS`, `Mac`, `WPF`, `UWP`, `Winforms`, `TVOS`



Install the global tool:



```Batchfile

dotnet tool install -g Pharmacist

```



To generate files:



```Batchfile

pharmacist generate-platform -p  -o c:/directory/for/output --output-prefix="Events"

```



This would generate a file named `Events_.cs`, where Platform would be the platform specified.



In the near future this will be changing to TargetFramework with /wpf and /winforms options.



## Contribute



Pharmacist is developed under an OSI-approved open source license, making it freely usable and distributable, even for commercial use. Because of our Open Collective model for funding and transparency, we are able to funnel support and funds through to our contributors and community. We ❤ the people who are involved in this project, and we’d love to have you on board, especially if you are just getting started or have never contributed to open-source before.



So here's to you, lovely person who wants to join us — this is how you can support us:



* [Responding to questions on StackOverflow](https://stackoverflow.com/questions/tagged/reactiveui)

* [Passing on knowledge and teaching the next generation of developers](http://ericsink.com/entries/dont_use_rxui.html)

* [Asking your employer to reciprocate and contribute to open-source](https://github.com/github/balanced-employee-ip-agreement)

* Submitting documentation updates where you see fit or lacking.

* Making contributions to the code base.