hydrus
REST server - Flask Hydra-powered for Semantic Web
File Explorer
Download Latest Version (.zip)- package-publish.yml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- db_schema.png
- hydra_dataflow.png
- rdf_dataflow.png
- use_case1.png
- er_diagram.pdf
- hydrus_database.md
- specs.txt
- STARTING.md
- TASKS.md
- TUTORIALS.md
- doc.py
- doc_gen.py
- demo.py
- doc.py
- __init__.py
- spacecraft_parsed_classes.py
- spacecraft_vocab_jsonld.py
- subsystem_parsed_classes.py
- subsystem_vocab_jsonld.py
- doc.jsonld
- petstore_openapi.yaml
- __init__.py
- item_collection_helpers.py
- itemhelpers.py
- items_helpers.py
- env.py
- README.md
- script.py.mako
- __init__.py
- alembic.ini
- crud.py
- crud_helpers.py
- db_models.py
- doc_parse.py
- exceptions.py
- resource_based_classes.py
- user.py
- __init__.py
- socketio_factory.py
- stale_records_cleanup.py
- sync_namespace.py
- utils.py
- __init__.py
- doc_writer_sample.py
- doc_writer_sample_output.py
- hydra_doc_sample.py
- link_open_api.yaml
- petstore_openapi.yaml
- __init__.py
- app.py
- app_factory.py
- auth.py
- conf.py
- LogConfig
- resources.py
- utils.py
- uwsgi.ini
- test_app.py
- test_auth.py
- test_socket.py
- test_crud.py
- __init__.py
- conftest.py
- test_cli.py
- test_pep8.py
- .deepsource.toml
- .gitignore
- .pre-commit-config.yaml
- .travis.yml
- cli.py
- config.yml
- docker-compose.yml
- Dockerfile
- LICENSE
- poetry.lock
- pylintrc
- pyproject.toml
- README.md
- requirements-dev.txt
- requirements.txt
- setup.cfg
- setup.py
# Installation Guide
1. Get the code
git clone https://github.com/HTTP-APIs/hydrus
Downloads the entire project code from GitHub to your computer.
cd hydrus
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip3 install poetry
Installs the package published on PyPI directly โ no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Python
EasyPrerequisites
pip install -r requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
pip3 install poetry
Installs the package published on PyPI directly โ no need to clone the source.
poetry install
Installs the libraries listed in pyproject.toml.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)