markus-cinema-client
v0.1.1
Published
JavaScript client for MARKUS Cinema System XML data.
Downloads
3
Readme
Markus Cinema Client
JavaScript client for fetching data from cinemas that use MARKUS Cinema System.
Background
Multiple cinemas in Finland, Estonia, Latvia and Lithuania use MARKUS Cinema System that exposes XML with upcoming shows and more.
For example:
- https://www.forumcinemas.ee/XML
- https://www.apollokino.ee/XML
- https://cinamon.ee/xml
- http://www.finnkino.fi/xml
- https://cinamonkino.lv/xml
This is a promise-based JavaScript client that takes care of fetching the XML, parsing it and extracting the relevant data.
Usage
Install
yarn add markus-cinema-client
ornpm install --save markus-cinema-client
Use
import { getShows } from 'markus-cinema-client';
const options = { area: 1008, dt: '14.02.2017' };
getShows('http://www.forumcinemas.ee/xml', options).then((shows) => {
...
});
Features
Currently, only getShows
for Schedule
is implemented. However, most of the API-s also expose Areas
, ScheduleDates
, Events
, News
, etc.
For features and bugs, feel free to add issues or contribute.
Contributing
- Run tests in watch mode with
yarn test:watch
ornpm run test:watch
and ensure every line is tested. For a run-once check with ESLint, runyarn test
ornpm test
. - Bump version number according to semver and add an item that a release will be based on to
CHANGELOG.md
. - Submit your pull request from a feature branch and get code reviewed.
- If the pull request is approved, coverage stays high and CircleCI build passes, you will be able to merge.
- Code will automatically be released to GitHub and published to npm.