README.md

EOEPCA Workspace API (v2)

This repository includes the EOEPCA Workspace API component
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Testing
• Documentation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• FastAPI
• Kubernetes Python API

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To develop this service both docker and docker-compose is required.

Installation

docker-compose up

Testing

• make test runs the unit tests
• make lint runs the code lints

Run Locally (against eoepca-demo cluster)

HARBOR_URL="" HARBOR_ADMIN_USERNAME="" HARBOR_ADMIN_PASSWORD="" S3_REGION="eu-central-1" S3_ENDPOINT=" https://minio.develop.eoepca.org" PREFIX_FOR_NAME="ws" WORKSPACE_SECRET_NAME="bucket" KUBECONFIG=~/.kube/config-eoepca-demo uvicorn --reload --host=0.0.0.0 --port 5000 --log-level=info --reload workspace_api:app

Documentation

Documentation for the Workspace API:

• Wiki Pages

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

Acknowledgements

• README.md is based on this template by Othneil Drew.