{"id":20841226,"url":"https://github.com/iotexproject/iotex-config-service","last_synced_at":"2026-04-25T19:31:47.640Z","repository":{"id":207244616,"uuid":"596951173","full_name":"iotexproject/iotex-config-service","owner":"iotexproject","description":"The safe-config-service is a service that provides configuration information in the context of the Safe clients environment.","archived":false,"fork":false,"pushed_at":"2024-08-30T01:25:17.000Z","size":875,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-12T10:22:46.836Z","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/iotexproject.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-03T09:41:17.000Z","updated_at":"2024-08-28T13:20:17.000Z","dependencies_parsed_at":"2024-08-28T14:54:38.251Z","dependency_job_id":null,"html_url":"https://github.com/iotexproject/iotex-config-service","commit_stats":null,"previous_names":["protofire/iotex-config-service","iotexproject/iotex-config-service"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/iotexproject/iotex-config-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-config-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-config-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-config-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-config-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iotexproject","download_url":"https://codeload.github.com/iotexproject/iotex-config-service/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-config-service/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32274982,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-25T18:29:39.964Z","status":"ssl_error","status_checked_at":"2026-04-25T18:29:32.149Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-11-18T01:19:20.658Z","updated_at":"2026-04-25T19:31:47.624Z","avatar_url":"https://github.com/iotexproject.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# safe-config-service\n\n[![Coverage Status](https://coveralls.io/repos/github/gnosis/safe-config-service/badge.svg)](https://coveralls.io/github/gnosis/safe-config-service)\n\nThe `safe-config-service` is a service that provides configuration information in the context of the Safe clients environment (eg.: list of available safe apps and chain metadata).\n\n## Requirements\n\n- `docker-compose` – https://docs.docker.com/compose/install/\n- Python 3\n\n## Setup\n\nIn order to start the server application:\n\n#### 1. Install the required Python dependencies. Eg.: With a python virtual environment:\n\n```shell\npython -m venv venv # creates a virtual environment venv in the local directory\nsource venv/bin/activate\npip install -r requirements-dev.txt\n```\n\n#### 2. Launch the Postgres database image\n\n```shell\ndocker compose up -d db\n```\n\n#### 3. Execute pending database migrations\n\n```shell\npython src/manage.py migrate\n```\n\n#### 4. Create an admin user\n\nThe admin interface of the service will be available under `http://localhost:8000/admin` but you need to have an admin registered before you are able to access the panel.\n\nTo create an admin user:\n\n```shell\npython src/manage.py createsuperuser\n```\n\n#### 5. Launch the service:\n\n```shell\npython src/manage.py runserver\n```\n\nBy default the service will be available under http://127.0.0.1:8000/\n\n## Configuration\n\nThe service is already configured for development purposes however if you wish to deploy it in a production environment you should set some sensitive parameters such as: `POSTGRES_USER`\n, `POSTGRES_PASSWORD`, `SECRET_KEY`.\n`DEBUG` should be set to `false`.\n\nWe provide the `.dev.env` file which explains the role of each environment variable. You can set the configuration using this file and read it in terminal session where the application will be\nexecuted.\n\n## Testing\n\nPytest is used to run the available tests in the project. **Some of these tests validate the integration with the database\nso having one running is required**. From the project root:\n\n```shell\ndocker compose up -d db\npytest src\n```\n\n## Code Style Formatter and Linter\n\n[Black](https://black.readthedocs.io/en/stable/), [Flake8](https://flake8.pycqa.org/en/latest/) and [isort](https://pycqa.github.io/isort/) are the tools used to validate the style of the changes\nbeing pushed. You can refer to the documentation\nof these tools to check how to integrate them with your editor/IDE.\n\n```shell\nisort --profile black src # sorts imports according to the isort spec with a profile compatible with Black\nblack src # formats the files in the src folder using Black\nflake8 src # runs flake8 Linter in the src folder\n```\n\nThere's also a pre-commit hook that you can install locally via `pre-commit` so that it formats the files changed on each commit automatically:\n\n```shell\npre-commit install # installs commit hook under .git/hooks/pre-commit\ngit commit # Initially this can take a couple minutes to setup the environment (which will be reused in following commits)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiotexproject%2Fiotex-config-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiotexproject%2Fiotex-config-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiotexproject%2Fiotex-config-service/lists"}