https://github.com/ptariche/airflow-ts
A Node module for Airflow in Typescript. This uses the experimental API .
https://github.com/ptariche/airflow-ts
airflow api api-client javascript python typescript
Last synced: 12 months ago
JSON representation
A Node module for Airflow in Typescript. This uses the experimental API .
- Host: GitHub
- URL: https://github.com/ptariche/airflow-ts
- Owner: ptariche
- License: apache-2.0
- Created: 2019-06-06T23:18:36.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T22:57:53.000Z (over 3 years ago)
- Last Synced: 2025-06-23T22:53:28.363Z (about 1 year ago)
- Topics: airflow, api, api-client, javascript, python, typescript
- Language: TypeScript
- Homepage:
- Size: 1.31 MB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Airflow-API
A Node module for Airflow in Typescript. This uses the experimental Airflow API.
[](https://badge.fury.io/js/airflow-api)
[](https://travis-ci.org/ptariche/airflow-ts)
## Documentation
* [MARKDOWN](./docs-markdown/api-readme.md)
----
### Prerequisites
- Node 10+
### Installation
Install the dependencies and devDependencies and start the server.
```sh
$ npm install --save airflow-api
```
### Usage
```js
import {client} from 'airflow-api'; or const CLIENT = require('airflow-api').client;
let _client = new CLIENT||client({
airflowUrl: 'http://127.0.0.1:8080'
});
_client.checkTest().then(result => console.log(result)).catch(err => console.error(err));
```
### Enums Usage
```js
import * as AirflowEnum from 'airflow-api/dist/types' or const AIRFLOW_ENUMS = require('airflow-api/dist/types');
```
### Development
Want to contribute? Great! Make a Pr!
Open your favorite Terminal and run these commands.
#### Building for source
To release in javascript. The output is dumped in the dist folder:
```sh
$ npm run build
```
#### Testing
* Uses Jest, Supertest, Chai - Integration Tests needed
```sh
npm test
```
Changelog
----
[Link](./CHANGELOG.md)
License
----
[Apache-2.0](./LICENSE)
Author
----
[Peter A. Tariche](https://github.com/ptariche)