Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Uses [Skyfield](https://github.com/skyfielders/python-skyfield) to predict passe

[GitHub](https://github.com/redraw/satellite-passes-api) | [Docs](https://satellites.fly.dev/docs) | [openapi.json](https://github.com/redraw/satellite-passes-api/blob/master/app/static/openapi.json)


## API
### `GET /passes/<norad-id>`

Expand Down Expand Up @@ -65,3 +66,23 @@ Response example,
- `visible` field tells if the satellite will be _probably_ visible, considering the sun is near the horizon, and the observer is at night. You can read more [here](https://www.heavens-above.com/faq.aspx).

Note: Results are cached 1 day for each parameters combo, except `limit`.

## Installation

```commandline
git clone https://github.com/redraw/satellite-passes-api
cd satellite-passes-api
pip install -r requirements.txt
sudo apt install redis
```

## Usage

In separate terminals:

`redis-server`

```
cd app
python main.py
```