{"id":18284198,"url":"https://github.com/blimpllc/blimp-python","last_synced_at":"2025-04-05T07:31:21.995Z","repository":{"id":57415632,"uuid":"7299497","full_name":"blimpllc/blimp-python","owner":"blimpllc","description":"Blimp API Python library ","archived":false,"fork":false,"pushed_at":"2019-10-22T23:34:17.000Z","size":9,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-19T19:19:30.445Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://dev.getblimp.com/","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/blimpllc.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}},"created_at":"2012-12-23T22:20:29.000Z","updated_at":"2021-12-26T00:06:02.000Z","dependencies_parsed_at":"2022-09-01T16:41:34.143Z","dependency_job_id":null,"html_url":"https://github.com/blimpllc/blimp-python","commit_stats":null,"previous_names":["blimpio/blimp-python","getblimp/blimp-python","blimpllc/blimp-python"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blimpllc","download_url":"https://codeload.github.com/blimpllc/blimp-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305463,"owners_count":20917197,"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-05T13:12:40.431Z","updated_at":"2025-04-05T07:31:16.989Z","avatar_url":"https://github.com/blimpllc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# blimp-python #\n\n[![Build Status](https://travis-ci.org/GetBlimp/blimp-python.png?branch=master)](https://travis-ci.org/GetBlimp/blimp-python)\n\nThis library allows you to interact with the Blimp API using Python. You can find more information \nabout Blimp's Public API documentation at [http://dev.getblimp.com/](http://dev.getblimp.com/).\nIf you have any problems or requests please contact [support](mailto:support@getblimp.com?subject=Blimp API Python library).\n\nInspired by Mike Lewis' [Python Foursquare v2 library](https://github.com/mLewisLogic/foursquare).\n\n## License ##\nLicensed under the MIT License.\n\n## Install ##\n\nUsing Github:\n\n```\ngit clone git@github.com:getblimp/blimp-python.git\n```\n\nUsing pip:\n\n```\npip install blimp\n```\n\nUsing easy_install:\n\n```\neasy_install blimp\n````\n\n## Pre-Usage ##\n\nBefore we begin using the library you need to signup to [Blimp](http://app.getblimp.com/) and generate a new API Key if you don't have one in your [settings](https://app.getblimp.com/user/settings/api/) as well as an Application ID and Secret in your [applications](https://app.getblimp.com/user/settings/api/developers/).\n\n## Usage ##\n\n```python\nimport blimp\n\napi = blimp.Client('username', 'api_key', 'app_id', 'app_secret')\n\n# get all companies that I'm part of\ncompanies = api.company()\n\n# get one company by id\ncompany = api.company(1)\n\n# get all projects for one company\nprojects = api.project(params={'company': 1})\n\n# get count of total projects\ntotal_projects = projects['meta']['total_count']\n\n# Loop through all projects and print their name\nfor project in projects['objects']:\n    print project['name']\n\n# Get all goals for a project\ngoals = api.goal(params={'project': 1})\n\n# Get all tasks for a goal\ntasks = api.task(params={'goal': 1})\n\n# Get all comments for a task\ncomments = api.comment(params={'content_type': 'todo', 'object_pk': 1})\n\n# Get schema for all available endpoints\nprint api.company.schema()\nprint api.project.schema()\nprint api.goal.schema()\nprint api.task.schema()\nprint api.comment.schema()\nprint api.file.schema()\n\n# All available methods per endpoint\n# api.task.get()\n# api.task.get(task_id)\n# api.task.create(data)\n# api.task.update(task_id, data)\n# api.task.delete(task_id)\n# api.task.schema()\n```\n### Example response of all companies I'm part of ###\n```JSON\n{\n    \"meta\": {\n        \"limit\": 20,\n        \"next\": null,\n        \"offset\": 0,\n        \"previous\": null,\n        \"total_count\": 1\n    },\n    \"objects\": [\n        {\n            \"company_users\": [\n                {\n                    \"accepted_invitation\": true,\n                    \"date_created\": \"2012-11-01T00:00:00\",\n                    \"date_modified\": \"2012-11-27T02:22:09.817265\",\n                    \"id\": 38,\n                    \"is_active\": true,\n                    \"role\": \"admin\",\n                    \"user\": \"/api/v2/user/3/\"\n                },\n                {\n                    \"accepted_invitation\": true,\n                    \"date_created\": \"2012-11-01T00:00:00\",\n                    \"date_modified\": \"2012-11-27T02:22:09.705959\",\n                    \"id\": 37,\n                    \"is_active\": true,\n                    \"role\": \"admin\",\n                    \"user\": \"/api/v2/user/2/\"\n                },\n                {\n                    \"accepted_invitation\": true,\n                    \"date_created\": \"2012-11-01T00:00:00\",\n                    \"date_modified\": \"2012-11-27T02:22:09.380851\",\n                    \"id\": 39,\n                    \"is_active\": true,\n                    \"role\": \"owner\",\n                    \"user\": \"/api/v2/user/1/\"\n                }\n            ],\n            \"date_created\": \"2012-11-01T00:00:00\",\n            \"date_modified\": \"2012-12-21T21:57:09.965247\",\n            \"id\": 1,\n            \"image_url\": \"\",\n            \"name\": \"Blimp\",\n            \"resource_uri\": \"/api/v2/company/1/\",\n            \"slug\": \"blimp\",\n            \"used_projects\": 0,\n            \"used_storage\": \"4929882\"\n        }\n    ]\n}\n```\n\n## Improvements\nWhat else would you like this library to do? Let me know. Feel free to send pull requests for any improvements you make.\n\n### Todo\n* Tests\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimpllc%2Fblimp-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblimpllc%2Fblimp-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimpllc%2Fblimp-python/lists"}