Metadata-Version: 2.4
Name: marinerg_facility
Version: 2.1.0
Summary: Common elements of the Marinerg Access Portal infrastructure.
Author-email: Irish Centre for High End Computing <james.grogan@ichec.ie>
License: MIT
Project-URL: Repository, https://git.ichec.ie/marinerg-i/facility-service
Project-URL: Homepage, https://git.ichec.ie/marinerg-i/facility-service
Keywords: Web Application,Django
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ichec_django_core==2.1.0
Provides-Extra: container
Requires-Dist: psycopg2-binary; extra == "container"
Requires-Dist: gunicorn; extra == "container"
Provides-Extra: async
Requires-Dist: celery>=5.3; extra == "async"
Requires-Dist: redis>=5.0; extra == "async"
Provides-Extra: types
Requires-Dist: types-requests; extra == "types"
Dynamic: license-file

# Marinerg-i Facility Service #

This software is part of the [Marinerg-i preparatory phase project](https://www.marinerg-i.eu).

This service supports managing test facility records.

# Quick Start #

This is a Python `Django` application and can be managed through the standard Django APIs.

If you want a quick demo of it running locally you can inspect this script on Linux or Mac and run it if happy with it:

``` sh
./infra/quick_start.sh
```

which will:

* Set up a Python virtual environment and install dependencies
* Populate the shell environment with demo Django settings, such as Admin credentials
* Set up a local database and create an admin user
* Launch the development server

You can then go to [localhost:8000/api](http://localhost:8000/api) in a browser to interact with the backend API.

For more detailed deployment information more suitable for production you can see the [Developer Guide](/docs/DeveloperGuide.md).


# Licensing #

Copyright of the Irish Centre for High End Computing (ICHEC), released under the
MIT License. See the included [`LICENSE`](./LICENSE) file for the full terms.
