Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edmond/prez #1

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
29 changes: 29 additions & 0 deletions .env-template
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## ---------------------------------------
## MAIN SITE SETTINGS
## ---------------------------------------
VITE_SIDENAV=true
VITE_ENABLED_PREZS=SpacePrez,VocPrez,CatPrez

## ---------------------------------------
## MAP DISPLAY DEFAULT SETTINGS
## ---------------------------------------
VITE_MAP_SETTINGS_API_KEY=
VITE_MAP_SETTINGS_OPTIONS_CENTER_LAT=-28.8908
VITE_MAP_SETTINGS_OPTIONS_CENTER_LNG=132.3757
VITE_MAP_SETTINGS_OPTIONS_STREETVIEW_CONTROLLER=false
VITE_MAP_SETTINGS_OPTIONS_ZOOM=4

## ---------------------------------------
## CONSTANTS FOR THE MAP SEARCH QUERY
## ---------------------------------------
VITE_MAP_SEARCH_SPATIAL_DATASET_CLASS=http://www.w3.org/ns/dcat#Dataset
VITE_MAP_SEARCH_SPATIAL_MEMBERSHIP_RELATIONSHIP=http://www.w3.org/2000/01/rdf-schema#member
VITE_MAP_SEARCH_PROPS_F_ID=http://purl.org/dc/terms/identifier
VITE_MAP_SEARCH_PROPS_F_LABEL=http://www.w3.org/2000/01/rdf-schema#label
VITE_MAP_SEARCH_PROPS_FC_LABEL=https://schema.org/name
VITE_MAP_SEARCH_PROPS_DS_LABEL=https://schema.org/name

## ---------------------------------------
## LOCAL DEV ENVIRONMENT
## ---------------------------------------
VITE_API_BASE_URL=http://localhost:8000
190 changes: 190 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
vocpub.ttl

# Created by https://www.toptal.com/developers/gitignore/api/python,venv
# Edit at https://www.toptal.com/developers/gitignore?templates=python,venv

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml

# ruff
.ruff_cache/

# LSP config files
pyrightconfig.json

### venv ###
# Virtualenv
# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
[Bb]in
[Ii]nclude
[Ll]ib
[Ll]ib64
[Ll]ocal
[Ss]cripts
pyvenv.cfg
pip-selfcheck.json

# End of https://www.toptal.com/developers/gitignore/api/python,venv
85 changes: 85 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# https://taskfile.dev

version: "3"

env:
FUSEKI_URL: http://localhost:3030
FUSEKI_DATASET_URL: http://localhost:3030/bgs
FUSEKI_USERNAME: admin
FUSEKI_PASSWORD: admin

tasks:
venv:create:
desc: Create Python virtual environment.
cmds:
- python -m venv .venv

venv:install:
desc: Install Python dependencies to virtual environment.
cmds:
- .venv/bin/pip install -r requirements.txt

stack:up:
desc: Start the Prez stack.
cmds:
- docker-compose --profile stack up -d

stack:down:
desc: Stop the Prez stack.
cmds:
- docker-compose --profile stack down

stack:fuseki:up:
desc: Start the Fuseki service in the Prez stack.
cmds:
- docker-compose --profile db up -d

stack:fuseki:down:
desc: Stop the Fuseki service in the Prez stack.
cmds:
- docker-compose --profile db down

stack:prez:up:
desc: Start the Prez service in the Prez stack.
cmds:
- docker-compose --profile web up -d

stack:prez:down:
desc: Stop the Prez service in the Prez stack.
cmds:
- docker-compose --profile web down

stack:prez-ui:up:
desc: Start the Prez UI service in the Prez stack.
cmds:
- docker-compose --profile ui up -d

stack:prez-ui:down:
desc: Stop the Prez UI service in the Prez stack.
cmds:
- docker-compose --profile ui down

fuseki:dataset:list:
desc: List Fuseki datasets at $FUSEKI_URL.
cmds:
- .venv/bin/kurra fuseki dataset list $FUSEKI_URL -u $FUSEKI_USERNAME -p $FUSEKI_PASSWORD

fuseki:dataset:create:
desc: Create Fuseki dataset. Example usage, task fuseki:dataset:create -- bgs
cmds:
- .venv/bin/kurra fuseki dataset create $FUSEKI_URL {{.CLI_ARGS}} -u $FUSEKI_USERNAME -p $FUSEKI_PASSWORD

vocpub:download:
desc: Download VocPub SHACL shapes validator.
cmds:
- curl -fsSL -H "Accept text/turtle" https://w3id.org/profile/vocpub/validator --output vocpub.ttl

vocpub:
desc: Validate a file with the VocPub validator. Example usage, task vocpub -- vocab.ttl
cmds:
- .venv/bin/pyshacl -s vocpub.ttl {{.CLI_ARGS}} --allow-warning

fuseki:upload:
desc: Upload files to BGS Fuseki dataset.
cmds:
- .venv/bin/kurra fuseki upload vocabularies $FUSEKI_DATASET_URL -u $FUSEKI_USERNAME -p $FUSEKI_PASSWORD
6 changes: 6 additions & 0 deletions bgs-prefixes.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
PREFIX vann: <http://purl.org/vocab/vann/>
PREFIX ref: <http://data.bgs.ac.uk/ref/>
PREFIX geo-thes: <http://data.bgs.ac.uk/id/GeoscienceThesaurus/Concept/>

geo-thes: vann:preferredNamespacePrefix "geo-thes" .
ref: vann:preferredNamespacePrefix "ref" .
Loading