Skip to content

Commit

Permalink
update readme, roadmap and add a license hint
Browse files Browse the repository at this point in the history
  • Loading branch information
@leo-schick
leo-schick committed Jan 6, 2017
1 parent 0c4e954 commit 8aa2e1e
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 69 deletions.
22 changes: 12 additions & 10 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
Copyright (c) 2013, Alexander Soffronow Pagonidis
Copyright (c) 2016, Leonhard Schick
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the <organization> nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the <organization> nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS (SEE ABOVE) BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Expand Down
77 changes: 29 additions & 48 deletions readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# QUSMA Data Management System (QDMS) fork
QUSMA Data Management System (QDMS)
===================================

[![Join the chat at https://gitter.im/qdms/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/qdms/Lobby)
[![Build status](https://ci.appveyor.com/api/projects/status/ma7h13iqscrl5h05/branch/master?svg=true)](https://ci.appveyor.com/project/LeonhardSchick/qdms/branch/master)

The QUSMA Data Management System (QDMS) is a client/server system for acquiring, managing, and distributing low-frequency historical and real-time data, written in C#.

Expand All @@ -13,8 +17,8 @@ A client library is provided which can access the server either locally or over
QDMS uses MySQL or SQL Server for storage, ZeroMQ and Protocol Buffers for client/server communications and MahApps.Metro for the interface.


## Features

Features
--------
* Manage metadata on stocks, options, futures, CFDs, etc.
* Download historical and real time data from external data sources.
* Local storage of historical data.
Expand All @@ -23,33 +27,17 @@ QDMS uses MySQL or SQL Server for storage, ZeroMQ and Protocol Buffers for clien
* CSV import/export.


## Screenshots

* [Instrument metadata](http://i.imgur.com/GXw8amN.png).
* [The main server interface](http://i.imgur.com/i985ZUW.png).
* [Adding a new instrument from IB](http://i.imgur.com/HGPsoK5.png).
* [Importing CSV data](http://i.imgur.com/en6kDo1.png).
* [Editing futures expiration rules](http://i.imgur.com/WvKkb4x.png).
* [Continuous futures options](http://i.imgur.com/47VuXmH.png).


## Build Status

| Windows | Linux (planned for 2.0) |
|---------|-------------------------|
| [![Build status](https://ci.appveyor.com/api/projects/status/ma7h13iqscrl5h05/branch/master?svg=true)](https://ci.appveyor.com/project/LeonhardSchick/qdms/branch/master) | [![Build Status](https://travis-ci.org/leo90skk/qdms.svg?branch=dotNetCore)](https://travis-ci.org/leo90skk/qdms) |


## Supported Data Sources
Supported Data Sources
----------------------

| Data Source | Historical Data supported | Real Time Data supported | Verified and Tested |
|-------------------------------------- | ------------------------- | ------------------------ | ------------------- |
| Yahoo | :white_check_mark: | | :grey_question: |
| Interactive Brokers | :white_check_mark: | | :grey_question: |
| Bloomberg | :white_check_mark: | :white_check_mark: | :grey_question: |
| Quandl | :white_check_mark: | | :grey_question: |
| FRED (Federal Reserve Economic Data) | :white_check_mark: | | :grey_question: |
| Yahoo | :white_check_mark: | | :grey_question: |
| BarChart | :white_check_mark: | | :grey_question: |
| Bloomberg | :white_check_mark: | :white_check_mark: | :grey_question: |
| [OpenECry](http://futuresonline.com/) | :white_check_mark: | :white_check_mark: | :grey_question: |
| [ForexFeed](http://forexfeed.net/) | (not implemented yet) | :white_check_mark: | :white_check_mark: |

Expand All @@ -62,34 +50,27 @@ Requirements:
* .NET 4.5 *(.NET Core support planned)*


## Roadmap

Take a look at [Roadmap](roadmap.md), the github [issues](https://github.com/leo90skk/qdms/labels/enhancement) and the [milestones](https://github.com/leo90skk/qdms/milestones).


## Contributing

If you wish to contribute, you can easily fork the repo and send a pull request with your changes. Try to send pull requests that are dealing just with one topic.
In case you recommend a bigger changes (like general architecture changes), please create an issue for that and we can discuss the best way of doing it.

For bug reports, feature requests, and general discussion please use the github issue list for this fork.


## Why this fork
Screenshots
-----------
* [Instrument metadata](http://i.imgur.com/GXw8amN.png).
* [The main server interface](http://i.imgur.com/i985ZUW.png).
* [Adding a new instrument from IB](http://i.imgur.com/HGPsoK5.png).
* [Importing CSV data](http://i.imgur.com/en6kDo1.png).
* [Editing futures expiration rules](http://i.imgur.com/WvKkb4x.png).
* [Continuous futures options](http://i.imgur.com/47VuXmH.png).

This is a fork of the QDMS from QUSMA. In general, my plan was not to make my own fork. I would gladly see my changes in the origin fork. But the fact that QUSMA seems to be dead forced me to make my own fork.
I wanna help to build a community around the QDMS project.

My major changes to the origin fork are:
* refactoring, splitting logic to separate assemblies (to make it more flexible to the individual need)
* adding new data sources.
* minor improvements.
* see also github [issues list](https://github.com/leo90skk/qdms/issues)
Contributing
------------

If you wish to contribute, you can easily fork the repo and send a pull request with your changes. Try to send pull requests that are dealing just with one topic - that makes reviewing easier.
Or just create [create an issue](https://github.com/leo90skk/qdms/issues/new) and we can discuss your great ideas!

## Feedback
Roadmap
-------
Take a look at [Roadmap](roadmap.md), the github [issues](https://github.com/leo90skk/qdms/labels/enhancement) and the [milestones](https://github.com/leo90skk/qdms/milestones).

Please send all your feedback / bug report etc. via the [GitHub Issues](https://github.com/leo90skk/qdms/issues) list.

## License
This project is still licensed on the [origin license](LICENSE) from the QDMS project from QUSMA.
License
-------
This product is licensed under the [3-Clause BSD License](LICENSE).
15 changes: 4 additions & 11 deletions roadmap.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
# QDMS fork Roadmap

The purpose of this QDMS fork is to build a modular, open source, cross-platform financial data providing service.
The purpose of this QDMS fork is to build a modular, open source, cross-platform but also fast financial data providing service.

Major components:

* real time data service
* historical data service
* real time data service
* storage of historical data

For the detailed plan take a look at the [milestones](https://github.com/leo90skk/qdms/milestones). There is still much to do, so the milestone plan could be not completed.

## Fix Plans & ship dates

Out of the fact that there is still no strong community behind that project, we can not set up ship dates or fix planes for new feature, bug fixing etc.
New ideas are allways welcome!

Please reckon with the fact that you have to build features and fix bugs by you own.
Nevertheless I will encourage you to share your code on github and contribute to the project to make QDMS a better free open source "product", not just for your own benefits.
**Remember:** When you build a new feature and we implement it into the fork, the community can help you finding and solving bugs and even improve your feature.
For the detailed plan take a look at the [milestones](https://github.com/leo90skk/qdms/milestones) or join our gitter chat

0 comments on commit 8aa2e1e

Please sign in to comment.