{"id":23053136,"url":"https://github.com/fairdataihub/cwl-validator-api","last_synced_at":"2025-04-03T04:23:22.017Z","repository":{"id":251092892,"uuid":"836112524","full_name":"fairdataihub/cwl-validator-api","owner":"fairdataihub","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-14T18:33:05.000Z","size":279,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T14:59:01.645Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fairdataihub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-31T07:14:31.000Z","updated_at":"2024-11-14T18:33:08.000Z","dependencies_parsed_at":"2024-07-31T22:00:40.596Z","dependency_job_id":"5b652617-1229-479d-ad36-3967b887ee4e","html_url":"https://github.com/fairdataihub/cwl-validator-api","commit_stats":null,"previous_names":["megasanjay/cwl-validator-mvp","fairdataihub/cwl-validator-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcwl-validator-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcwl-validator-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcwl-validator-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcwl-validator-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fairdataihub","download_url":"https://codeload.github.com/fairdataihub/cwl-validator-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246934823,"owners_count":20857277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-16T00:16:40.203Z","updated_at":"2025-04-03T04:23:21.978Z","avatar_url":"https://github.com/fairdataihub.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"﻿# cwl-validator\n\n## Getting started\n\n### Prerequisites/Dependencies\n\nYou will need the following installed on your system:\n\n- Python 3.8+\n- [Pip](https://pip.pypa.io/en/stable/)\n- [Poetry](https://python-poetry.org/)\n- [Docker](https://www.docker.com/)\n\n### Setup\n\nIf you would like to update the api, please follow the instructions below.\n\n1. Create a local virtual environment and activate it:\n\n   ```bash\n   python -m venv .venv\n   source .venv/bin/activate\n   ```\n\n   If you are using Anaconda, you can create a virtual environment with:\n\n   ```bash\n   conda create -n cwl-validator-dev-env python=3.10\n   conda activate cwl-validator-dev-env\n   ```\n\n2. Install the dependencies for this package. We use [Poetry](https://python-poetry.org/) to manage the dependencies:\n\n   ```bash\n   pip install poetry==1.3.2\n   poetry install\n   ```\n\n   You can also use version 1.2.0 of Poetry, but you will need to run `poetry lock` after installing the dependencies.\n\n3. Add your environment variables. An example is provided at `.env.example`\n\n   ```bash\n   cp .env.example .env\n   ```\n\n   Make sure to update the values in `.env` to match your local setup.\n\n4. Add your modifications and run the tests:\n\n   ```bash\n   poetry run pytest\n   ```\n\n   If you need to add new python packages, you can use Poetry to add them:\n\n   ```bash\n    poetry add \u003cpackage-name\u003e\n   ```\n\n5. Format the code:\n\n   ```bash\n   poe format\n   ```\n\n6. Check the code quality:\n\n   ```bash\n   poe typecheck\n   poe lint\n   poe flake8\n   ```\n\n   You can also use `poe precommit` to run both formatting and linting.\n\n7. Run the tests and check the code coverage:\n\n   ```bash\n   poe test\n   poe test_with_capture # if you want to see console output\n   ```\n\n## Running\n\nFor developer mode:\n\n```bash\npoe dev\n```\n\nor\n\n```bash\nflask run --debug\n```\n\nFor production mode:\n\n```bash\npython3 app.py --host $HOST --port $PORT\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Fcwl-validator-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffairdataihub%2Fcwl-validator-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Fcwl-validator-api/lists"}