Skip to content

AstroImages/astroimages-api

Repository files navigation

Logo

AstroImages API (astroimages-api)

REST API for listing processed images

Version License: MIT Quality Gate Status Language grade: Python Scrutinizer Code Quality Build Status

Build Status

Python application Daily Build Nightly Build

Usage

Clone the repo:

$ git clone https://github.com/AstroImages/astroimages-api/
$ cd astroimages-api

Create and activate virtualenv:

$ virtualenv -p python3 env
$ source env.sh
(env) $ pip3 install -r requirements.txt

Run the server via CLI

(env) $ ./start-server.sh

Or build the docker image

(env) $ docker build -t astroimages-api:latest .

Then run the docker image silently

(env) $ docker run -d -p 5000:5000 astroimages-api

Or verbose

(env) $ docker run --rm -ti -p 5000:5000 astroimages-api

And finally try the endpoints:

(env) $ ./tests/start-tests-fits.sh

Testing

To run unit tests:

(env) $ python -m unittest discover test/unit -v

Author

Rodrigo de Souza

Tools

  • Banner made with BannerSnack

Show your support

Give a ⭐️ if this project helped you!

License

Astroimages-api is released under the MIT License.