{"id":23161060,"url":"https://github.com/biocpy/biocsetup","last_synced_at":"2025-05-12T12:44:32.252Z","repository":{"id":267516375,"uuid":"901492882","full_name":"BiocPy/BiocSetup","owner":"BiocPy","description":"Quickly setup new BiocPy packages","archived":false,"fork":false,"pushed_at":"2025-02-03T16:31:52.000Z","size":200,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-03T17:33:06.935Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://biocpy.github.io/BiocSetup/","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/BiocPy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-10T18:58:38.000Z","updated_at":"2025-01-16T20:20:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"b1be181e-8222-43b7-bc2d-3dd77699ec2c","html_url":"https://github.com/BiocPy/BiocSetup","commit_stats":null,"previous_names":["biocpy/biocsetup"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BiocPy%2FBiocSetup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BiocPy%2FBiocSetup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BiocPy%2FBiocSetup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BiocPy%2FBiocSetup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BiocPy","download_url":"https://codeload.github.com/BiocPy/BiocSetup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238058551,"owners_count":19409599,"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-17T23:13:09.429Z","updated_at":"2025-05-12T12:44:32.246Z","avatar_url":"https://github.com/BiocPy.png","language":"Python","readme":"[![PyPI-Server](https://img.shields.io/pypi/v/biocsetup.svg)](https://pypi.org/project/biocsetup/)\n![Unit tests](https://github.com/BiocPy/BiocSetup/actions/workflows/run-tests.yml/badge.svg)\n[![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)\n\n# BiocSetup\n\nBiocSetup helps scaffold new Python packages in [BiocPy](https://github.com/biocpy) with consistent configuration for package management.\n\nIt automates the setup process by using PyScaffold with additional configurations specific to BiocPy projects, including documentation setup, GitHub Actions for testing and publishing, and code quality tools.\n\nFor more details, see our [developer guide](https://github.com/BiocPy/developer_guide).\n\n## Installation\n\n```bash\npip install biocsetup\n```\n\n## Usage\n\n### Command Line Interface\n\nCreate a new package using the command line:\n\n```bash\nbiocsetup my-new-package --description \"Description of my package\" --license MIT\n```\n\nOptions:\n\n- `--description`, `-d`: Project description\n- `--license`, `-l`: License to use (default: MIT)\n- `--rst`: To use reStructuredText, otherwise uses Markdown by default.\n\n### Python API\n\nYou can also create packages programmatically:\n\n```python\nfrom biocsetup import create_repository\n\ncreate_repository(\n    project_path=\"my-new-package\",\n    description=\"Description of my package\",\n    license=\"MIT\",\n    rst=False,\n)\n```\n\n## After setup\n\n- The GitHub workflows use \"trusted publisher workflow\" to publish packages to PyPI. Read more instructions [here](https://docs.pypi.org/trusted-publishers/).\n  - Tagging the repository will trigger an action to test, generate documentation, and publish the package to PyPI.\n- Install [tox](https://tox.wiki/en/4.23.2/) to handle package tasks. GitHub Actions relies on the tox configuration to test, generate documentation, and publish packages.\n- (Optional) Enable the [pre-commit.ci](https://pre-commit.ci/) bot for your repository.\n- (Optional) Install [ruff](https://docs.astral.sh/ruff/) for code formatting.\n- (Optional) Setup [codecov](https://about.codecov.io/) for coverage reports.\n\n\u003c!-- pyscaffold-notes --\u003e\n\n## Note\n\nThis project has been set up using PyScaffold 4.6. For details and usage\ninformation on PyScaffold see https://pyscaffold.org/.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiocpy%2Fbiocsetup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbiocpy%2Fbiocsetup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiocpy%2Fbiocsetup/lists"}