{"id":18382624,"url":"https://github.com/virtualbrainlab/pinpoint-api","last_synced_at":"2025-07-04T20:34:39.853Z","repository":{"id":255790820,"uuid":"853616823","full_name":"VirtualBrainLab/pinpoint-api","owner":"VirtualBrainLab","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-21T02:24:59.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-11T23:37:03.699Z","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/VirtualBrainLab.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-09-07T03:39:18.000Z","updated_at":"2024-09-21T02:25:02.000Z","dependencies_parsed_at":"2024-09-07T05:28:42.357Z","dependency_job_id":"6ec84cbb-696a-46f9-b7e5-3c5ecb2d1471","html_url":"https://github.com/VirtualBrainLab/pinpoint-api","commit_stats":null,"previous_names":["virtualbrainlab/pinpoint-api"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/VirtualBrainLab/pinpoint-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtualBrainLab%2Fpinpoint-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtualBrainLab%2Fpinpoint-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtualBrainLab%2Fpinpoint-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtualBrainLab%2Fpinpoint-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VirtualBrainLab","download_url":"https://codeload.github.com/VirtualBrainLab/pinpoint-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtualBrainLab%2Fpinpoint-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263615884,"owners_count":23489208,"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-11-06T01:07:07.563Z","updated_at":"2025-07-04T20:34:39.834Z","avatar_url":"https://github.com/VirtualBrainLab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pinpoint-api\n\n[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)\n![Code Style](https://img.shields.io/badge/code%20style-black-black)\n[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)\n![Interrogate](https://img.shields.io/badge/interrogate-100.0%25-brightgreen)\n![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?logo=codecov)\n![Python](https://img.shields.io/badge/python-\u003e=3.7-blue?logo=python)\n\n\n\n## Usage\n - To use this template, click the green `Use this template` button and `Create new repository`.\n - After github initially creates the new repository, please wait an extra minute for the initialization scripts to finish organizing the repo.\n - To enable the automatic semantic version increments: in the repository go to `Settings` and `Collaborators and teams`. Click the green `Add people` button. Add `svc-aindscicomp` as an admin. Modify the file in `.github/workflows/tag_and_publish.yml` and remove the if statement in line 65. The semantic version will now be incremented every time a code is committed into the main branch.\n - To publish to PyPI, enable semantic versioning and uncomment the publish block in `.github/workflows/tag_and_publish.yml`. The code will now be published to PyPI every time the code is committed into the main branch.\n - The `.github/workflows/test_and_lint.yml` file will run automated tests and style checks every time a Pull Request is opened. If the checks are undesired, the `test_and_lint.yml` can be deleted. The strictness of the code coverage level, etc., can be modified by altering the configurations in the `pyproject.toml` file and the `.flake8` file.\n\n## Installation\nTo use the software, in the root directory, run\n```bash\npip install -e .\n```\n\nTo develop the code, run\n```bash\npip install -e .[dev]\n```\n\n## Contributing\n\n### Linters and testing\n\nThere are several libraries used to run linters, check documentation, and run tests.\n\n- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:\n\n```bash\ncoverage run -m unittest discover \u0026\u0026 coverage report\n```\n\n- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:\n\n```bash\ninterrogate .\n```\n\n- Use **flake8** to check that code is up to standards (no unused imports, etc.):\n```bash\nflake8 .\n```\n\n- Use **black** to automatically format the code into PEP standards:\n```bash\nblack .\n```\n\n- Use **isort** to automatically sort import statements:\n```bash\nisort .\n```\n\n### Pull requests\n\nFor internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) style for commit messages. Roughly, they should follow the pattern:\n```text\n\u003ctype\u003e(\u003cscope\u003e): \u003cshort summary\u003e\n```\n\nwhere scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:\n\n- **build**: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)\n- **ci**: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)\n- **docs**: Documentation only changes\n- **feat**: A new feature\n- **fix**: A bugfix\n- **perf**: A code change that improves performance\n- **refactor**: A code change that neither fixes a bug nor adds a feature\n- **test**: Adding missing tests or correcting existing tests\n\n### Semantic Release\n\nThe table below, from [semantic release](https://github.com/semantic-release/semantic-release), shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):\n\n| Commit message                                                                                                                                                                                   | Release type                                                                                                    |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | ~~Patch~~ Fix Release, Default release                                                                          |\n| `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release                                                                                       |\n| `perf(pencil): remove graphiteWidth option`\u003cbr\u003e\u003cbr\u003e`BREAKING CHANGE: The graphiteWidth option has been removed.`\u003cbr\u003e`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release \u003cbr /\u003e (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |\n\n### Documentation\nTo generate the rst files source files for documentation, run\n```bash\nsphinx-apidoc -o doc_template/source/ src \n```\nThen to create the documentation HTML files, run\n```bash\nsphinx-build -b html doc_template/source/ doc_template/build/html\n```\nMore info on sphinx installation can be found [here](https://www.sphinx-doc.org/en/master/usage/installation.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirtualbrainlab%2Fpinpoint-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvirtualbrainlab%2Fpinpoint-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirtualbrainlab%2Fpinpoint-api/lists"}