{"id":27972687,"url":"https://github.com/cemsbv/py-cptcore","last_synced_at":"2025-05-07T23:13:38.770Z","repository":{"id":235722154,"uuid":"710660582","full_name":"cemsbv/py-cptcore","owner":"cemsbv","description":"Public python SDK for the CEMS CPTCore web-API","archived":false,"fork":false,"pushed_at":"2025-05-07T19:50:16.000Z","size":5704,"stargazers_count":3,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T23:13:32.995Z","etag":null,"topics":["gef","python","sdk-python"],"latest_commit_sha":null,"homepage":"https://cemsbv.github.io/py-cptcore/","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/cemsbv.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null}},"created_at":"2023-10-27T07:02:52.000Z","updated_at":"2025-04-25T10:30:30.000Z","dependencies_parsed_at":"2025-05-02T13:22:16.222Z","dependency_job_id":"eafffcfa-bfce-442b-8994-c68b412fe571","html_url":"https://github.com/cemsbv/py-cptcore","commit_stats":null,"previous_names":["cemsbv/py-cptcore"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cemsbv%2Fpy-cptcore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cemsbv%2Fpy-cptcore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cemsbv%2Fpy-cptcore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cemsbv%2Fpy-cptcore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cemsbv","download_url":"https://codeload.github.com/cemsbv/py-cptcore/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252968121,"owners_count":21833252,"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":["gef","python","sdk-python"],"created_at":"2025-05-07T23:13:38.336Z","updated_at":"2025-05-07T23:13:38.762Z","avatar_url":"https://github.com/cemsbv.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# py-cptcore\nPublic python SDK for the CEMS CPTCore web-API\n\n[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat\u0026labelColor=ef8336)](https://pycqa.github.io/isort/)\n\n\nThis repository is created by [CEMS BV](https://cemsbv.nl/) and is a public python wrapper around the CEMS [CPTCore web-API](https://nuclei.cemsbv.io/#/cptcore/api).\n\n# Installation\n\nTo install a package in this repository run:\n\n`$ pip install py-cptcore`\n\n\n## ENV VARS\n\nTo use `py-cptcore` add the follow ENV vars to your environment. Or provide them when asked.\n\n```\n* NUCLEI_TOKEN\n    - Your NUCLEI user token\n```\n\nYou can obtain your `NUCLEI_TOKEN` on [NUCLEI](https://nuclei.cemsbv.io/#/). \nGo to `personal-access-tokens` and create a new user token.\n\n# Contribution\n\n## Environment\n\nWe recommend developing in Python3.9 with a clean virtual environment (using `virtualenv` or `conda`), installing the requirements from the requirements.txt file:\n\nExample using `virtualenv` and `pip` to install the dependencies in a new environment .env on Linux:\n\n```bash\npython -m venv .env\nsource .env/bin/activate\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install -e .\n```\n\n## Documentation\n\nBuild the docs:\n\n```bash\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install .\n\nsphinx-build -b html docs public\n```\n\n## Format\n\nWe format our code with black and isort.\n\n```bash\nblack --config \"pyproject.toml\" src/pycptcore tests \nisort --settings-path \"pyproject.toml\" src/pycptcore tests\n```\n\n## Lint\n\nTo maintain code quality we use the GitHub super-linter.\n\nTo run the linters locally, run the `run_super_linters.sh` bash script from the root directory.\n\n## UnitTest\n\nTest the software with the use of coverage:\n\n```bash\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install -e .\ncoverage run -m pytest\n```\n\n## Requirements\n\nRequirements are autogenerated by the `pip-compile` command with python 3.9\n\nInstall pip-tools with:\n\n```bash\npip install pip-tools\n```\n\nGenerate requirements.txt file with:\n\n```bash\npip-compile --extra=test --extra=lint --extra=docs --output-file=requirements.txt pyproject.toml\n```\n\nUpdate the requirements within the defined ranges with:\n\n```bash\npip-compile --upgrade --extra=test --extra=lint --extra=docs --output-file=requirements.txt pyproject.toml\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcemsbv%2Fpy-cptcore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcemsbv%2Fpy-cptcore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcemsbv%2Fpy-cptcore/lists"}