Skip to content

PilotDataPlatform/pilot-hdc-bff-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8cbb3c8 · Jan 10, 2025

History

5 Commits
Oct 8, 2024
Dec 4, 2024
Dec 4, 2024
Dec 4, 2024
Sep 21, 2023
Dec 4, 2024
Sep 21, 2023
Oct 8, 2024
Oct 8, 2024
Oct 8, 2024
Oct 8, 2024
Jan 10, 2025
Sep 21, 2023
Oct 8, 2024
Sep 21, 2023
Oct 8, 2024
Oct 8, 2024
Oct 8, 2024

Repository files navigation

BFF-CLI

Python

Getting Started

The backend for the command line interface.

Built With

  • Python
  • FastAPI

Getting Started

Prerequisites

This project is using Poetry to handle the dependencies.

curl -sSL https://install.python-poetry.org | python3 -

Installation & Quick Start

  1. Clone the project.

    git clone https://github.com/PilotDataPlatform/sandbox.git
    
  2. Install dependencies.

    poetry install
    
  3. Install any OS level dependencies.

    apt install <foo>
    brew install <bar>
    
  4. Add environment variables into .env in case it's needed. Use .env.schema as a reference.

  5. Run any initial scripts, migrations or database seeders.

    poetry run alembic upgrade head
    
  6. Run application.

    poetry run python run.py
    

Startup using Docker

This project can also be started using Docker.

  1. To build and start the service within the Docker container run.

    docker compose up
    
  2. Migrations should run automatically on previous step. They can also be manually triggered:

    docker compose run --rm alembic upgrade head
    

Contribution

You can contribute the project in following ways:

  • Report a bug
  • Suggest a feature
  • Open a pull request for fixing issues or adding functionality. Please consider using pre-commit in this case.
  • For general guidelines how to contribute to the project, please take a look at the contribution guides.

Acknowledgements

The development of the HealthDataCloud open source software was supported by the EBRAINS research infrastructure, funded from the European Union's Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3) and H2020 Research and Innovation Action Grant Interactive Computing E-Infrastructure for the Human Brain Project ICEI 800858.

This project has received funding from the European Union’s Horizon Europe research and innovation programme under grant agreement No 101058516. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or other granting authorities. Neither the European Union nor other granting authorities can be held responsible for them.

EU HDC Acknowledgement

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages