{"id":20872502,"url":"https://github.com/romnn/kaggle-brane","last_synced_at":"2026-05-12T12:41:51.671Z","repository":{"id":110742561,"uuid":"370066583","full_name":"romnn/kaggle-brane","owner":"romnn","description":"package for simple interaction with the Kaggle API for brane data pipelines.","archived":false,"fork":false,"pushed_at":"2021-06-03T11:57:31.000Z","size":63,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T16:02:48.691Z","etag":null,"topics":["api","brane","cicd","competitions","data-pipeline","datasets","kaggle","package","wrapper"],"latest_commit_sha":null,"homepage":"","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/romnn.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":"2021-05-23T13:55:21.000Z","updated_at":"2021-06-03T19:34:41.000Z","dependencies_parsed_at":"2024-03-08T17:47:26.754Z","dependency_job_id":null,"html_url":"https://github.com/romnn/kaggle-brane","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fkaggle-brane","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fkaggle-brane/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fkaggle-brane/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fkaggle-brane/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/romnn","download_url":"https://codeload.github.com/romnn/kaggle-brane/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fkaggle-brane/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259155924,"owners_count":22813911,"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":["api","brane","cicd","competitions","data-pipeline","datasets","kaggle","package","wrapper"],"created_at":"2024-11-18T06:19:08.854Z","updated_at":"2026-05-12T12:41:51.620Z","avatar_url":"https://github.com/romnn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Kaggle for brane\n\nThis [brane](https://github.com/onnovalkering/brane) package provides wrappers for the [Kaggle](https://www.kaggle.com/) API for easy interaction when working with data pipelines and machine learning models in `brane`.\n\n#### Prerequisites\n\nIn order to use the Kaggle’s public API, you must **authenticate using an API token**.\nFrom the site header, click on your user profile picture, then on “My Account” from the dropdown menu.\nThis will take you to your account settings at https://www.kaggle.com/account.\nScroll down to the section of the page labelled API.\nTo create a new token, click on the **“Create New API Token”** button. This will download a fresh authentication token onto your machine.\n\nFurthermore, if you attempt to interact with a specific competition (e.g. download it or submit), you **must enter the challenge and accept the rules via the kaggle website** with the same account you use with the API first!\n\n#### Usage\n\nFirst, import the brain package from this repository:\n```bash\nbrane import romnn/kaggle-brane\n```\n\nYou also need to push the package to be able to import it in your remote session or jupyterlab notebook:\n```bash\nbrane push kaggle 1.0.0\n```\n\nSubsequently, the `kaggle` package can be imported in your `brane` scripts to interact with kaggle.\nYou can try it out with the `brane --debug repl` as well:\n```python\nimport kaggle;\nlet test := download_competition(\"comp-name\", \"./data\", \"kaggle_username\", \"kaggle_key\", false, true);\n```\n\n#### Documentation\n\nAt the moment, only `download_competition` is considered production ready, but more API calls have been implemented to cover the full Kaggle API for an easy integration with your `brane` projects.\n\nThe easiest way to learn about the available functions, parameters and return types, is to explore the package with\n```bash\nbrane --debug test kaggle\n```\nafter you imported it.\n\nThis will give you a list of all the available functions and show you the parameters in the order they are expected. When you supply valid credentials and the desired parameters  you will be able so see the output of the function.\n\n#### Local development\n\nIt is recommended to develop locally by using environment variables and the `run.py` python script. This will use the Kaggle API with your local kaggle credentials at `~/.kaggle/kaggle.json` if available \n\n```bash\nCOMPETITION=web-traffic-time-series-forecasting DESTINATION=. ./run.py competitions download\n```\n\n#### Build the brane package\n\nAfter local development, you can build and push the `brane` package with the included `Makefile` command:\n```bash\nmake build\n\n# check that the package was updated and test it\nbrane list\nbrane --debug test kaggle\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromnn%2Fkaggle-brane","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromnn%2Fkaggle-brane","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromnn%2Fkaggle-brane/lists"}