https://github.com/cedadev/jasmin-object-store-portal
A portal for managing object store access keys
https://github.com/cedadev/jasmin-object-store-portal
Last synced: 4 months ago
JSON representation
A portal for managing object store access keys
- Host: GitHub
- URL: https://github.com/cedadev/jasmin-object-store-portal
- Owner: cedadev
- Created: 2023-04-03T09:24:18.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T13:27:04.000Z (about 1 year ago)
- Last Synced: 2025-06-04T03:21:11.733Z (about 1 year ago)
- Language: Python
- Size: 256 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jasmin Object Store Portal
A portal to manage object store access keys.
Built with fast-api.
## Setup
1. Install Poetry
`curl -sSL https://install.python-poetry.org | python3 -`
2. Install dependencies
`poetry install`
3. Install Redis. [Detailed documentation available on the redis website.](https://redis.io/docs/getting-started/installation/)
4. Create the file `conf\common.secrets.yaml`
5. Replace the placeholders in [Config structure](#config-structure)
6. Run
```bash
poetry run uvicorn objectstore_interface.main:app --reload
```
## Config structure
The file `conf\common.secrets.yaml` should look something like this:
```yaml
accounts:
client_id: "client id"
client_secret: "client secret"
scope: " scope"
redirectUri: http://127.0.0.1:8000/oauth2/redirect
projects:
client_id: "client id"
client_secret: "client secret"
scope: " scope"
s3:
auth_secret: 'auth secret'
redis:
connection: 'redis://localhost'
testing: false
```
## Testing
1. `poetry install`
2. `poetry run pytest --cov`
## Add new dependencies
To add new dependencies you need to first add them with poetry as normal, then to ensure that the docker build process will pick them up run `poetry export --without-hashes --format=requirements.txt --output=requirements.txt`.